Skip to content

Tools

The tools option enables integrations for standalone developer tooling that commonly interacts with source code or documentation.

ToolEnumUse It WhenAuto-Detected
PrettierTool.PrettierThe project uses Prettier and needs ESLint compatibility.No
CSpellTool.CspellThe project wants spell checking coverage.No
JSDocTool.JsdocThe project relies on JSDoc conventions.No
CommandTool.CommandThe project wants micro-fixes via magic comments (/// @keep, etc).No
DockerTool.DockerThe project has Docker Compose YAML files.Yes
GitHub ActionsTool.GithubActionsThe project has workflow files under .github/workflows.Yes
NxTool.NxThe project uses Nx workspace configuration.Yes
pnpmTool.PnpmThe project uses pnpm catalogs or workspace settings that should be enforced.No
SwaggerTool.SwaggerThe project uses Nest Swagger tooling.Yes
import { defineConfig, Tool } from '@santi020k/eslint-config-basic'
export default await defineConfig({
tools: [Tool.Prettier, Tool.Cspell, Tool.GithubActions, Tool.Docker, Tool.Nx]
})
  • Prettier is intentionally applied last in the final config array.
  • GitHub Actions and Docker Compose build on the YAML integration.
  • Nx builds on the JSON/JSONC integration for nx.json and project.json.
  • pnpm enforces catalogs and workspace settings in package.json and pnpm-workspace.yaml via eslint-plugin-pnpm.
  • Swagger is automatically detected when the project includes @nestjs/swagger.

Did this page help?

One click helps us spot documentation that needs another pass. No personal data is sent.