eslint-config-isaacscript

Introduction

This is a sharable configuration for ESLint that is intended to be used in TypeScript projects.

The config is environment-agnostic, meaning that it will work in client-side projects (e.g. React), server-side projects (e.g. Node.js), and so on.

Installation

This package is part of the isaacscript-lint meta-linting package. It is recommended that instead of consuming this package directly, you instead list isaacscript-lint as a dependency, as that will install both this config and all of the rule plugins that it depends on.

For installation instructions, see the isaacscript-lint page.

Why Do I Need To Use ESLint?

Presumably, you are a TypeScript user who has used the language for a while. At this point, you have already realized that TypeScript saves you an enormous amount of time. The hours spent troubleshooting run-time errors from typos have become a thing of the past. Good riddance!

But there are many other code problems that do not have to do with types. In the same way that you want to use TypeScript to catch as many bugs as possible, you also want to use ESLint with a config that enables as many good linting rules as possible.

ESLint rules can help catch bugs, but they can also help to make your codebase more consistent and adhere to best-practices within the TypeScript ecosystem. Remember that code is read more often than it is written. If you care about your code being the best that it can possibly be, then using ESLint is a no-brainer!

Why Do I Need eslint-config-isaacscript?

Your codebase deserves to be safe as possible and eslint-config-isaacscript is the most comprehensive ESLint config out there.

Building an ESLint config from scratch takes many, many hours. ESLint has over 250 rules. typescript-eslint has over 125 rules. And that's just the beginning.

Don't bother creating and maintaining a huge ESLint config yourself. We've done the work to:

• Enable every ESLint rule that we can find from trusted sources that provides value.
• Weed out the rules that don't apply to TypeScript codebases (because many ESLint rules were written before TypeScript existed).
• Weed out the rules covered by Prettier (because many ESLint rules were written before Prettier existed).
• Weed out the rules that are too noisy to provide value (and document them below).

Our Config Philosophy

We want to enable as many lint rules as possible, so that we can catch as many bugs as possible. Of course, this is a tradeoff: with more lint rules, we get more false positives. But in general, a few false positives are worth the time saved from investigating and squashing bugs. (More on false positives later.)

In line with this philosophy, our linting config enables nearly all of the recommended rules from both the core ESLint team and the TypeScript ESLint team, as well as some additional rules that catch even more bugs.

This config also assumes that you are using Prettier to format your TypeScript code, which is considered to be best-practice in the ecosystem. Subsequently, all formatting-related rules that conflict with Prettier are disabled. (However, we use a few formatting-related rules that are not handled by Prettier.)

Auto-Fixing

Deploying this ESLint config on an existing codebase can generate a ton of warnings. Fixing them all might seem overwhelming. While some warnings need to be fixed manually, a ton of ESLint rules have "auto-fixers". This means that the code will fix itself if you run ESLint with the --fix flag. So, by running npx eslint --fix . in the root of your project, you can take care of a lot of the warnings automatically.

Additionally, we recommend that you configure your IDE (i.e. VSCode) to automatically run --fix whenever you save a file.

Dealing with False Positives

Your first reaction to having a bunch of yellow squiggly lines might be to disable any rule that gets in your way. However, even if you think an ESLint warning is superfluous, it is often a sign that your codebase is structured in a bug-prone or non-idiomatic way. Before simply disabling a rule, sometimes it is good to do some research and think carefully if your code can be refactored in some way to be cleaner.

Additionally, some ESLint rules are not about catching bugs, but are about code style and code consistency. If you find the new style to be foreign and weird, it can be tempting to ignore or disable the rule. But before you do that, consider the cost: your codebase will be deviating from others in the TypeScript ecosystem. It is really nice for everyone's code to adhere to the same look and the same standards!

With that said, with so many ESLint rules turned on, you will undoubtedly come across some false positives. You can quickly take care of these by adding a // eslint-disable-next-line insert-rule-name-here comment. And you can automatically add the comment by selecting "Quick Fix" in VSCode, which is mapped to Ctrl + . by default.

If you find yourself adding a lot of disable comments for a specific rule, then turn the rule off for the entire project by adding an entry for it in your .eslintrc.cjs file. Some rules won't make sense for every project and that's okay!

Rule List

Below, we provide documentation for every rule that is disabled. (We take a blacklist approach rather than a whitelist approach.)

