serenity/.pre-commit-config.yaml

repos:
  - repo: local
    hooks:
      - id: meta-lint-ci
        name: Running Meta/lint-ci.sh to ensure changes will pass linting on CI
        entry: bash Meta/lint-ci.sh
        args: [ --no-ports ]
        language: system

      - id: meta-lint-ports
        name: Running Meta/lint-ports.py to ensure changes will pass linting on CI
        entry: Meta/lint-ports.py
        pass_filenames: false
        files: ^Ports/
        language: system
Meta: Add .pre-commit-config.yaml This pre-commit config is quite simple: all it does for now is running the already existing Meta/lint-ci.sh script to ensure no changes that won't pass the CI linting step are committed. Consequently pass_filenames is set to false, as these scripts will determine which files to check themselves - should this ever become a performance bottleneck, we can update them to accept an optional list of filenames. It should be noted that using pre-commit for Serenity development is by no means a requirement, but doing so may decrease the number of CI builds failing due to forgotten license headers etc. - especially if you're pushing to `master` directly, rather than going through pull requests hint hint. For info how to install & use pre-commit, see https://pre-commit.com/. Fixes #2365. 2020-12-09 18:01:06 +00:00			`repos:`
			`- repo: local`
			`hooks:`
			`- id: meta-lint-ci`
			`name: Running Meta/lint-ci.sh to ensure changes will pass linting on CI`
			`entry: bash Meta/lint-ci.sh`
Meta: pre-commit should run lint-ports.py only when Ports change Most of the existing lint-ing shell scripts have the ability to only run on the files which have actually changed. The new port lint-ing script doesn't have this functionality unfortunately. This forces us to lint ALL the ports on every single change to any other file in the system if you have the pre-commit hook setup for your git clone locally. Instead we can use pre-commit's feature to only run a hook if certain files have changed to reduce the situations in which we would run the Meta/lint-ports.py script. 2021-04-30 11:30:04 +00:00			`args: [ --no-ports ]`
			`language: system`

			`- id: meta-lint-ports`
			`name: Running Meta/lint-ports.py to ensure changes will pass linting on CI`
			`entry: Meta/lint-ports.py`
			`pass_filenames: false`
			`files: ^Ports/`
Meta: Add .pre-commit-config.yaml This pre-commit config is quite simple: all it does for now is running the already existing Meta/lint-ci.sh script to ensure no changes that won't pass the CI linting step are committed. Consequently pass_filenames is set to false, as these scripts will determine which files to check themselves - should this ever become a performance bottleneck, we can update them to accept an optional list of filenames. It should be noted that using pre-commit for Serenity development is by no means a requirement, but doing so may decrease the number of CI builds failing due to forgotten license headers etc. - especially if you're pushing to `master` directly, rather than going through pull requests hint hint. For info how to install & use pre-commit, see https://pre-commit.com/. Fixes #2365. 2020-12-09 18:01:06 +00:00			`language: system`