Installation

Install the eslint-plugin-command package:

npm i eslint-plugin-command -D

In your flat config eslint.config.mjs:

// eslint.config.mjs
import command from 'eslint-plugin-command/config'

export default [
  // ... your other flat config
  command(),
]

Legacy Config

While no longer supported, you may still use the legacy .eslintrc.js file:

// .eslintrc.js
module.exports = {
  plugins: [
    'command'
  ],
  rules: {
    'command/command': 'error',
  },
}

Custom Commands

It's also possible to define your custom commands.

// eslint.config.mjs
import { builtinCommands, defineCommand } from 'eslint-plugin-command/commands'
import command from 'eslint-plugin-command/config'

const myCommand = defineCommand({
  name: 'my-command',
  // RegExp to match the command comment (without leading `//`)
  match: /^@my-command$/,
  action(context) {
    // Do something with the context
  },
})

export default [
  // ... your other flat config
  command({
    commands: [
      ...builtinCommands,
      myCommand,
    ]
  }),
]

You can refer to the built-in commands as examples.