Core ESLint Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
accessor-pairs	✅			base-eslint.js
array-bracket-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
array-bracket-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
array-callback-return	✅		The checkForEach option is enabled to make the rule stricter.	base-eslint.js
array-element-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
arrow-body-style	✅			base-eslint.js
arrow-parens	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
arrow-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
block-scoped-var	✅			base-eslint.js
block-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
brace-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
camelcase	❌		Superseded by the @typescript-eslint/naming-convention rule. (camelcase is used to enforce naming conventions.)	base-eslint.js
capitalized-comments	❌		Superseded by the isaacscript/complete-sentences-jsdoc and isaacscript/complete-sentences-line-comments rules.	base-eslint.js
class-methods-use-this	❌		Superseded by the @typescript-eslint/class-methods-use-this rule.	base-eslint.js
comma-dangle	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
comma-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
comma-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
complexity	❌		Disabled since cyclomatic complexity is not a good enough general indicator of code complexity and leads to too many false positives.	base-eslint.js
computed-property-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
consistent-return	❌		Superseded by the @typescript-eslint/consistent-return rule.	base-eslint.js
consistent-this	✅			base-eslint.js
constructor-super	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
curly	✅	eslint-config-prettier	Always requiring curly braces can partially ward against Apple-style if statement bugs. Additionally, this rule needs to be set to "all" to work properly with eslint-prettier-config.	base-eslint.js
default-case	❌		Disabled since it would cause the @typescript-eslint/switch-exhaustiveness-check rule to not work properly.	base-eslint.js
default-case-last	✅			base-eslint.js
default-param-last	❌		Superseded by the @typescript-eslint/default-param-last rule.	base-eslint.js
dot-location	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
dot-notation	❌	@typescript-eslint/stylistic-type-checked	Superseded by the @typescript-eslint/dot-notation rule.	base-eslint.js
eol-last	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
eqeqeq	❌		Superseded by the isaacscript/eqeqeq-fix rule.	base-eslint.js
for-direction	✅	eslint/recommended		base-eslint.js
func-call-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
func-name-matching	✅			base-eslint.js
func-names	✅			base-eslint.js
func-style	❌		Disabled since it is common in the TypeScript ecosystem to use both function forms, depending on the situation.	base-eslint.js
function-call-argument-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
function-paren-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
generator-star-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
getter-return	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
grouped-accessor-pairs	✅			base-eslint.js
guard-for-in	❌		Superseded by the isaacscript/no-for-in rule.	base-eslint.js
id-denylist	❌		Disabled since it is expected to be configured with project-specific keywords.	base-eslint.js
id-length	❌		Disabled because short variable names are understandable in many contexts.	base-eslint.js
id-match	❌		Superseded by the @typescript-eslint/naming-convention rule. (id-match is used to enforce naming conventions.)	base-eslint.js
implicit-arrow-linebreak	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
indent	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
init-declarations	❌		Superseded by the @typescript-eslint/init-declarations rule.	base-eslint.js
jsx-quotes	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
key-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
keyword-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
line-comment-position	❌		Disabled since it is common in the TypeScript ecosystem to use both types of comments.	base-eslint.js
linebreak-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
lines-around-comment	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
lines-between-class-members	❌		Superseded by the @typescript-eslint/lines-between-class-members rule.	base-eslint.js
logical-assignment-operators	✅		The enforceForIfStatements option is enabled to make the rule stricter.	base-eslint.js
max-classes-per-file	✅			base-eslint.js
max-depth	❌		Disabled since this rule is too prescriptive for general-purpose use.	base-eslint.js
max-len	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
max-lines	❌		Disabled because enforcing an arbitrary line threshold for every file in a project does not provide much value.	base-eslint.js
max-lines-per-function	❌		Disabled because enforcing an arbitrary line threshold for every function in a project does not provide much value.	base-eslint.js
max-nested-callbacks	✅			base-eslint.js
max-params	❌		Superseded by the @typescript-eslint/max-params rule.	base-eslint.js
max-statements	❌		Disabled because enforcing an arbitrary statement threshold for every function in a project does not provide much value.	base-eslint.js
max-statements-per-line	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
multiline-comment-style	❌		Disabled because it is conventional to use both kinds of comments in TypeScript projects.	base-eslint.js
multiline-ternary	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
new-cap	✅			base-eslint.js
new-parens	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
newline-per-chained-call	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-alert	✅			base-eslint.js
no-array-constructor	❌	@typescript-eslint/recommended	Superseded by the @typescript-eslint/no-array-constructor rule.	base-eslint.js
no-async-promise-executor	✅	eslint/recommended		base-eslint.js
no-await-in-loop	✅			base-eslint.js
no-bitwise	✅			base-eslint.js
no-caller	✅			base-eslint.js
no-case-declarations	✅	eslint/recommended		base-eslint.js
no-class-assign	✅	eslint/recommended		base-eslint.js
no-compare-neg-zero	✅	eslint/recommended		base-eslint.js
no-cond-assign	✅	eslint/recommended		base-eslint.js
no-confusing-arrow	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-console	❌		Disabled because command-line programs written in TypeScript commonly write to standard out and standard error.	base-eslint.js
no-const-assign	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-constant-binary-expression	✅			base-eslint.js
no-constant-condition	✅	eslint/recommended		base-eslint.js
no-constructor-return	✅			base-eslint.js
no-continue	❌		Disabled because proper use of continues can reduce indentation for long blocks of code in the same way as the early return pattern.	base-eslint.js
no-control-regex	✅	eslint/recommended		base-eslint.js
no-debugger	✅	eslint/recommended		base-eslint.js
no-delete-var	✅	eslint/recommended		base-eslint.js
no-div-regex	❌		Disabled since it is incompatible with the unicorn/better-regex rule.	base-eslint.js
no-dupe-args	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-dupe-class-members	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-dupe-else-if	✅	eslint/recommended		base-eslint.js
no-dupe-keys	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-duplicate-case	✅	eslint/recommended		base-eslint.js
no-duplicate-imports	❌		Superseded by the import/no-duplicates rule (which is provided by the import/recommended config).	base-eslint.js
no-else-return	✅		The allowElseIf option is disabled to make the rule stricter.	base-eslint.js
no-empty	✅	eslint/recommended		base-eslint.js
no-empty-character-class	✅	eslint/recommended		base-eslint.js
no-empty-function	❌	@typescript-eslint/stylistic	Superseded by the @typescript-eslint/no-empty-function rule.	base-eslint.js
no-empty-pattern	✅	eslint/recommended		base-eslint.js
no-empty-static-block	✅			base-eslint.js
no-eq-null	✅			base-eslint.js
no-eval	✅			base-eslint.js
no-ex-assign	✅	eslint/recommended		base-eslint.js
no-extend-native	✅			base-eslint.js
no-extra-bind	✅			base-eslint.js
no-extra-boolean-cast	✅	eslint/recommended		base-eslint.js
no-extra-label	✅			base-eslint.js
no-extra-parens	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-extra-semi	❌	eslint/recommended eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-fallthrough	✅	eslint/recommended		base-eslint.js
no-floating-decimal	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-func-assign	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-global-assign	✅	eslint/recommended		base-eslint.js
no-implicit-coercion	✅			base-eslint.js
no-implicit-globals	✅			base-eslint.js
no-implied-eval	❌	@typescript-eslint/recommended-type-checked	Superseded by the @typescript-eslint/no-implied-eval rule.	base-eslint.js
no-import-assign	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-inline-comments	❌		Disabled because inline comments are common in the TypeScript ecosystem.	base-eslint.js
no-inner-declarations	✅	eslint/recommended		base-eslint.js
no-invalid-regexp	✅	eslint/recommended		base-eslint.js
no-invalid-this	❌		Superseded by the @typescript-eslint/no-invalid-this rule.	base-eslint.js
no-irregular-whitespace	✅	eslint/recommended		base-eslint.js
no-iterator	✅			base-eslint.js
no-label-var	✅			base-eslint.js
no-labels	✅			base-eslint.js
no-lone-blocks	✅			base-eslint.js
no-lonely-if	✅			base-eslint.js
no-loop-func	❌		Superseded by the @typescript-eslint/no-loop-func rule.	base-eslint.js
no-loss-of-precision	❌	eslint/recommended @typescript-eslint/recommended	Superseded by the @typescript-eslint/no-loss-of-precision rule.	base-eslint.js
no-magic-numbers	❌		Superseded by the @typescript-eslint/no-magic-numbers rule.	base-eslint.js
no-misleading-character-class	✅	eslint/recommended		base-eslint.js
no-mixed-operators	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-mixed-spaces-and-tabs	❌	eslint/recommended eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-multi-assign	✅			base-eslint.js
no-multi-spaces	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-multi-str	✅			base-eslint.js
no-multiple-empty-lines	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-negated-condition	❌		Superseded by the unicorn/no-negated-condition rule.	base-eslint.js
no-nested-ternary	✅		unicorn/no-nested-ternary is a modified version of this rule but that version is less strict.	base-eslint.js
no-new	✅			base-eslint.js
no-new-func	✅			base-eslint.js
no-new-native-nonconstructor	✅			base-eslint.js
no-new-symbol	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-new-wrappers	✅			base-eslint.js
no-nonoctal-decimal-escape	✅	eslint/recommended		base-eslint.js
no-obj-calls	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-object-constructor	✅			base-eslint.js
no-octal	✅	eslint/recommended		base-eslint.js
no-octal-escape	✅			base-eslint.js
no-param-reassign	✅		The options are copied from Airbnb.	base-eslint.js
no-plusplus	❌		Disabled because the rule is unnecessary when using Prettier. (Unary operators can lead to errors with minified code, but Prettier adds semicolons automatically.)	base-eslint.js
no-promise-executor-return	✅			base-eslint.js
no-proto	✅			base-eslint.js
no-prototype-builtins	✅	eslint/recommended		base-eslint.js
no-redeclare	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-regex-spaces	✅	eslint/recommended		base-eslint.js
no-restricted-exports	✅		The options are copied from Airbnb.	base-eslint.js
no-restricted-globals	✅		The options are copied from Airbnb.	base-eslint.js
no-restricted-imports	❌		Superseded by the @typescript-eslint/no-restricted-imports rule.	base-eslint.js
no-restricted-properties	✅		The options are copied from Airbnb.	base-eslint.js
no-restricted-syntax	❌		Disabled because it is intended for disallowing specific language features per-project.	base-eslint.js
no-return-assign	✅		The always option is provided to make the rule stricter.	base-eslint.js
no-script-url	✅			base-eslint.js
no-self-assign	✅	eslint/recommended		base-eslint.js
no-self-compare	✅			base-eslint.js
no-sequences	❌		Disabled because it can conflict with Prettier.	base-eslint.js
no-setter-return	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-shadow	❌		Superseded by the @typescript-eslint/no-shadow rule.	base-eslint.js
no-shadow-restricted-names	✅	eslint/recommended		base-eslint.js
no-sparse-arrays	✅	eslint/recommended		base-eslint.js
no-tabs	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-template-curly-in-string	✅			base-eslint.js
no-ternary	❌		Disabled because ternaries are common in the TypeScript ecosystem and can often lead to concise code that is easy to read.	base-eslint.js
no-this-before-super	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-throw-literal	❌	@typescript-eslint/strict-type-checked	Superseded by the @typescript-eslint/no-throw-literal rule.	base-eslint.js
no-trailing-spaces	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-undef	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-undef-init	✅			base-eslint.js
no-undefined	❌		Disabled because in TypeScript, it is common to explicitly check for undefined for the purposes of type narrowing.	base-eslint.js
no-underscore-dangle	❌		Disabled since it is a common pattern to use underscores to temporarily allow unused variables during development.	base-eslint.js
no-unexpected-multiline	❌	eslint/recommended eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-unmodified-loop-condition	✅			base-eslint.js
no-unneeded-ternary	✅		The defaultAssignment option is disabled to make the rule stricter.	base-eslint.js
no-unreachable	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-unreachable-loop	✅			base-eslint.js
no-unsafe-finally	✅	eslint/recommended		base-eslint.js
no-unsafe-negation	❌	eslint/recommended @typescript-eslint/eslint-recommended	Disabled because this is handled by the TypeScript compiler.	base-eslint.js
no-unsafe-optional-chaining	✅	eslint/recommended		base-eslint.js
no-unused-expressions	❌		Superseded by the @typescript-eslint/no-unused-expressions rule.	base-eslint.js
no-unused-labels	✅	eslint/recommended		base-eslint.js
no-unused-private-class-members	✅			base-eslint.js
no-unused-vars	❌	eslint/recommended @typescript-eslint/recommended	Superseded by the @typescript-eslint/no-unused-vars rule.	base-eslint.js
no-use-before-define	❌		Superseded by the @typescript-eslint/no-use-before-define rule.	base-eslint.js
no-useless-backreference	✅	eslint/recommended		base-eslint.js
no-useless-call	✅			base-eslint.js
no-useless-catch	✅	eslint/recommended		base-eslint.js
no-useless-computed-key	✅		The enforceForClassMembers option is enabled to make the rule stricter.	base-eslint.js
no-useless-concat	✅			base-eslint.js
no-useless-constructor	❌	@typescript-eslint/strict	Superseded by the @typescript-eslint/no-useless-constructor rule.	base-eslint.js
no-useless-escape	✅	eslint/recommended		base-eslint.js
no-useless-rename	✅			base-eslint.js
no-useless-return	❌		Superseded by the no-autofix/no-useless-return rule (since the autofix is usually unwanted).	base-eslint.js
no-var	✅	@typescript-eslint/eslint-recommended		base-eslint.js
no-void	✅			base-eslint.js
no-warning-comments	❌		Superseded by the unicorn/expiring-todo-comments rule.	base-eslint.js
no-whitespace-before-property	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
no-with	✅	eslint/recommended		base-eslint.js
nonblock-statement-body-position	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
object-curly-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
object-curly-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
object-property-newline	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
object-shorthand	✅		The ignoreConstructors option is disabled to make the rule stricter.	base-eslint.js
one-var	✅		The never option is provided to disallow multi-variable declarations (since they can be confusing).	base-eslint.js
one-var-declaration-per-line	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
operator-assignment	✅			base-eslint.js
operator-linebreak	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
padded-blocks	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
padding-line-between-statements	❌		Superseded by the @typescript-eslint/padding-line-between-statements rule.	base-eslint.js
prefer-arrow-callback	✅			base-eslint.js
prefer-const	❌	@typescript-eslint/eslint-recommended	Superseded by the no-autofix/prefer-const rule (since the autofix is usually unwanted).	base-eslint.js
prefer-destructuring	❌		Superseded by the @typescript-eslint/prefer-destructuring rule.	base-eslint.js
prefer-exponentiation-operator	✅			base-eslint.js
prefer-named-capture-group	❌		Disabled because it is common to have a regex with only a single match, in which case a named capture group can be needlessly verbose (and cause extra type narrowing).	base-eslint.js
prefer-numeric-literals	✅			base-eslint.js
prefer-object-has-own	✅			base-eslint.js
prefer-object-spread	✅			base-eslint.js
prefer-promise-reject-errors	❌	@typescript-eslint/strict-type-checked	Superseded by the @typescript-eslint/prefer-promise-reject-errors rule.	base-eslint.js
prefer-regex-literals	✅		The disallowRedundantWrapping option is enabled to make the rule stricter.	base-eslint.js
prefer-rest-params	✅	@typescript-eslint/eslint-recommended		base-eslint.js
prefer-spread	✅	@typescript-eslint/eslint-recommended		base-eslint.js
prefer-template	✅			base-eslint.js
quote-props	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
quotes	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
radix	✅			base-eslint.js
require-atomic-updates	❌		Disabled since Airbnb reports that the rule is "very buggy".	base-eslint.js
require-await	❌	@typescript-eslint/recommended-type-checked	Superseded by the @typescript-eslint/require-await rule.	base-eslint.js
require-unicode-regexp	❌		Disabled because requiring the u or the v flag for ASCII text is verbose and cumbersome. (Even though these flags would also enable regex strict mode, the marginal benefit is not worth the verbosity.)	base-eslint.js
require-yield	✅	eslint/recommended		base-eslint.js
rest-spread-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
semi	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
semi-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
semi-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
sort-imports	❌		Disabled since this is automatically handled by prettier-plugin-organize-imports.	base-eslint.js
sort-keys	❌		Disabled because object keys are often not meant to be sorted in alphabetical order.	base-eslint.js
sort-vars	❌		Disabled because variable declarations are often not meant to be sorted in alphabetical order.	base-eslint.js
space-before-blocks	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
space-before-function-paren	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
space-in-parens	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
space-infix-ops	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
space-unary-ops	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
spaced-comment	✅		Partially superseded by isaacscript/format-jsdoc-comments and isaacscript/format-line-comments, but those rules do not handle trailing line comments. The markers option is provided to make this rule ignore lines that start with "///".	base-eslint.js
strict	✅		The never option is provided to make the rule stricter.	base-eslint.js
switch-colon-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
symbol-description	✅			base-eslint.js
template-curly-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
template-tag-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
unicode-bom	✅			base-eslint.js
use-isnan	✅	eslint/recommended		base-eslint.js
valid-typeof	✅	eslint/recommended		base-eslint.js
vars-on-top	✅			base-eslint.js
wrap-iife	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
wrap-regex	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
yield-star-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-eslint.js
yoda	✅			base-eslint.js

