Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moxio/captainhook-eslint
Captain Hook Plugin to validate files using ESLint
https://github.com/moxio/captainhook-eslint
captainhook eslint git git-hooks
Last synced: 3 days ago
JSON representation
Captain Hook Plugin to validate files using ESLint
- Host: GitHub
- URL: https://github.com/moxio/captainhook-eslint
- Owner: Moxio
- License: mit
- Created: 2019-10-25T13:55:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-18T14:52:50.000Z (almost 4 years ago)
- Last Synced: 2024-12-20T16:58:07.961Z (6 days ago)
- Topics: captainhook, eslint, git, git-hooks
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 10
- Watchers: 12
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/moxio/captainhook-eslint)
moxio/captainhook-eslint
========================
This project is a plugin for [CaptainHook](https://github.com/captainhookphp/captainhook) to check JavaScript files
using [ESLint](https://eslint.org/) in a git pre-commit hook. By default all `*.js` and `*.mjs` files are checked, and
the commit is blocked when one or more errors are found. Warnings produced by ESLint are ignored.
Installation
------------
Install as a development dependency using composer:
```
$ composer require --dev moxio/captainhook-eslint
```
Usage
-----
Add ESLint validation as a `pre-commit` to your `captainhook.json` configuration file:
```json
{
"pre-commit": {
"enabled": true,
"actions": [
{
"action": "\\Moxio\\CaptainHook\\ESLint\\ESLintAction"
}
]
}
}
```
The action expects [ESLint](https://eslint.org/) to be installed as a local NPM package (i.e. available at
`node_modules/.bin/eslint`). It should be [configured](https://eslint.org/docs/user-guide/configuring#configuring-eslint)
in a way that automatically finds the appropriate configuration, e.g. as an `.eslintrc.*` file or with the `eslintConfig`
field in `package.json`.
### Conditional usage
If you want to perform ESLint validation only when ESLint is installed (i.e. available at `node_modules/.bin/eslint`),
you can add a corresponding condition to the action:
```json
{
"pre-commit": {
"enabled": true,
"actions": [
{
"action": "\\Moxio\\CaptainHook\\ESLint\\ESLintAction",
"conditions": [
{
"exec": "\\Moxio\\CaptainHook\\ESLint\\Condition\\ESLintInstalled"
}
]
}
]
}
}
```
This may be useful in scenarios where you have a shared CaptainHook configuration file that is
[included](https://captainhookphp.github.io/captainhook/configure.html#includes) both in projects that use ESLint and
projects that don't. If ESLint is installed, the action is run. In projects without ESLint, the validation is skipped.
### Configuring checked file extensions
By default, committed files with a `.js` or `.mjs` extension will be checked. If you want to customize this,
e.g. to also validate TypeScript files, you can do so with the `extensions` option, which accepts an array
with extensions of files to lint:
```json
{
"pre-commit": {
"enabled": true,
"actions": [
{
"action": "\\Moxio\\CaptainHook\\ESLint\\ESLintAction",
"options": {
"extensions": [ "js", "mjs", "ts", "tsx" ]
}
}
]
}
}
```
Versioning
----------
This project adheres to [Semantic Versioning](http://semver.org/).
License
-------
This project is released under the MIT license.