Overview

There are quite a few times when users have a real need to change or disable a rule for specifically some package exports:

• Enhancement:@typescript-eslint/no-floating-promises should Ignore node 18's built-in test function #5231: At least the new built-innode:test runner intentionally returns ignorable Promises from itstest() method that can be ignored by the rule
• TheallowedNames option fromexplicit-module-boundary-types
• ThetypesToIgnore option fromno-unnecessary-type-assertion
• TheallowedPromiseNames option frompromise-function-async
• Proposed:[no-unnecessary-condition] ignore array index return #1798
• Proposed:feat(eslint-plugin): [prefer-readonly-parameter-types] added an optional type allowlist #4436

This RFC proposes a unified format that all rules can use to specify some types or values from the global namespace and/or packages.

Prior Art

Some rules have previously created name-based overrides, such astypesToIgnore fromno-unnecessary-type-assertion. Those are sub-optimal:

• Names have conflicts. If you configure a rule for, say, all functions of a particular name that a package exports, you might also happen to ignore the rule for your internal functions of the same name.
• It may be necessary to configure a rule for all values of a particular type, regardless of their name.

For example,@typescript-eslint/no-floating-promises even has avoid operator to get around needing to disable the rule for specific cases. It's the workaround we currently recommend for issues such as#5231.

Proposal

The current proposal is for specifying the following types of sources, in increasing order of distance from a line of code:

• File: the current file or another specific file in your package (often exported as a module, but not necessarily)
• Lib: globals such as fromlib.d.ts orlib.dom.d.ts
• Package: an export from a package, such as"lodash"

Additionally, you can specify multiple of these at the same time with typemany.

interfaceFileSpecifier{from:"file";name:string|string[];source?:string;}interfaceLibSpecifier{from:"lib";name:string|string[];}interfacePackageSpecifier{from:"package";name:string|string[];source:string;}interfaceManySpecifiers{from:EntitySpecifierFrom[];name:string;}typeEntitySpecifierFrom="file"|"lib"|"package";typeEntitySpecifier=|string|FileSpecifier|LibSpecifier|PackageSpecifier|ManySpecifiers;

An example of how this might look in practice:

exportdefault{rules:{// https://github.com/typescript-eslint/typescript-eslint/issues/5231"@typescript-eslint/no-floating-promises":["error",{"ignore":[{"from":"node:test","name":["it","test"]}]}],}}

See#5271 (comment) and following comments for more context.

interfaceGlobalSpecifier{name:string;}interfaceModuleSpecifier{export:string;module:string;}typeSpecifier=GlobalSpecifier|ModuleSpecifier;

{"name":"location"}

{"name":"window.location"}

{"export":"test","module":"node:test"}

{"export":"SafePromise","module":"~/utils/promises"}

{"export":"SafePromise","module":"safe-promises"}