Tools
The tools option enables integrations for standalone developer tooling that commonly interacts with source code or documentation.
| Tool | Enum | Use It When | Auto-Detected |
|---|---|---|---|
| Prettier | Tool.Prettier | The project uses Prettier and needs ESLint compatibility. | No |
| CSpell | Tool.Cspell | The project wants spell checking coverage. | No |
| JSDoc | Tool.Jsdoc | The project relies on JSDoc conventions. | No |
| Command | Tool.Command | The project wants micro-fixes via magic comments (/// @keep, etc). | No |
| Docker | Tool.Docker | The project has Docker Compose YAML files. | Yes |
| GitHub Actions | Tool.GithubActions | The project has workflow files under .github/workflows. | Yes |
| Nx | Tool.Nx | The project uses Nx workspace configuration. | Yes |
| pnpm | Tool.Pnpm | The project uses pnpm catalogs or workspace settings that should be enforced. | No |
| Swagger | Tool.Swagger | The project uses Nest Swagger tooling. | Yes |
Example
Section titled “Example”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.jsonandproject.json. - pnpm enforces catalogs and workspace settings in
package.jsonandpnpm-workspace.yamlviaeslint-plugin-pnpm. - Swagger is automatically detected when the project includes
@nestjs/swagger.
Repository Examples
Section titled “Repository Examples”- Tool Playgrounds: packages/playground/tools
- Integrations Package Source: packages/integrations
Did this page help?
One click helps us spot documentation that needs another pass. No personal data is sent.