eslint-plugin-no-autofix Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
no-autofix/no-useless-return	✅		It is common during development to comment out code after an early return. In these cases, the auto-fixer is harmful, since it would require us to manually go put the return statement back after uncommenting the code.	base-no-autofix.js
no-autofix/prefer-const	✅		It is common during development to comment out code that modifies a let variable. In these cases, the auto-fixer is harmful, since it would require us to manually go change the const back to a let after uncommenting the code.	base-no-autofix.js

@typescript-eslint Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
@typescript-eslint/adjacent-overload-signatures	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/array-type	✅	@typescript-eslint/stylistic	The default value is array. We choose array-simple because it makes complicated arrays easier to understand. This is worth the cost of deviating from the base rule configuration.	base-typescript-eslint.js
@typescript-eslint/await-thenable	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/ban-ts-comment	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/ban-tslint-comment	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/ban-types	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/block-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/brace-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/class-literal-property-style	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/class-methods-use-this	✅			base-typescript-eslint.js
@typescript-eslint/comma-dangle	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/comma-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/consistent-generic-constructors	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/consistent-indexed-object-style	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/consistent-return	❌		Disabled since this is handled by the noImplicitReturns TypeScript compiler flag.	base-typescript-eslint.js
@typescript-eslint/consistent-type-assertions	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/consistent-type-definitions	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/consistent-type-exports	✅			base-typescript-eslint.js
@typescript-eslint/consistent-type-imports	✅			base-typescript-eslint.js
@typescript-eslint/default-param-last	✅			base-typescript-eslint.js
@typescript-eslint/dot-notation	✅	@typescript-eslint/stylistic-type-checked		base-typescript-eslint.js
@typescript-eslint/explicit-function-return-type	❌		Disabled since it would be to cumbersome to require return types for non-exported functions. (It is more reasonable to require it for exported functions only, since it speeds up the type-checker in large codebases.)	base-typescript-eslint.js
@typescript-eslint/explicit-member-accessibility	❌		Disabled since many programs may have internal-only classes that would not benefit from an explicit public/private distinction.	base-typescript-eslint.js
@typescript-eslint/explicit-module-boundary-types	✅			base-typescript-eslint.js
@typescript-eslint/func-call-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/indent	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/init-declarations	❌		Disabled since it is superfluous to require an = undefined during variable initialization (and TypeScript will take care of the non-undefined cases).	base-typescript-eslint.js
@typescript-eslint/key-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/keyword-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/lines-around-comment	✅	eslint-config-prettier	Even though the typescript-eslint team does not recommend using formatting rules, this rule is not handled by Prettier, so we must use ESLint to enforce it.	base-typescript-eslint.js
@typescript-eslint/lines-between-class-members	✅		Even though the typescript-eslint team does not recommend using formatting rules, this rule is not handled by Prettier, so we must use ESLint to enforce it.	base-typescript-eslint.js
@typescript-eslint/max-params	❌		Disabled because enforcing an arbitrary parameter number threshold for every function in a project does not provide much value. (Additionally, using TypeScript reduces the value of such a check.)	base-typescript-eslint.js
@typescript-eslint/member-delimiter-style	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/member-ordering	❌		Disabled since prescribed class ordering is too project-specific.	base-typescript-eslint.js
@typescript-eslint/method-signature-style	✅			base-typescript-eslint.js
@typescript-eslint/naming-convention	✅		The options are copied from Airbnb. We also allow a leading underscore, which signifies that the element is temporarily not being used.	base-typescript-eslint.js
@typescript-eslint/no-array-constructor	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-array-delete	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-base-to-string	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-confusing-non-null-assertion	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/no-confusing-void-expression	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-dupe-class-members	❌		Disabled since it is superfluous when using TypeScript according to the ESLint documentation.	base-typescript-eslint.js
@typescript-eslint/no-duplicate-enum-values	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-duplicate-type-constituents	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-dynamic-delete	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-empty-function	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/no-empty-interface	✅	@typescript-eslint/stylistic	The allowSingleExtends option is enabled to allow for the common pattern of using using interfaces to provide an opaque type. (This can be useful with type-builders such as Zod, since z.infer uses Expand, which is sometimes not desired since it can lead to verbose/confusing mouseover tooltips and TypeScript errors.)	base-typescript-eslint.js
@typescript-eslint/no-explicit-any	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-extra-non-null-assertion	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-extra-parens	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/no-extra-semi	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/no-extraneous-class	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-floating-promises	✅	@typescript-eslint/recommended-type-checked	- The ignoreVoid option is disabled to make the rule stricter. - The rule is disabled in "*.test.ts" files because the built-in Node test runner returns a promise that is not meant to be awaited.	base-typescript-eslint.js
@typescript-eslint/no-for-in-array	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-implied-eval	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-import-type-side-effects	✅			base-typescript-eslint.js
@typescript-eslint/no-inferrable-types	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/no-invalid-this	✅		The capIsConstructor option is disabled to make the rule stricter.	base-typescript-eslint.js
@typescript-eslint/no-invalid-void-type	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-loop-func	✅			base-typescript-eslint.js
@typescript-eslint/no-loss-of-precision	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-magic-numbers	❌		Disabled since it results in too many false positives.	base-typescript-eslint.js
@typescript-eslint/no-meaningless-void-operator	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-misused-new	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-misused-promises	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-mixed-enums	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-namespace	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-non-null-asserted-nullish-coalescing	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-non-null-asserted-optional-chain	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-non-null-assertion	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-redeclare	❌		Disabled since it is handled by the combination of the TypeScript compiler and the no-var ESLint rule.	base-typescript-eslint.js
@typescript-eslint/no-redundant-type-constituents	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-require-imports	✅			base-typescript-eslint.js
@typescript-eslint/no-restricted-imports	✅		Configured to prevent importing with some common patterns that are almost always a mistake: - "src" directories (but allowed in test files that are in a separate "tests" directory) - "dist" directories - "index" files (things in the same package should directly import instead of use the public API)	base-typescript-eslint.js
@typescript-eslint/no-shadow	✅			base-typescript-eslint.js
@typescript-eslint/no-this-alias	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-throw-literal	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-type-alias	❌		Disabled because this rule is deprecated.	base-typescript-eslint.js
@typescript-eslint/no-unnecessary-boolean-literal-compare	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unnecessary-condition	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unnecessary-qualifier	✅			base-typescript-eslint.js
@typescript-eslint/no-unnecessary-type-arguments	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unnecessary-type-assertion	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unnecessary-type-constraint	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-unsafe-argument	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-assignment	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-call	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-declaration-merging	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/no-unsafe-enum-comparison	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-member-access	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-return	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/no-unsafe-unary-minus	✅			base-typescript-eslint.js
@typescript-eslint/no-unused-expressions	✅		The allowTaggedTemplates option is enabled to allow the rule to work with libraries like execa.	base-typescript-eslint.js
@typescript-eslint/no-unused-vars	✅	@typescript-eslint/recommended	The args option is set to all make the rule stricter. Additionally, we ignore things that begin with an underscore, since this matches the behavior of the --noUnusedLocals TypeScript compiler flag.	base-typescript-eslint.js
@typescript-eslint/no-use-before-define	❌		Disabled because it can prevent code from being structured sequentially.	base-typescript-eslint.js
@typescript-eslint/no-useless-constructor	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/no-useless-empty-export	✅			base-typescript-eslint.js
@typescript-eslint/no-useless-template-literals	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/no-var-requires	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/non-nullable-type-assertion-style	✅	@typescript-eslint/stylistic-type-checked		base-typescript-eslint.js
@typescript-eslint/object-curly-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/padding-line-between-statements	❌		Disabled since it is for inserting extra newlines between specific kinds of statements, which would be project-dependant. (This kind of formatting is not handled by Prettier.)	base-typescript-eslint.js
@typescript-eslint/parameter-properties	✅			base-typescript-eslint.js
@typescript-eslint/prefer-as-const	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/prefer-destructuring	✅		Object destructuring is enforced but array destructuring is not. This matches usage in the general TypeScript ecosystem.	base-typescript-eslint.js
@typescript-eslint/prefer-enum-initializers	✅			base-typescript-eslint.js
@typescript-eslint/prefer-find	✅			base-typescript-eslint.js
@typescript-eslint/prefer-for-of	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/prefer-function-type	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/prefer-includes	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/prefer-literal-enum-member	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/prefer-namespace-keyword	✅	@typescript-eslint/stylistic		base-typescript-eslint.js
@typescript-eslint/prefer-nullish-coalescing	✅	@typescript-eslint/stylistic-type-checked		base-typescript-eslint.js
@typescript-eslint/prefer-optional-chain	❌	@typescript-eslint/stylistic-type-checked	Disabled because it can modify the type of boolean declarations, which is undesired in some circumstances.	base-typescript-eslint.js
@typescript-eslint/prefer-promise-reject-errors	✅	@typescript-eslint/strict-type-checked	The allowEmptyReject option is enabled since this is a common pattern.	base-typescript-eslint.js
@typescript-eslint/prefer-readonly	✅			base-typescript-eslint.js
@typescript-eslint/prefer-readonly-parameter-types	❌		Superseded by the isaacscript/prefer-readonly-parameter-types rule.	base-typescript-eslint.js
@typescript-eslint/prefer-reduce-type-parameter	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/prefer-regexp-exec	❌		Disabled since using the String.match form might make code easier to read.	base-typescript-eslint.js
@typescript-eslint/prefer-return-this-type	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js
@typescript-eslint/prefer-string-starts-ends-with	✅	@typescript-eslint/stylistic-type-checked		base-typescript-eslint.js
@typescript-eslint/prefer-ts-expect-error	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/promise-function-async	✅			base-typescript-eslint.js
@typescript-eslint/quotes	✅	eslint-config-prettier	We forbid unnecessary backticks by using the options specified in the eslint-config-prettier documentation.	base-typescript-eslint.js
@typescript-eslint/require-array-sort-compare	✅			base-typescript-eslint.js
@typescript-eslint/require-await	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/restrict-plus-operands	✅	@typescript-eslint/recommended-type-checked	The various "allow" options are disabled to make the rule stricter.	base-typescript-eslint.js
@typescript-eslint/restrict-template-expressions	❌	@typescript-eslint/recommended-type-checked	Disabled since a common use-case of template strings is to coerce everything to a string.	base-typescript-eslint.js
@typescript-eslint/return-await	✅		Even though the core rule was deprecated, the extended rule uses type information, so it is much better.	base-typescript-eslint.js
@typescript-eslint/semi	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/sort-type-constituents	❌		Disabled since in it does not make sense to sort a union alphabetically in many cases.	base-typescript-eslint.js
@typescript-eslint/space-before-blocks	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/space-before-function-paren	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/space-infix-ops	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/strict-boolean-expressions	✅		The allowString and allowNumber options are disabled to make the rule stricter.	base-typescript-eslint.js
@typescript-eslint/switch-exhaustiveness-check	✅		The allowDefaultCaseForExhaustiveSwitch option is disabled and the requireDefaultForNonUnion option is enabled to make the rule stricter.	base-typescript-eslint.js
@typescript-eslint/triple-slash-reference	✅	@typescript-eslint/recommended		base-typescript-eslint.js
@typescript-eslint/type-annotation-spacing	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-typescript-eslint.js
@typescript-eslint/typedef	❌		Disabled since it is not recommended by the typescript-eslint team. (They recommend using the noImplicitAny and strictPropertyInitialization TypeScript compiler options instead.)	base-typescript-eslint.js
@typescript-eslint/unbound-method	✅	@typescript-eslint/recommended-type-checked		base-typescript-eslint.js
@typescript-eslint/unified-signatures	✅	@typescript-eslint/strict		base-typescript-eslint.js
@typescript-eslint/use-unknown-in-catch-callback-variable	✅	@typescript-eslint/strict-type-checked		base-typescript-eslint.js

