Frontend Tools¶

GitHooks can run non-PHP tools using the custom job type. This lets you manage backend and frontend QA from a single configuration.

ESLint¶

'eslint_src' => [
    'type'           => 'custom',
    'executablePath' => 'npx eslint',
    'paths'          => ['resources/js'],
    'otherArguments' => '--fix',
    'accelerable'    => true,  // opt-in for --fast
],

With --fast, only staged JavaScript files within resources/js/ are analyzed.

Prettier¶

'prettier' => [
    'type'           => 'custom',
    'executablePath' => 'npx prettier',
    'paths'          => ['resources/js', 'resources/css'],
    'otherArguments' => '--check',
    'accelerable'    => true,
],

Stylelint¶

'stylelint' => [
    'type'           => 'custom',
    'executablePath' => 'npx stylelint',
    'paths'          => ['resources/css'],
    'otherArguments' => '--fix',
    'accelerable'    => true,
],

Simple mode for scripts¶

If you don't need path filtering or --fast acceleration, use the simple script mode:

'npm_build' => [
    'type'   => 'custom',
    'script' => 'npm run build',
],

Mixing PHP and frontend tools¶

'flows' => [
    'qa' => [
        'jobs' => ['phpcs_src', 'phpstan_src', 'eslint_src', 'prettier'],
    ],
],

'hooks' => [
    'pre-commit' => [
        ['flow' => 'qa', 'only-files' => ['**/*.php', '**/*.js', '**/*.css']],
    ],
],

See Custom Jobs for the full reference.