captainhook.json

{
  "commit-msg": {
    "enabled": true,
    "actions": [
      {
        "//": "Make sure that commit messages follow conventional commit rules.",
        "action": "\\Ramsey\\CaptainHook\\ValidateConventionalCommit",
        "options": {
          "config": {
            "typeCase": "lower",
            "types": [
              "build",
              "chore",
              "ci",
              "docs",
              "feat",
              "fix",
              "perf",
              "refactor",
              "revert",
              "style",
              "test"
            ],
            "scopeCase": "kebab",
            "scopeRequired": false,
            "scopes": [],
            "descriptionCase": "lower",
            "descriptionEndMark": "",
            "bodyRequired": false,
            "bodyWrapWidth": 72,
            "requiredFooters": []
          }
        }
      }
    ]
  },
  "pre-push": {
    "enabled": false,
    "actions": []
  },
  "pre-commit": {
    "enabled": true,
    "actions": [
      {
        "//": "Lint all CSS files in the project.",
        "conditions": [
          {
            "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
            "args": [["css"]]
          }
        ],
        "action": "npm run lint:css {$STAGED_FILES|of-type:css}"
      },
      {
        "//": "Lint all JS files in the project.",
        "conditions": [
          {
            "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
            "args": [["js"]]
          }
        ],
        "action": "npm run lint:js {$STAGED_FILES|of-type:js}"
      },
      {
        "//": "Lint all TS files in the project.",
        "conditions": [
          {
            "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
            "args": [["ts"]]
          }
        ],
        "action": "npm run lint:js {$STAGED_FILES|of-type:ts}"
      },
      {
        "//": "Lint and fix all staged PHP files.",
        "action": "vendor/bin/composer lint {$STAGED_FILES|of-type:php}"
      },
      {
        "//": "Run prettier on all staged files",
        "action": "npm run prettier:fix {$STAGED_FILES}"
      },
      {
        "//": "Add changed files back to the git stage.",
        "action": "git add {$STAGED_FILES}"
      },
      {
        "//": "Static Analysis of all PHP files in the project.",
        "action": "vendor/bin/composer analyse"
      }
    ]
  },
  "prepare-commit-msg": {
    "enabled": false,
    "actions": []
  },
  "post-commit": {
    "enabled": false,
    "actions": []
  },
  "post-merge": {
    "enabled": false,
    "actions": []
  },
  "post-checkout": {
    "enabled": false,
    "actions": []
  },
  "post-rewrite": {
    "enabled": false,
    "actions": []
  },
  "post-change": {
    "enabled": true,
    "actions": [
      {
        "action": "vendor/bin/composer install",
        "options": {},
        "conditions": [
          {
            "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any",
            "args": [["composer.json", "composer.lock"]]
          }
        ]
      },
      {
        "action": "npm install",
        "options": {},
        "conditions": [
          {
            "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any",
            "args": [["package.json", "package-lock.json"]]
          }
        ]
      }
    ]
  }
}