import/first Style

🚧 An auto-fix is planned for this rule, but not implemented at this time.

What it does

Forbids any non-import statements before imports except directives.

Why is this bad?

Notably, imports are hoisted, which means the imported modules will be evaluated before any of the statements interspersed between them. Keeping all imports together at the top of the file may prevent surprises resulting from this part of the spec

Examples

Examples of incorrect code for this rule:

import { x } from "./foo";
export { x };
import { y } from "./bar";

Examples of correct code for this rule:

import { y } from "./bar";
import { x } from "./foo";
export { x, y };

Configuration

This rule accepts one of the following string values:

"absolute-first"

Forces absolute imports to be listed before relative imports.

Examples of incorrect code for this rule with "absolute-first":

import { y } from "bar";
import { x } from "./foo";

Examples of correct code for this rule with "absolute-first":

import { y } from "bar";
import { x } from "./foo";

"disable-absolute-first"

Disables the absolute-first behavior. This is the default behavior.

How to use

To enable this rule in the CLI or using the config file, you can use:

CLI

oxlint --deny import/first --import-plugin

Config (.oxlintrc.json)

{
  "plugins": ["import"],
  "rules": {
    "import/first": "error"
  }
}

References

• Rule Source