ng-lint-staged

ng-lint-staged

Inspired by: https://github.com/angular/angular-cli/issues/7612#issuecomment-455802617

The Angular lint builder provides a CLI option to lint certain files only instead of all project files. However, since lint-staged provides a regular list only, a tiny argument transformation is required.

This shim provides such a transformation.

Package versions

Lint builder	ng-lint-staged version
@angular-devkit/build-angular:tslint	^7.0.0
@angular-eslint/builder:lint	^12.0.0

The tslint builder has a --files CLI option whereas with the eslint builder it is named --lint-file-patterns. Find which lint builder your are using in the angular.json file.

Installation

npm install --save-dev ng-lint-staged

Usage

To setup and use ng-lint-staged with lint-staged, add something like the following to your package.json:

{
  "lint-staged": {
    "src/**/*.ts": ["ng-lint-staged lint --fix --"]
  }
}

Notes

• a trailing -- is required in the call to ng-lint-staged to inform it about the starting point of the files list.
• for lint-staged < v10.0.0, an additional gid add command may be required. See the lint-staged documentation for that version.
• This command assumes you have an npm script named lint in your package.json. If your npm lint script is a different name, use that instead.
  • It is important to note, this command should be as simplistic as possible ng lint your-project-name.
    • If you want a script that performs the --fix, it is recommended you make an entirely new script for that.

License

(The MIT License)

Copyright (c) 2019-2021 elunic AG/William Hefter [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.