@creo-team/eslint-config 2.3.9 → 2.4.1

package/README.md

@@ -49,29 +49,45 @@ module.exports = createConfig({
 Multiple packages (e.g. `app/`, `lib/`, `infra/`), each with its own `tsconfig.json`. Use **projectService** so type-aware rules resolve the nearest tsconfig per file. One `eslint.config.js` at the repo root; run `eslint .` from the root.
 
 ```javascript
-// eslint.config.js at monorepo root
 const { createConfig } = require('@creo-team/eslint-config')
 
 module.exports = createConfig({
-  ignores: ['**/node_modules/**', '**/dist/**', '**/.next/**', '**/build/**'],
+  ignores: [
+    '**/node_modules/**',
+    '**/dist/**',
+    '**/.next/**',
+    '**/build/**',
+    '**/out/**',
+    '**/cdk.out/**',
+    '**/*.config.js',
+    '**/*.config.mjs',
+    '**/*.config.ts',
+  ],
   projectService: true,
 })
 ```
 
-Ensure each package that contains TypeScript has a `tsconfig.json` (or `tsconfig.eslint.json`) in that directory. No `tsconfig.eslint.json` at root is required. See [typescript-eslint project service](https://typescript-eslint.io/blog/project-service).
-
-**Root `package.json` scripts** (e.g. npm workspaces):
+**Root `package.json`** (npm workspaces):
 
 ```json
 {
+  "workspaces": ["nextjs", "aws/infra", "shared"],
   "scripts": {
     "lint": "eslint .",
     "fix": "eslint . --fix"
+  },
+  "devDependencies": {
+    "@creo-team/eslint-config": "^2.4.1",
+    "eslint": "^9.39.3"
   }
 }
 ```
 
-### 4. Monorepo — per-workspace config (e.g. Vecta-style)
+**Requirements:** Each package with TypeScript has a `tsconfig.json` in that directory. No root tsconfig required. See [typescript-eslint project service](https://typescript-eslint.io/blog/project-service).
+
+**Example:** See `examples/monorepo/` in this repo. Run `cd examples/monorepo && npm install && npm run lint` to validate.
+
+### 4. Monorepo — per-workspace config
 
 Lint is run **per workspace** (`npm run lint -w nextjs`). Each workspace has its own `eslint.config.js` and its own `tsconfig`. Use the default preset (no `projectService`); the config runs with that workspace as cwd, so `getTsConfigFile()` finds that package’s tsconfig.
 
@@ -106,6 +122,76 @@ const base = require('@creo-team/eslint-config')
 module.exports = [...base, { rules: { 'no-console': 'warn' } }]
 ```
 
+### Customizing rules
+
+Override any rule by spreading the base config and adding your own. Common customizations:
+
+**1. Naming convention — allow UPPER_SNAKE for constants**
+
+Default: `camelCase` for variables, `PascalCase` for types. To allow `UPPER_SNAKE` for constants:
+
+```javascript
+const { createConfig } = require('@creo-team/eslint-config')
+
+const base = createConfig()
+
+module.exports = [
+  ...base,
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    rules: {
+      '@typescript-eslint/naming-convention': [
+        'error',
+        { format: ['camelCase'], selector: 'default' },
+        { format: ['camelCase', 'PascalCase'], selector: 'import' },
+        { format: ['camelCase', 'PascalCase', 'UPPER_CASE'], selector: 'variable' },
+        { format: ['PascalCase'], selector: 'typeLike' },
+        { format: ['PascalCase'], selector: 'enumMember' },
+      ],
+    },
+  },
+]
+```
+
+**2. File naming — enforce kebab-case for `.ts` / `.tsx` files**
+
+Install [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn), then add:
+
+```javascript
+const { createConfig } = require('@creo-team/eslint-config')
+const unicorn = require('eslint-plugin-unicorn')
+
+const base = createConfig()
+
+module.exports = [
+  ...base,
+  {
+    plugins: { unicorn },
+    rules: {
+      'unicorn/filename-case': ['error', { case: 'kebabCase' }],
+    },
+  },
+]
+```
+
+**3. Relax JSDoc or no-magic-numbers**
+
+```javascript
+const { createConfig } = require('@creo-team/eslint-config')
+
+module.exports = [
+  ...createConfig(),
+  {
+    rules: {
+      'jsdoc/require-jsdoc': 'off',
+      'no-magic-numbers': 'off',
+    },
+  },
+]
+```
+
+**Examples:** See `examples/rule-overrides/` for working configs and tests.
+
 ## Why this config
 
 **Predictable, reviewable code.** The rules are chosen so that style is decided once (Prettier + stylistic), intent is documented (JSDoc), and structure stays within bounds (complexity, line limits, no magic numbers). That reduces pointless formatting debates and makes diffs easier to read.
@@ -139,7 +225,11 @@ For folder/file structure enforcement, add [eslint-plugin-project-structure](htt
 
 ## Release flow
 
-Trunk-based. Bump `version` in `package.json`, push `main` → `github-release` creates tag → `npm-publish` publishes. OIDC, no tokens. Release runs only when `package.json` changes.
+Trunk-based. Bump `version` in `package.json`, push `main` → `github-release` creates tag + GitHub Release → `npm-publish` publishes to npm. OIDC Trusted Publishing, no tokens.
+
+## Examples
+
+- **Monorepo:** `examples/monorepo/` — root config with `projectService`, npm workspaces. See [examples/README.md](./examples/README.md).
 
 ## Development
 

package/dist/eslint.config.js

@@ -64,6 +64,6 @@ function createConfig(options = {}) {
         },
     });
 }
-module.exports = createConfig();
+module.exports = createConfig({ ignores: ['dist/**', 'test/**', 'examples/**'] });
 module.exports.createConfig = createConfig;
 //# sourceMappingURL=eslint.config.js.map

package/dist/eslint.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"eslint.config.js","sourceRoot":"","sources":["../eslint.config.js"],"names":[],"mappings":";AAEA,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AACpC,MAAM,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAA;AAC3D,MAAM,YAAY,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;AACpD,MAAM,KAAK,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAA;AAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAA;AAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAE7C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AACvC,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AAEjD,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAW9C,SAAS,YAAY,CAAC,OAAO,GAAG,EAAE;IACjC,MAAM,EAAE,OAAO,GAAG,eAAe,EAAE,cAAc,GAAG,KAAK,EAAE,QAAQ,GAAG,eAAe,EAAE,EAAE,GAAG,OAAO,CAAA;IAEnG,MAAM,aAAa,GAAG,cAAc;QACnC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE;QACrD,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,CAAA;IAEnD,OAAO,QAAQ,CAAC,MAAM,CACrB,EAAE,OAAO,EAAE,EACX,MAAM,CAAC,OAAO,CAAC,WAAW,EAC1B,GAAG,QAAQ,CAAC,OAAO,CAAC,sBAAsB,EAC1C,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,EACxC,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EACrC,aAAa,CAAC,OAAO,CAAC,0BAA0B,CAAC,EACjD;QACC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;QACxB,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB;KACtC,EACD;QACC,eAAe,EAAE;YAChB,OAAO,EAAE;gBACR,OAAO,EAAE,UAAU;gBACnB,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE,UAAU;aACnB;YACD,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,aAAa;SACb;QACD,OAAO,EAAE;YACR,YAAY,EAAE,eAAe;YAC7B,MAAM,EAAE,YAAY;YACpB,KAAK;YACL,QAAQ;SACR;QACD,KAAK,EAAE;YACN,GAAG,KAAK;YACR,sCAAsC,EAAE,KAAK;SAC7C;QACD,QAAQ,EAAE;YACT,iBAAiB,EAAE;gBAClB,UAAU,EAAE,EAAE;aACd;SACD;KACD,EACD;QACC,KAAK,EAAE,CAAC,UAAU,CAAC;QACnB,eAAe,EAAE;YAChB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,aAAa;SACb;QACD,KAAK,EAAE;YACN,GAAG,KAAK;YACR,sCAAsC,EAAE;gBACvC,OAAO;gBACP,EAAE,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE;gBAC9C,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE;gBAC3D,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE;gBAC7D,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE;gBAChD,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;aAClD;YACD,sCAAsC,EAAE,KAAK;YAC7C,qCAAqC,EAAE,KAAK;SAC5C;KACD,CACD,CAAA;AACF,CAAC;AAED,MAAM,CAAC,OAAO,GAAG,YAAY,EAAE,CAAA;AAC/B,MAAM,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAA"}
+{"version":3,"file":"eslint.config.js","sourceRoot":"","sources":["../eslint.config.js"],"names":[],"mappings":";AAEA,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AACpC,MAAM,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAA;AAC3D,MAAM,YAAY,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;AACpD,MAAM,KAAK,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAA;AAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAA;AAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAE7C,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AACvC,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;AAEjD,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAW9C,SAAS,YAAY,CAAC,OAAO,GAAG,EAAE;IACjC,MAAM,EAAE,OAAO,GAAG,eAAe,EAAE,cAAc,GAAG,KAAK,EAAE,QAAQ,GAAG,eAAe,EAAE,EAAE,GAAG,OAAO,CAAA;IAEnG,MAAM,aAAa,GAAG,cAAc;QACnC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE;QACrD,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,CAAA;IAEnD,OAAO,QAAQ,CAAC,MAAM,CACrB,EAAE,OAAO,EAAE,EACX,MAAM,CAAC,OAAO,CAAC,WAAW,EAC1B,GAAG,QAAQ,CAAC,OAAO,CAAC,sBAAsB,EAC1C,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,EACxC,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EACrC,aAAa,CAAC,OAAO,CAAC,0BAA0B,CAAC,EACjD;QACC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;QACxB,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB;KACtC,EACD;QACC,eAAe,EAAE;YAChB,OAAO,EAAE;gBACR,OAAO,EAAE,UAAU;gBACnB,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE,UAAU;aACnB;YACD,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,aAAa;SACb;QACD,OAAO,EAAE;YACR,YAAY,EAAE,eAAe;YAC7B,MAAM,EAAE,YAAY;YACpB,KAAK;YACL,QAAQ;SACR;QACD,KAAK,EAAE;YACN,GAAG,KAAK;YACR,sCAAsC,EAAE,KAAK;SAC7C;QACD,QAAQ,EAAE;YACT,iBAAiB,EAAE;gBAClB,UAAU,EAAE,EAAE;aACd;SACD;KACD,EACD;QACC,KAAK,EAAE,CAAC,UAAU,CAAC;QACnB,eAAe,EAAE;YAChB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,aAAa;SACb;QACD,KAAK,EAAE;YACN,GAAG,KAAK;YACR,sCAAsC,EAAE;gBACvC,OAAO;gBACP,EAAE,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE;gBAC9C,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE;gBAC3D,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE;gBAC7D,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE;gBAChD,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;aAClD;YACD,sCAAsC,EAAE,KAAK;YAC7C,qCAAqC,EAAE,KAAK;SAC5C;KACD,CACD,CAAA;AACF,CAAC;AAED,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,CAAA;AACjF,MAAM,CAAC,OAAO,CAAC,YAAY,GAAG,YAAY,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creo-team/eslint-config",
-  "version": "2.3.9",
+  "version": "2.4.1",
   "description": "ESLint flat config: TypeScript (strict), Prettier, JSDoc, complexity, no-magic-numbers. createConfig() for options.",
   "author": "Colten Krauter <coltenkrauter>",
   "main": "dist/eslint.config.js",