useImportExtensions
Summary
Section titled Summary- Rule available since:
v1.8.0
- Diagnostic Category:
lint/correctness/useImportExtensions
- This rule has a safe fix.
- The default severity of this rule is information.
Description
Section titled DescriptionEnforce file extensions for relative imports.
Browsers, Deno, and Node.js do not natively support importing files without extensions from JavaScript modules. This rule enforces the use of file extensions for relative imports to make the code more consistent — and correct.
In some cases, tooling can also benefit from explicit file extensions, because they do not need to guess which file to resolve.
The rule checks both static imports (import ... from "..."
) as well as
dynamic imports such as import(...)
and require(...)
.
Examples
Section titled ExamplesInvalid
Section titled InvalidThe following examples assume these imports will resolve to a file with an extension. Imports that don’t resolve at all will not trigger a diagnostic.
import "./foo";
import "./foo/";
import "../";
import "../.";
import("./foo");
require("./foo");
Valid
Section titled Validimport "biome";
import "./foo.js";
import "./bar/index.js";
import("./foo.js");
require("./foo.js");
Options
Section titled OptionsThe rule provides the options described below.
forceJsExtensions
Section titled forceJsExtensionsNormally, this rule suggests to use the extension of the module that is
found in your project. For instance, .ts
or .tsx
for a TypeScript
file. If this option is set to true
, the rule will always suggest to
use .js
regardless of the extension in your project.
This is useful if you use the "module": "node16"
setting when building
your code with tsc
.
Default: false
{ "options": { "forceJsExtensions": true }}
Editor Configuration
Section titled Editor ConfigurationIf you use Visual Studio Code, you can ensure that it adds the file
extension when automatically importing a variable by configuring
javascript.preferences.importModuleSpecifierEnding
and
typescript.preferences.importModuleSpecifierEnding
in your settings.
Caveats
Section titled CaveatsIf you are using TypeScript, TypeScript version 5.0 or later is
required, also make sure to set
allowImportingTsExtensions: true
in your tsconfig.json
.
How to configure
Section titled How to configure{ "linter": { "rules": { "correctness": { "useImportExtensions": "error" } } }}