eslint-plugin-eslint-comments Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
eslint-comments/disable-enable-pair	✅	eslint-comments/recommended	The allowWholeFile option is enabled because it is common practice to use "eslint-disable" comments for a whole file.	base-eslint-comments.js
eslint-comments/no-aggregating-enable	✅	eslint-comments/recommended		base-eslint-comments.js
eslint-comments/no-duplicate-disable	✅	eslint-comments/recommended		base-eslint-comments.js
eslint-comments/no-restricted-disable	❌		Disabled because it is only useful in projects that want to prevent disabling specific ESLint rules.	base-eslint-comments.js
eslint-comments/no-unlimited-disable	❌	eslint-comments/recommended	Disabled because if a line breaks three or more ESLint rules, then it is useful to use a single "eslint-disable" comment to make things more concise.	base-eslint-comments.js
eslint-comments/no-unused-disable	✅			base-eslint-comments.js
eslint-comments/no-unused-enable	✅	eslint-comments/recommended		base-eslint-comments.js
eslint-comments/no-use	❌		Disabled because we want to allow disabling ESLint rules where appropriate.	base-eslint-comments.js
eslint-comments/require-description	❌		Disabled because requiring descriptions for every ESLint disable would be too cumbersome.	base-eslint-comments.js

eslint-plugin-import Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
import/consistent-type-specifier-style	✅			base-import.js
import/default	❌	import/recommended	Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/dynamic-import-chunkname	❌		Disabled because it is only useful in environments that use webpack.	base-import.js
import/export	✅	import/recommended		base-import.js
import/exports-last	❌		Disabled because this style is not generally used.	base-import.js
import/extensions	❌		Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/first	✅			base-import.js
import/group-exports	❌		Disabled because this style is not generally used.	base-import.js
import/imports-first	❌		Disabled because this rule is deprecated.	base-import.js
import/max-dependencies	❌		Disabled since it will trigger false positives in codebases that prefer smaller files.	base-import.js
import/named	❌	import/recommended	Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/namespace	❌	import/recommended	Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/newline-after-import	✅			base-import.js
import/no-absolute-path	✅			base-import.js
import/no-amd	✅			base-import.js
import/no-anonymous-default-export	❌		Disabled since we disallow default exports elsewhere in this config (in favor of named exports).	base-import.js
import/no-commonjs	✅			base-import.js
import/no-cycle	✅			base-import.js
import/no-default-export	✅		The case against default exports is layed out by Basarat Ali Syed.	base-import.js
import/no-deprecated	❌		Superseded by the deprecation/deprecation rule. (That rule is better because it catches deprecated usage that does not come from import statements specifically.)	base-import.js
import/no-duplicates	✅	import/recommended		base-import.js
import/no-dynamic-require	✅			base-import.js
import/no-empty-named-blocks	✅			base-import.js
import/no-extraneous-dependencies	✅		The options are copied from Airbnb. We also add a "scripts" directory entry for "devDependencies".	base-import.js
import/no-import-module-exports	✅			base-import.js
import/no-internal-modules	❌		Disabled since a prescribed import pattern is not generalizable enough across projects.	base-import.js
import/no-mutable-exports	✅			base-import.js
import/no-named-as-default	✅	import/recommended		base-import.js
import/no-named-as-default-member	❌	import/recommended	Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/no-named-default	✅			base-import.js
import/no-named-export	❌		Disabled since we disallow default exports elsewhere in this config (in favor of named exports).	base-import.js
import/no-namespace	❌		Disabled since it is too prescriptive for a general audience. (Using import * as is common.)	base-import.js
import/no-nodejs-modules	❌		Disabled because it is only used in specific environments (like the browser).	base-import.js
import/no-relative-packages	✅			base-import.js
import/no-relative-parent-imports	❌		Disabled since a forward import direction pattern is not generalizable enough across projects.	base-import.js
import/no-restricted-paths	❌		Disabled since this rule should only contain a project-specific path restriction.	base-import.js
import/no-self-import	✅			base-import.js
import/no-unassigned-import	✅			base-import.js
import/no-unresolved	❌	import/recommended	Disabled because this is already handled by the TypeScript compiler.	base-import.js
import/no-unused-modules	❌		Disabled since this check is better performed by the knip tool.	base-import.js
import/no-useless-path-segments	✅			base-import.js
import/no-webpack-loader-syntax	✅			base-import.js
import/order	❌		Disabled because this is automatically handled by prettier-plugin-organize-imports.	base-import.js
import/prefer-default-export	❌		Disabled because we disallow default exports elsewhere in this config (in favor of named exports).	base-import.js
import/unambiguous	❌		Disabled because this is already handled by the TypeScript compiler.	base-import.js

