Rules

Oxcruise has 17 built-in rules. Each rule is in one category. A category switches all its rules on or off together. See Rules and categories.

Correctness

Default level: error.

• circular-dependencies: Reports dependencies that are part of a circular chain of imports.
• cross-package-relative-dependencies: Reports relative imports that reach into another workspace package, for example ../other-package/src/x.
• dependencies-on-tests: Reports a non-test module that imports a test file or a test directory.
• dev-dependencies-in-production: Reports a production module that imports a package from devDependencies only.
• undeclared-packages: Reports imports of installed npm packages that no package.json section declares.
• unresolved-dependencies: Reports an import that oxcruise cannot resolve to a file or a package.

Suspicious

Default level: warn.

• deprecated-dependencies: Reports imports of deprecated Node.js built-in modules and deprecated npm packages.
• duplicate-packages: Reports a package that more than one package.json section declares, for example both dependencies and devDependencies.
• orphan-modules: Reports modules that no other module imports and that import no module.

Restriction

Default level: off.

• layers: Enforces a layered architecture: a layer can import only the layers that allow lists for it.
• optional-dependencies: Reports use of optional dependencies.
• peer-dependencies: Reports use of peer dependencies.
• visibility: Restricts what a folder shows to the code outside it.

Nursery

Default level: off.

• folder-structure: Checks the shape of the file tree: the files that a folder must have, the names that it can have, and the case of its names.
• unused-exports: Reports exports that no other module imports.
• unused-modules: Reports source modules that no path from an entry point reaches.
• unused-packages: Reports a package that a package.json declares and that none of its modules imports.

Conventions

A convention tells the unused-* rules what a tool loads by itself. A convention is active in a package.json that declares one of its packages. When a convention lists no packages, it is always active.

• The entry points are globs relative to that package.json. They are files that the tool loads.
• The unused-packages rule counts the packages of a convention as used.
• Use the conventions option of the rules to switch conventions off or to select some of them.