eps1lon / eslint-focus

Allows running ESLint with a single rule on a given directory.

eslint-focus

Allows running ESLint on a directory with a single rule or set of rules matching a pattern. The matched rules MUST be enabled in your ESLint config for the files you want it to run on (e.g. enable it in your root .eslintrc.js).

Usage

npx eslint-focus <ruleOrRulePattern> <relativeOrAbsolutePaths..>

Run ESLint with a single rule or rules matching a pattern on a given directory.

Positionals:
  ruleOrRulePattern        A single rule or pattern                                                             [string]
  relativeOrAbsolutePaths  An absolute path or a path relative to the current working directory.                [string]

Options:
  --version            Show version number                                                                     [boolean]
  --help               Show help                                                                               [boolean]
  --allowInlineConfig  Respects eslint-disable directives.                                    [boolean] [default: false]
  --diff               Only includes file that are also part of git-diff. See git-diff docs for possible values.[string]
  --fix                Same as `eslint --fix`: https://eslint.org/docs/latest/use/command-line-interface#--fix
                                                                                              [boolean] [default: false]
  --fix-type           Same as `eslint --fix-type`
                       (https://eslint.org/docs/latest/use/command-line-interface#--fix-type) with an additional
                       'add-disable-directive' option to ignore the violation instead with an `eslint-disable-next-line`
                       directive. 'add-disable-directive' only adds `//` comments i.e. it will likely produce syntax
                       errors if lint violations are found inside JSX.
                             [array] [choices: "problem", "suggestion", "layout", "add-disable-directive"] [default: []]

Examples:
  npx eslint-focus react-hooks/rules-of-hooks .                 Run `react-hooks/rules-of-hooks` on every file inside
                                                                the current directory.
  npx $1 /jest\// .                                             Run all Jest rules on every file inside the current
                                                                directory.
  npx eslint-focus react-hooks/exhaustive-deps . --fix          Fixes all `react-hooks/exhaustive-deps` issues inside
  --fix-type suggestion                                         the current directory.
  npx eslint-focus import/order packages/features/pf-*          (Relies on Bash globbing) Run `import/order` on every
                                                                folder matching 'packages/features/pf-*'.
  npx eslint-focus import/order packages/core packages/traits   (Relies on Bash globbing) Run `import/order` on every
                                                                file inside 'packages/core' OR 'packages/traits'.
  npx eslint-focus import/order packages/core                   Adds eslint-disable-next-line directives to ignore all
  --allowInlineConfig --fix --fix-type add-disable-directive    `import/order` violations inside 'packages/core'.

$ npx eslint-focus react/no-unstable-nested-components .
/Users/sebastian.silbermann/repo/BottomSheet.native.tsx:106:29
/Users/sebastian.silbermann/repo/BottomSheet.native.tsx:145:15
/Users/sebastian.silbermann/repo/CardExpirationWarning.tsx:51:23
┌──────────────────────┬────────┐
│       (index)        │ Values │
├──────────────────────┼────────┤
│   Considered files   │ 71671  │
│    Checked rules     │ 71671  │
│    Skipped files     │  181   │
│ Files failed to lint │   1    │
│  Files with issues   │  216   │
│        Issues        │  308   │
└──────────────────────┴────────┘
Done in 386.08s.

Missing

Configure extensions. By default it runs on everything that's TypeScript or JavaScript i.e. /\.(cjs|cts|js|jsx|mjs|mts|ts|tsx)$/.

Why?

• eslint-nibbler is slow
• ESLint formatters still executes every rule
• ESLint --no-eslintrc means I have to know the parser options up front
• ESLint has no built-in support to stream results

eslint-focus's Issues

Add support for applying fixes/suggestions

Report unused disable directives

Would be nice to allow flagging (now) unused disable directives. We can't just use reportUnusedDisableDirectives because that would report directives that aren't used because the lint doesn't focus on this rule. For example, rule B is disabled with directives but we only eslint-focus on A. The disable directive for B is now considered unused even though it may be used if we don't use eslint-focus.

Allow inline configs

eslint-focus/bin/eslint-focus.js

Line 89 in f697bb8

allowInlineConfig: false,

I didn't understand this option but it basically makes it so that eslint-disable directives are ignored. That's not why I want right now. But it might make sense to expose as a CLI arg.

Run a rule on a glob

When using a glob instead of a path, the glob gets unfurled but eslint-focus errors:

npx eslint-focus @klapp-tooling/fixtures-assets/no-cdn-assets ./packages/features/pf-*

Unknown arguments: ./packages/features/pf-categories, ./packages/features/pf-connect, ./packages/features/pf-financial-stories, ./packages/features/pf-monthly-cycle, ./packages/features/pf-notification-settings, ./packages/features/pf-playground, ./packages/features/pf-spending-breakdown

Not a necessity, but it would be nice :) I'd be happy to contribute if that's something you'd prefer :)