eslint-plugin-jsdoc Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
jsdoc/check-access	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/check-alignment	❌	jsdoc/recommended	Superseded by the isaacscript/limit-jsdoc-comments rule.	base-jsdoc.js
jsdoc/check-examples	❌	jsdoc/recommended	Disabled since it does not work with ESLint 8.	base-jsdoc.js
jsdoc/check-indentation	❌	jsdoc/recommended	Superseded by the isaacscript/limit-jsdoc-comments rule.	base-jsdoc.js
jsdoc/check-line-alignment	❌	jsdoc/recommended	Disabled since this is not a common formatting scheme. It is also not recommended by the plugin authors.	base-jsdoc.js
jsdoc/check-param-names	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/check-property-names	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/check-syntax	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/check-tag-names	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/check-types	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/check-values	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/empty-tags	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/implements-on-classes	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/imports-as-dependencies	❌	jsdoc/recommended	Disabled since you cannot configure it with a path to the correct "package.json" file.	base-jsdoc.js
jsdoc/informative-docs	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/match-description	❌	jsdoc/recommended	Superseded by the isaacscript/jsdoc-full-sentences rule.	base-jsdoc.js
jsdoc/match-name	❌	jsdoc/recommended	Disabled because it is only needed for projects with specific JSDoc requirements.	base-jsdoc.js
jsdoc/multiline-blocks	❌	jsdoc/recommended	Superseded by the isaacscript/limit-jsdoc-comments rule.	base-jsdoc.js
jsdoc/newline-after-description	❌		Superseded by the isaacscript/limit-jsdoc-comments rule.	base-jsdoc.js
jsdoc/no-bad-blocks	❌	jsdoc/recommended	Disabled because it provides little value; it only detects JSDoc comments with tags in them.	base-jsdoc.js
jsdoc/no-blank-block-descriptions	❌	jsdoc/recommended	Superseded by the isaacscript/format-jsdoc-comments rule.	base-jsdoc.js
jsdoc/no-blank-blocks	❌	jsdoc/recommended	Superseded by the isaacscript/no-empty-jsdoc rule.	base-jsdoc.js
jsdoc/no-defaults	❌	jsdoc/recommended	Disabled because it provides little value; the @default tag is rare.	base-jsdoc.js
jsdoc/no-missing-syntax	❌	jsdoc/recommended	Disabled because it is too project-specific.	base-jsdoc.js
jsdoc/no-multi-asterisks	❌	jsdoc/recommended	Superseded by the isaacscript/limit-jsdoc-comments rule.	base-jsdoc.js
jsdoc/no-restricted-syntax	❌	jsdoc/recommended	Disabled because it is intended for disabling of specific language features per-project.	base-jsdoc.js
jsdoc/no-types	✅	jsdoc/recommended	The contexts option is set to any to make the rule stricter.	base-jsdoc.js
jsdoc/no-undefined-types	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/require-asterisk-prefix	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/require-description	❌	jsdoc/recommended	Disabled because it is overboard for every function to have a description.	base-jsdoc.js
jsdoc/require-description-complete-sentence	❌	jsdoc/recommended	Superseded by the isaacscript/jsdoc-complete-sentences rule.	base-jsdoc.js
jsdoc/require-example	❌	jsdoc/recommended	Disabled because it is overboard for every function to require an example.	base-jsdoc.js
jsdoc/require-file-overview	❌	jsdoc/recommended	Disabled because it is overboard for every file to require an overview.	base-jsdoc.js
jsdoc/require-hyphen-before-param-description	✅	jsdoc/recommended	The never option is provided to make the rule match the format of the official TypeScript codebase.	base-jsdoc.js
jsdoc/require-jsdoc	❌	jsdoc/recommended	Disabled since it is overboard for every function to have a JSDoc comment.	base-jsdoc.js
jsdoc/require-param	✅	jsdoc/recommended	Configured to only apply when there are one or more parameters.	base-jsdoc.js
jsdoc/require-param-description	✅	jsdoc/recommended	The contexts option is set to any to make the rule stricter.	base-jsdoc.js
jsdoc/require-param-name	✅	jsdoc/recommended	The contexts option is set to any to make the rule stricter.	base-jsdoc.js
jsdoc/require-param-type	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/require-property	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/require-property-description	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/require-property-name	✅	jsdoc/recommended		base-jsdoc.js
jsdoc/require-property-type	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/require-returns	❌	jsdoc/recommended	Disabled because it is overboard for every function to document every return value.	base-jsdoc.js
jsdoc/require-returns-check	❌	jsdoc/recommended	Disabled because it is overboard for every function to document every return value.	base-jsdoc.js
jsdoc/require-returns-description	✅	jsdoc/recommended	The contexts option is set to any to make the rule stricter.	base-jsdoc.js
jsdoc/require-returns-type	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js
jsdoc/require-throws	❌	jsdoc/recommended	Disabled because it is overboard to document every throw statement.	base-jsdoc.js
jsdoc/require-yields	❌	jsdoc/recommended	Disabled because it is overboard to document every yield.	base-jsdoc.js
jsdoc/require-yields-check	❌	jsdoc/recommended	Disabled because it is overboard to document every yield.	base-jsdoc.js
jsdoc/sort-tags	❌	jsdoc/recommended	Disabled because it is not very useful. In most cases, a function will only have @param and @return tags, making sorting unnecessary.	base-jsdoc.js
jsdoc/tag-lines	❌	jsdoc/recommended	Superseded by the isaacscript/format-jsdoc-comments rule.	base-jsdoc.js
jsdoc/text-escaping	❌	jsdoc/recommended	Disabled since it is only useful in certain environments (e.g. when your project converts JSDoc comments to Markdown).	base-jsdoc.js
jsdoc/valid-types	❌	jsdoc/recommended	Disabled because it is not needed in TypeScript.	base-jsdoc.js

