moxio/captainhook-eslint

Captain Hook Plugin to validate files using ESLint

v1.0.0 2021-03-18 14:43 UTC

This package is auto-updated.

Last update: 2021-04-18 15:04:07 UTC


README

CI Latest Stable Version

moxio/captainhook-eslint

This project is a plugin for CaptainHook to check JavaScript files using ESLint 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:

{
    "pre-commit": {
        "enabled": true,
        "actions": [
            {
                "action": "\\Moxio\\CaptainHook\\ESLint\\ESLintAction"
            }
        ]
    }
}

The action expects ESLint to be installed as a local NPM package (i.e. available at node_modules/.bin/eslint). It should be configured 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:

{
    "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 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:

{
    "pre-commit": {
        "enabled": true,
        "actions": [
            {
                "action": "\\Moxio\\CaptainHook\\ESLint\\ESLintAction",
                "options": {
                    "extensions": [ "js", "mjs", "ts", "tsx" ]
                }
            }
        ]
    }
}

Versioning

This project adheres to Semantic Versioning.

License

This project is released under the MIT license.