goodcheck.yml sample for java project

goodcheck.yml

rules:
  - id: com.companyname.java.instanceof
    pattern: instanceof
    message: instanseofを使わなくて済むように設計しましょう。instanceofについての詳細は https://www.slideshare.net/HiroshiSaito1/deep-dive-into-instanceof を見てください
    glob:
      - "**/*.java"
    fail:
      - if("Hello, world!" instanceof String){}
    pass:
      - if("Hello, world".getClass().getCanonicalName() == "java.lang.String"){}
  - id: com.companyname.incident.20180101
    pattern: "@Transactional"
    message: トランザクションを使う際は十分に注意してください。トランザクションに関連して起きた障害のレポートは下記から閲覧出来ます。 https://developer.smartnews.com/blog/2018/07/incident_review/
    glob:
      - "**/*.java"
    fail:
      - "@Transactional"
    pass:
      - "Hello, world"
  - id: com.companyname.companyname
    pattern:
      - Companyname
      - "Compane name"
    message: CompanyNameが正しい社名・サービス名です。
    glob:
      - "**/*.java"
      - "**/*.xml"
      - "**/*.yml"
      - "**/*.jsp"
      - "**/*.js"
    fail:
      - "Comapney name"
      - "Companyname"
    pass:
      - "CompanyName"