eslint-plugin-n Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
n/callback-return	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/exports-style	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/file-extension-in-import	✅		This rule is helpful to automatically fix file extensions in import statements throughout an entire codebase.	base-n.js
n/global-require	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/handle-callback-err	✅			base-n.js
n/no-callback-literal	✅			base-n.js
n/no-deprecated-api	✅	n/recommended		base-n.js
n/no-exports-assign	✅	n/recommended		base-n.js
n/no-extraneous-import	❌	n/recommended	Disabled since it is handled by the TypeScript compiler.	base-n.js
n/no-extraneous-require	❌	n/recommended	Disabled since require statements are not used in TypeScript code.	base-n.js
n/no-hide-core-modules	❌		Disabled because this rule is deprecated.	base-n.js
n/no-missing-import	❌	n/recommended	Disabled since it is handled by the TypeScript compiler.	base-n.js
n/no-missing-require	✅	n/recommended		base-n.js
n/no-mixed-requires	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/no-new-require	✅			base-n.js
n/no-path-concat	✅			base-n.js
n/no-process-env	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/no-process-exit	❌	n/recommended	Disabled because using process.exit is common to exit command-line applications without verbose output.	base-n.js
n/no-restricted-import	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/no-restricted-require	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/no-sync	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/no-unpublished-bin	✅	n/recommended		base-n.js
n/no-unpublished-import	✅	n/recommended	An exception is made for files in a "scripts" directory, since those should be allowed to import from "devDependencies".	base-n.js
n/no-unpublished-require	✅	n/recommended		base-n.js
n/no-unsupported-features	❌		Disabled because this rule is deprecated.	base-n.js
n/no-unsupported-features/es-builtins	❌	n/recommended	Disabled because it is assumed that we are running on modern versions of Node.js.	base-n.js
n/no-unsupported-features/es-syntax	❌	n/recommended	Disabled because it is assumed that our transpiler or runtime has support for the latest version of ESM.	base-n.js
n/no-unsupported-features/node-builtins	❌	n/recommended	Disabled since it is handled by the TypeScript compiler.	base-n.js
n/prefer-global/buffer	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/console	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/process	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/text-decoder	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/text-encoder	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/url	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-global/url-search-params	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-promises/dns	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/prefer-promises/fs	❌		Disabled since stylistic rules from this plugin are not used.	base-n.js
n/process-exit-as-throw	✅	n/recommended		base-n.js
n/shebang	❌	n/recommended	Disabled since it does not work very well with TypeScript. (It needs project-specific configuration depending on where the output directory is located.)	base-n.js

