Skip to content

JavaScript analysis rules

Static analysis of JavaScript and TypeScript sources: unused, unlisted and unresolved dependencies, unused files and exports. These rules need the JS analysis, which --no-js or [js] enabled = false turns off. Configured with [js].

Rule Default severity Fixable
circular-imports off none
duplicate-exports warning none
stale-js-config warning none
stale-mocks error none
unlisted-binaries warning none
unlisted-dependencies error none
unparseable-files warning none
unresolved-imports error none
unused-class-members warning unsafe
unused-dependencies error unsafe
unused-dev-dependencies warning unsafe
unused-enum-members warning unsafe
unused-exports warning unsafe
unused-files warning sometimes
unused-namespace-exports warning unsafe
unused-namespace-members warning unsafe
unused-namespace-types warning unsafe
unused-optional-peer-dependencies warning none
unused-subpath-exports off none
unused-subpath-imports warning unsafe
unused-types warning unsafe

Fixable is safe (applied by --fix), unsafe (applied only by --fix-unsafe), sometimes (fixable for some findings) or none. See the CLI reference.

Modules import each other in a cycle.

  • Default severity: off
  • Fixable: none
[rules]
circular-imports = "off"

One binding is exported under several names.

  • Default severity: warning
  • Fixable: none
[rules]
duplicate-exports = "warn"

A [js] setting matched nothing, is redundant or cancels another pattern, a published entry file is missing, or many files are unused.

  • Default severity: warning
  • Fixable: none
[rules]
stale-js-config = "warn"

A test-runner mock names a relative or aliased module that does not exist.

  • Default severity: error
  • Fixable: none
[rules]
stale-mocks = "error"

A script, or a command in a workflow, tool config or source file, runs a binary that no listed dependency provides.

  • Default severity: warning
  • Fixable: none
[rules]
unlisted-binaries = "warn"

A file imports a package that neither its package.json nor any package.json above it lists. An import that only the tsconfig paths of another package map has the detail ForeignTsconfigPaths: it needs a mapping, not a dependency. A package a tool config names (a tsconfig extends, an ESLint or Oxlint plugin, a Prisma generator) is reported at the config with the detail ConfigReference.

  • Default severity: error
  • Fixable: none
[rules]
unlisted-dependencies = "error"

A file reachable from an entry file has a syntax error the parser could not recover from.

  • Default severity: warning
  • Fixable: none
[rules]
unparseable-files = "warn"

An import specifier does not resolve to a file or a package.

  • Default severity: error
  • Fixable: none
[rules]
unresolved-imports = "error"

A member of an exported class is never read.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-class-members = "warn"

A package in dependencies is never imported, required or run by a script; optionalDependencies are not checked.

  • Default severity: error
  • Fixable: unsafe
[rules]
unused-dependencies = "error"

A package in devDependencies is never imported, required or run by a script, or is also in dependencies.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-dev-dependencies = "warn"

A member of an exported enum is never read.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-enum-members = "warn"

An exported value is not imported by any other module.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-exports = "warn"

A project file is not reachable from any entry file.

  • Default severity: warning
  • Fixable: sometimes
[rules]
unused-files = "warn"

An exported value of a module that is only read through a namespace import is never accessed.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-namespace-exports = "warn"

An exported member of a TypeScript namespace is never read.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-namespace-members = "warn"

An exported type of a module that is only read through a namespace import is never accessed.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-namespace-types = "warn"

An optional peer dependency is imported but not installed as a dependency or dev dependency.

  • Default severity: warning
  • Fixable: none
[rules]
unused-optional-peer-dependencies = "warn"

A package.json exports subpath is not imported by any workspace package.

  • Default severity: off
  • Fixable: none
[rules]
unused-subpath-exports = "off"

A package.json imports entry is not imported by any file of its package.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-subpath-imports = "warn"

An exported type or interface is not imported by any other module.

  • Default severity: warning
  • Fixable: unsafe
[rules]
unused-types = "warn"