@zoldytech/javascript

A general-purpose ESLint house style, built on @antfu/eslint-config and made SonarQube-compatible: local ESLint mirrors what the SonarQube gate flags, so you fix Sonar issues before they reach CI. Five stack presets — plain JS/TS, React + Vite, React Native, Next.js, NestJS.

• antfu foundation — TypeScript, imports, unicorn, node, jsonc/yaml/markdown, sensible modern defaults, one --fix.
• SonarQube layer on top — the full eslint-plugin-sonarjs recommended set, cognitive complexity capped at 15, plus unicorn/core rules mapped to the SonarQube S-codes sonarjs doesn't ship (S7781, S7763, S6606, S7735, …). Appended after antfu so it wins on conflicts.
• Prettier owns formatting (stylistic: false + eslint-config-prettier). Formatting is a separable layer — swapping to another formatter later doesn't touch the rules.
• Also ships a shared Prettier config and TypeScript base configs.

Requirements

• ESLint 10.4+ (peer eslint >=10.4). The antfu foundation bundles eslint-plugin-unicorn@68, which requires ESLint ≥ 10.4 — so this is a hard floor for a clean install (including pnpm/yarn and npm --strict-peer-deps).
• Node ^22.13 || >=24 (antfu's plugins require Node ≥ 22).
• TypeScript ≥ 5 (peer).
• Prettier — you install it; it owns formatting (this package ships the shared config, not Prettier itself). See Prettier.

Install

Distributed via GitHub URL, pinned to a tag (no build step runs on install — raw ESM):

npm i -D "github:zoldytech/javascript#0.1.2"

Usage

Each preset is a function that returns an antfu FlatConfigComposer. Use it as the default export of your eslint.config.mjs (no array spread needed) — pass project ignores and extra config blocks as options:

// eslint.config.mjs — Next.js
import { next } from '@zoldytech/javascript/eslint';

export default next({
  typeChecked: true,
  ignores: ['.next/**', 'coverage/**'],
});

// NestJS (typeChecked defaults to true)
import { nest } from '@zoldytech/javascript/eslint';
export default nest({ tsconfigPath: 'tsconfig.json' });

// React + Vite
import { react } from '@zoldytech/javascript/eslint';
export default react();

// React Native
import { reactNative } from '@zoldytech/javascript/eslint';
export default reactNative();

// plain JS/TS
import { base } from '@zoldytech/javascript/eslint';
export default base();

Subpaths also work directly: @zoldytech/javascript/eslint/next, /eslint/base, etc.

Options

Every preset accepts the same options (all optional):

Option	Default	Purpose
typeChecked	false (true for nest)	Enable antfu type-aware linting (activates the ~68 type-checking sonarjs rules). Needs tsconfigPath.
tsconfigPath	'tsconfig.json'	tsconfig for type-aware linting (resolved from where you run ESLint).
tsdoc	false	Enable the tsdoc/syntax gate on TS files.
ignores	[]	Project ignore globs (forwarded to antfu).
testGlobs	test/spec/config globs	Override where a subset of sonarjs rules is relaxed.
overrides	[]	Extra flat-config blocks, appended last so they win.
antfuOptions	{}	Extra options merged straight into the underlying antfu() call.

Type-aware linting needs a tsconfig that includes the files being linted. A .ts file outside that tsconfig aborts the run with a projectService error — this is inherent to type-aware linting, so keep the tsconfig's include/exclude in sync with what ESLint lints.

Prettier

Point Prettier at the shared config in package.json:

{ "prettier": "@zoldytech/javascript/prettier" }

ESLint owns code quality; Prettier owns formatting. The presets set antfu stylistic: false and include eslint-config-prettier, so the two never fight.

TypeScript

Extend the matching base in tsconfig.json:

{
  "extends": "@zoldytech/javascript/tsconfig/next.json",
  "compilerOptions": { "paths": { "@/*": ["./src/*"] } },
  "include": ["src"]
}

Available: tsconfig/base.json, /react.json, /react-native.json, /next.json, /nest.json (framework ones extend base).

The base goes beyond strict. Most notably it sets noUncheckedIndexedAccess, which strict does not enable: it makes arr[i] and record[key] honestly T | undefined. Without it, TypeScript types this as non-nullable and the bug ships:

const [row] = await db.insert(project).values(input).returning({ id: project.id });
return row.id; // `row` is `T | undefined` at runtime; without the flag TS says it is always `T`

Expect to add real guards when you first adopt it — that is the flag doing its job. Also on: noUnusedLocals, noUnusedParameters, noImplicitReturns, noFallthroughCasesInSwitch, verbatimModuleSyntax, isolatedModules, forceConsistentCasingInFileNames.

Git hooks (recommended, not shipped)

This package ships no hooks. Wire the recommended pipeline in your own repo:

// package.json
{
  "scripts": { "prepare": "husky" },
  "lint-staged": {
    "*.{ts,tsx,js,jsx,mjs,cjs}": ["eslint --fix --max-warnings=0", "prettier --write"],
    "*.{css,json,md,yml,yaml}": ["prettier --write"],
  },
}

# .husky/pre-commit
npx lint-staged

To adopt this style in an existing project without failing on pre-existing issues, baseline them with ESLint's native bulk suppressions: eslint --suppress-all writes eslint-suppressions.json, and CI runs eslint . --pass-on-unpruned-suppressions so only new violations fail.

Notes

• Rule namespaces follow antfu's short names: ts/* (typescript-eslint), react/* (@eslint-react, which also provides react/exhaustive-deps / react/rules-of-hooks), import/*, unicorn/*, next/* (@next/eslint-plugin-next). The next preset uses @next/eslint-plugin-next directly (no eslint-config-next, no next package needed).
• no-console bans all console.* (SonarQube S106), overriding antfu's warn/error allowance.
• First eslint --fix reorders imports — antfu's perfectionist rules sort imports and named members. Expect a one-time formatting diff when a project first adopts the style.
• React Native — reactNative gives full SonarQube/React parity plus the RN runtime globals (__DEV__, Hermes), and works for react-native-web universal codebases with no extra config (its tsconfig/react-native.json keeps the DOM lib for the web target). The RN-idiom style rules (no-inline-styles, no-color-literals, …) are deferred: their only source, eslint-plugin-react-native, crashes on ESLint 10. See docs/react-native.md for the react-native-web notes and the tracked upgrade path.

Development

npm install     # clean install, no flags
npm run lint    # dogfoods the base preset on this repo
npm test        # E2E: each preset lints its fixture app (node --test)

CI runs the suite on ESLint 10 across Node 22/24.

License

MIT