eslint-plugin-unicorn Rules

Rule Name	Enabled	Parent Configs	Notes	Source File
unicorn/better-regex	✅			base-unicorn.js
unicorn/catch-error-name	✅			base-unicorn.js
unicorn/consistent-destructuring	❌		Disabled because it has too many false positives.	base-unicorn.js
unicorn/consistent-function-scoping	✅			base-unicorn.js
unicorn/custom-error-definition	✅			base-unicorn.js
unicorn/empty-brace-spaces	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-unicorn.js
unicorn/error-message	✅			base-unicorn.js
unicorn/escape-case	✅			base-unicorn.js
unicorn/expiring-todo-comments	✅			base-unicorn.js
unicorn/explicit-length-check	✅			base-unicorn.js
unicorn/filename-case	❌		Disabled since projects may use different file naming conventions.	base-unicorn.js
unicorn/import-index	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/import-style	✅			base-unicorn.js
unicorn/new-for-builtins	✅			base-unicorn.js
unicorn/no-abusive-eslint-disable	❌		Superseded by the eslint-comments/no-unlimited-disable rule.	base-unicorn.js
unicorn/no-array-callback-reference	❌		Disabled since it is not helpful when using TypeScript.	base-unicorn.js
unicorn/no-array-for-each	✅			base-unicorn.js
unicorn/no-array-instanceof	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/no-array-method-this-argument	✅			base-unicorn.js
unicorn/no-array-push-push	✅			base-unicorn.js
unicorn/no-array-reduce	✅			base-unicorn.js
unicorn/no-await-expression-member	✅			base-unicorn.js
unicorn/no-console-spaces	✅			base-unicorn.js
unicorn/no-document-cookie	✅			base-unicorn.js
unicorn/no-empty-file	✅			base-unicorn.js
unicorn/no-fn-reference-in-iterator	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/no-for-loop	✅			base-unicorn.js
unicorn/no-hex-escape	✅			base-unicorn.js
unicorn/no-instanceof-array	✅			base-unicorn.js
unicorn/no-invalid-remove-event-listener	✅			base-unicorn.js
unicorn/no-keyword-prefix	❌		Disabled because it is common to prefix variables with "new".	base-unicorn.js
unicorn/no-lonely-if	✅			base-unicorn.js
unicorn/no-negated-condition	✅			base-unicorn.js
unicorn/no-nested-ternary	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-unicorn.js
unicorn/no-new-array	✅			base-unicorn.js
unicorn/no-new-buffer	✅			base-unicorn.js
unicorn/no-null	✅			base-unicorn.js
unicorn/no-object-as-default-parameter	✅			base-unicorn.js
unicorn/no-process-exit	❌		Disabled because using process.exit is common to exit command-line applications without verbose output.	base-unicorn.js
unicorn/no-reduce	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/no-static-only-class	✅			base-unicorn.js
unicorn/no-thenable	✅			base-unicorn.js
unicorn/no-this-assignment	❌		Superseded by the @typescript-eslint/no-this-alias rule.	base-unicorn.js
unicorn/no-typeof-undefined	✅			base-unicorn.js
unicorn/no-unnecessary-await	✅			base-unicorn.js
unicorn/no-unnecessary-polyfills	✅			base-unicorn.js
unicorn/no-unreadable-array-destructuring	✅			base-unicorn.js
unicorn/no-unreadable-iife	✅			base-unicorn.js
unicorn/no-unsafe-regex	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/no-unused-properties	✅			base-unicorn.js
unicorn/no-useless-fallback-in-spread	✅			base-unicorn.js
unicorn/no-useless-length-check	✅			base-unicorn.js
unicorn/no-useless-promise-resolve-reject	✅			base-unicorn.js
unicorn/no-useless-spread	✅			base-unicorn.js
unicorn/no-useless-switch-case	✅			base-unicorn.js
unicorn/no-useless-undefined	❌		Disabled since it does not work properly with TypeScript.	base-unicorn.js
unicorn/no-zero-fractions	✅			base-unicorn.js
unicorn/number-literal-case	❌	eslint-config-prettier	Disabled because this is handled by Prettier.	base-unicorn.js
unicorn/numeric-separators-style	✅			base-unicorn.js
unicorn/prefer-add-event-listener	✅			base-unicorn.js
unicorn/prefer-array-find	✅			base-unicorn.js
unicorn/prefer-array-flat	✅			base-unicorn.js
unicorn/prefer-array-flat-map	✅			base-unicorn.js
unicorn/prefer-array-index-of	✅			base-unicorn.js
unicorn/prefer-array-some	✅			base-unicorn.js
unicorn/prefer-at	✅			base-unicorn.js
unicorn/prefer-blob-reading-methods	✅			base-unicorn.js
unicorn/prefer-code-point	✅			base-unicorn.js
unicorn/prefer-dataset	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-date-now	✅			base-unicorn.js
unicorn/prefer-default-parameters	✅			base-unicorn.js
unicorn/prefer-dom-node-append	✅			base-unicorn.js
unicorn/prefer-dom-node-dataset	✅			base-unicorn.js
unicorn/prefer-dom-node-remove	✅			base-unicorn.js
unicorn/prefer-dom-node-text-content	✅			base-unicorn.js
unicorn/prefer-event-key	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-event-target	✅			base-unicorn.js
unicorn/prefer-exponentiation-operator	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-export-from	✅			base-unicorn.js
unicorn/prefer-flat-map	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-includes	✅			base-unicorn.js
unicorn/prefer-json-parse-buffer	❌		Disabled because the rule is not compatible with TypeScript.	base-unicorn.js
unicorn/prefer-keyboard-event-key	✅			base-unicorn.js
unicorn/prefer-logical-operator-over-ternary	✅			base-unicorn.js
unicorn/prefer-math-trunc	✅			base-unicorn.js
unicorn/prefer-modern-dom-apis	✅			base-unicorn.js
unicorn/prefer-modern-math-apis	✅			base-unicorn.js
unicorn/prefer-module	✅			base-unicorn.js
unicorn/prefer-native-coercion-functions	✅			base-unicorn.js
unicorn/prefer-negative-index	✅			base-unicorn.js
unicorn/prefer-node-append	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-node-protocol	✅			base-unicorn.js
unicorn/prefer-node-remove	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-number-properties	✅			base-unicorn.js
unicorn/prefer-object-from-entries	✅			base-unicorn.js
unicorn/prefer-object-has-own	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-optional-catch-binding	✅			base-unicorn.js
unicorn/prefer-prototype-methods	✅			base-unicorn.js
unicorn/prefer-query-selector	✅			base-unicorn.js
unicorn/prefer-reflect-apply	✅			base-unicorn.js
unicorn/prefer-regexp-test	✅			base-unicorn.js
unicorn/prefer-replace-all	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-set-has	✅			base-unicorn.js
unicorn/prefer-set-size	✅			base-unicorn.js
unicorn/prefer-spread	✅			base-unicorn.js
unicorn/prefer-starts-ends-with	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-string-replace-all	✅			base-unicorn.js
unicorn/prefer-string-slice	✅			base-unicorn.js
unicorn/prefer-string-starts-ends-with	✅			base-unicorn.js
unicorn/prefer-string-trim-start-end	✅			base-unicorn.js
unicorn/prefer-switch	✅			base-unicorn.js
unicorn/prefer-ternary	✅			base-unicorn.js
unicorn/prefer-text-content	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-top-level-await	✅			base-unicorn.js
unicorn/prefer-trim-start-end	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/prefer-type-error	✅			base-unicorn.js
unicorn/prevent-abbreviations	❌		Disabled since it is common to use the variable name of "i".	base-unicorn.js
unicorn/regex-shorthand	❌		Disabled because this rule is deprecated.	base-unicorn.js
unicorn/relative-url-style	✅			base-unicorn.js
unicorn/require-array-join-separator	✅			base-unicorn.js
unicorn/require-number-to-fixed-digits-argument	✅			base-unicorn.js
unicorn/require-post-message-target-origin	❌		Disabled since it is not recommended by the plugin authors.	base-unicorn.js
unicorn/string-content	❌		Disabled since string content enforcement is too project-specific.	base-unicorn.js
unicorn/switch-case-braces	✅			base-unicorn.js
unicorn/template-indent	✅	eslint-config-prettier		base-unicorn.js
unicorn/text-encoding-identifier-case	✅			base-unicorn.js
unicorn/throw-new-error	✅			base-unicorn.js