@cookshack/eslint-config 4.0.0 → 5.0.0

package/AGENTS.md

@@ -0,0 +1,12 @@
+# AGENTS.md
+
+- `dist/` is gitignored and must be rebuilt after source changes: `npm run prepare` (runs husky + rollup)
+- Self-lint: `npm run check` (uses this config to lint itself)
+- Tests: `npm test` (mocha, `test/**/*.js`)
+- Pre-commit hook runs `npm run check && npm test`
+- Custom ESLint rules live in `plugins/` and are wired into the config via `index.js`
+- Each plugin has a corresponding test file in `test/rules/` with the same name
+- Tests use ESLint's `Linter` API directly; many test the print buffer output via `getPrintBuffer()`
+- `plugins/narrowest-scope.js` has extensive analysis docs in `A1.md` through `A7.md`
+- Rollup bundles `index.js` and `formatter.js` into `dist/` as both ESM (`.js`) and CJS (`.cjs`); `globals` is external
+- Package is ESM (`"type": "module"`) but ships dual format via the `exports` field

package/dist/index.cjs

@@ -482,10 +482,10 @@ var alwaysLetPlugin = { meta: { type: 'problem',
                   schema: [] },
           create: create$4 };
 
-let ostIdCounter, ost;
+let ostIdCounter, $lastOst;
 
 ostIdCounter = 0;
-ost = 0;
+$lastOst = 0;
 
 function trace$1
 (...args) {
@@ -506,11 +506,11 @@ function createInitBeforeUse
                buildScopeTree(scopeManager.scopes[0], '1', scopeToNode, astToTree);
 
                ostIdCounter = 0;
-               ost = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set());
+               $lastOst = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set());
 
-               ostAnnotate(ost, astToOst, context);
+               ostAnnotate($lastOst, astToOst, context);
 
-               ostCheck(ost, context);
+               ostCheck($lastOst, context);
              } }
 }
 
@@ -1101,6 +1101,7 @@ exports.rules = { 'array-bracket-newline': [ 'error', 'never' ],
           'no-negated-condition': 'error',
           'no-redeclare': 'error',
           'no-sequences': 'error',
+          'no-shadow': [ 'error', { builtinGlobals: true } ],
           'no-sparse-arrays': 'error',
           'no-tabs': 'error',
           'no-trailing-spaces': 'error',

package/dist/index.js

@@ -478,10 +478,10 @@ var alwaysLetPlugin = { meta: { type: 'problem',
                   schema: [] },
           create: create$4 };
 
-let ostIdCounter, ost;
+let ostIdCounter, $lastOst;
 
 ostIdCounter = 0;
-ost = 0;
+$lastOst = 0;
 
 function trace$1
 (...args) {
@@ -502,11 +502,11 @@ function createInitBeforeUse
                buildScopeTree(scopeManager.scopes[0], '1', scopeToNode, astToTree);
 
                ostIdCounter = 0;
-               ost = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set());
+               $lastOst = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set());
 
-               ostAnnotate(ost, astToOst, context);
+               ostAnnotate($lastOst, astToOst, context);
 
-               ostCheck(ost, context);
+               ostCheck($lastOst, context);
              } }
 }
 
@@ -1097,6 +1097,7 @@ rules = { 'array-bracket-newline': [ 'error', 'never' ],
           'no-negated-condition': 'error',
           'no-redeclare': 'error',
           'no-sequences': 'error',
+          'no-shadow': [ 'error', { builtinGlobals: true } ],
           'no-sparse-arrays': 'error',
           'no-tabs': 'error',
           'no-trailing-spaces': 'error',

package/index.js

@@ -67,6 +67,7 @@ rules = { 'array-bracket-newline': [ 'error', 'never' ],
           'no-negated-condition': 'error',
           'no-redeclare': 'error',
           'no-sequences': 'error',
+          'no-shadow': [ 'error', { builtinGlobals: true } ],
           'no-sparse-arrays': 'error',
           'no-tabs': 'error',
           'no-trailing-spaces': 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cookshack/eslint-config",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "ESLint config for Cookshack projects",
   "homepage": "https://git.sr.ht/~mattmundell/eslint-config",
   "type": "module",

package/plugins/init-before-use.js

@@ -1,10 +1,10 @@
 import { buildScopeTree } from './narrowest-scope.js'
 
-let ostIdCounter, errorCount, ost
+let ostIdCounter, errorCount, $lastOst
 
 ostIdCounter = 0
 errorCount = 0
-ost = 0
+$lastOst = 0
 
 function trace
 (...args) {
@@ -15,7 +15,7 @@ function trace
 export
 function lastOst
 () {
-  return ost
+  return $lastOst
 }
 
 function createInitBeforeUse
@@ -35,11 +35,11 @@ function createInitBeforeUse
                buildScopeTree(scopeManager.scopes[0], '1', scopeToNode, astToTree)
 
                ostIdCounter = 0
-               ost = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set())
+               $lastOst = processAst(context.sourceCode.ast, null, astToTree, astToOst, '', new Set())
 
-               ostAnnotate(ost, astToOst, context)
+               ostAnnotate($lastOst, astToOst, context)
 
-               ostCheck(ost, context)
+               ostCheck($lastOst, context)
 
                trace('ERRORS: ' + errorCount)
              } }

package/test/rules/no-shadow.js

@@ -0,0 +1,42 @@
+import { RuleTester } from 'eslint'
+import { Linter } from 'eslint'
+
+let ruleTester, validCases, invalidCases, rule
+
+rule = new Linter({ configType: 'eslintrc' }).getRules().get('no-shadow')
+ruleTester = new RuleTester()
+validCases = []
+invalidCases = []
+
+function pass
+(code) {
+  validCases.push({ code, options: [ { builtinGlobals: true } ] })
+}
+
+function fail
+(messageId, code) {
+  invalidCases.push({ code,
+                      options: [ { builtinGlobals: true } ],
+                      errors: [ { messageId } ] })
+}
+
+pass('var a = 3; function b() { var c = 10; }')
+pass('let x = 1; { let y = 2; }')
+pass('function a() { let x = 1 } function b() { let x = 2 }')
+pass('var a = 1; if (x) { var a = 2; }')
+
+fail('noShadow', 'var a = 3; function b() { var a = 10; }')
+fail('noShadow', 'let x = 1; { let x = 2; }')
+fail('noShadow', 'let a = 1; function foo(a) { return a }')
+fail('noShadow', 'function f(x) { function g() { let x = 2; } }')
+fail('noShadow', 'const a = 1; function foo() { const a = 2; }')
+fail('noShadow', 'let a = 1; if (x) { let a = 2; }')
+
+fail('noShadowGlobal', 'function foo() { let Object = 1; }')
+fail('noShadowGlobal', 'function foo() { let Array = []; }')
+
+globalThis.describe('no-shadow',
+                    () => ruleTester.run('no-shadow',
+                                         rule,
+                                         { valid: validCases,
+                                           invalid: invalidCases }))