@blumintinc/eslint-plugin-blumint 1.21.5 → 1.21.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.js CHANGED
@@ -224,7 +224,7 @@ function noFrontendImportsFromFunctionsPatterns(pattern) {
224
224
  module.exports = {
225
225
  meta: {
226
226
  name: '@blumintinc/eslint-plugin-blumint',
227
- version: '1.21.5',
227
+ version: '1.21.6',
228
228
  },
229
229
  parseOptions: {
230
230
  ecmaVersion: 2020,
@@ -306,16 +306,86 @@ const isWriteTarget = (node) => {
306
306
  }
307
307
  };
308
308
  /**
309
- * Whether the binding is written through anywhere in the file. Answered from
310
- * the scope manager's reference list rather than a textual search for the
311
- * name, so a same-named binding in another scope (`const arr` shadowed inside a
312
- * callback) contributes nothing, and a same-named method on an unrelated
313
- * receiver (`other.push(1)`) is never even visited.
309
+ * The declarator a reference initializes IN WHOLE — `OTHER` in
310
+ * `const OTHER = ITEMS` — or null for every other position. Such a declaration
311
+ * introduces a second name for one value, so whatever is done to that name is
312
+ * done to this binding.
313
+ *
314
+ * Type wrappers are climbed because they annotate a value without replacing it:
315
+ * `const OTHER = ITEMS!` and `const OTHER = ITEMS satisfies T` denote the same
316
+ * array as the bare form, and each breaks the same way once it is frozen. A
317
+ * cast that erases the element type (`ITEMS as any`) is climbed on the same
318
+ * terms, which withholds the assertion from a mutation the compiler would have
319
+ * tolerated — staying silent is the cheap error here, emitting a fix that stops
320
+ * the file compiling is not.
321
+ *
322
+ * A reference that is only PART of an initializer builds a fresh value rather
323
+ * than aliasing this one (`const COPY = [...ITEMS]`), and a destructuring id
324
+ * extracts a member rather than the whole, so neither is an alias here.
314
325
  */
315
- const isBindingMutated = (variable) => variable.references.some((reference) => {
316
- const path = accessPathOf(reference.identifier);
317
- return path !== null && (isMutatingMethodCall(path) || isWriteTarget(path));
318
- });
326
+ const aliasDeclaratorOf = (identifier) => {
327
+ const value = outermostValueOf(identifier);
328
+ const declarator = value.parent;
329
+ if (declarator?.type !== utils_1.AST_NODE_TYPES.VariableDeclarator ||
330
+ declarator.init !== value ||
331
+ declarator.id.type !== utils_1.AST_NODE_TYPES.Identifier) {
332
+ return null;
333
+ }
334
+ return declarator;
335
+ };
336
+ /**
337
+ * Whether the binding is written through anywhere in the file, under its own
338
+ * name or through an alias of it. Answered from the scope manager's reference
339
+ * list rather than a textual search for the name, so a same-named binding in
340
+ * another scope (`const arr` shadowed inside a callback) contributes nothing,
341
+ * and a same-named method on an unrelated receiver (`other.push(1)`) is never
342
+ * even visited.
343
+ *
344
+ * The walk follows aliases because a binding's own reference list is not where
345
+ * a mutation through one is recorded: in
346
+ * `const OTHER = ITEMS; OTHER.push(3);` the mutating call references `OTHER`, a
347
+ * separate variable this one never enrols, and reading only `ITEMS`'s
348
+ * references sees a plain read. Appending `as const` there emits TS2339 for an
349
+ * input that compiled (Issue #2324). Following is transitive — every hop names
350
+ * the one value — and `visited` keeps a chain that leads back on itself, which
351
+ * a redeclared `var` can build, from looping forever.
352
+ *
353
+ * The declaring KEYWORD is deliberately not screened. `as const` types the
354
+ * value `readonly`, and a binding takes its declared type from its initializer,
355
+ * so `let other = ITEMS; other.push(3);` is the same TS2339 as the `const`
356
+ * spelling; reassigning such a `let` does not recover mutability either,
357
+ * because the reassignment is then rejected against that same frozen type. A
358
+ * check keyed on `const` would leave the `let` spelling breaking builds under
359
+ * `--fix`.
360
+ */
361
+ const isBindingMutated = (variable, declaredVariablesOf) => {
362
+ // Grown in place and walked by index: an alias found mid-walk is appended and
363
+ // reached by the same loop, so the traversal needs no recursion of its own.
364
+ const pending = [variable];
365
+ const visited = new Set(pending);
366
+ for (let index = 0; index < pending.length; index += 1) {
367
+ for (const reference of pending[index].references) {
368
+ const path = accessPathOf(reference.identifier);
369
+ if (path !== null) {
370
+ if (isMutatingMethodCall(path) || isWriteTarget(path)) {
371
+ return true;
372
+ }
373
+ continue;
374
+ }
375
+ const declarator = aliasDeclaratorOf(reference.identifier);
376
+ if (!declarator) {
377
+ continue;
378
+ }
379
+ for (const alias of declaredVariablesOf(declarator)) {
380
+ if (!visited.has(alias)) {
381
+ visited.add(alias);
382
+ pending.push(alias);
383
+ }
384
+ }
385
+ }
386
+ }
387
+ return false;
388
+ };
319
389
  /**
320
390
  * Walks the scope chain upward from `scope` (inclusive) and reports whether
321
391
  * `targetName` is bound anywhere between `scope` and `stopScope` (inclusive).
@@ -531,6 +601,14 @@ exports.default = (0, createRule_1.createRule)({
531
601
  return (target.type === utils_1.AST_NODE_TYPES.Identifier &&
532
602
  !PRIMITIVE_VALUE_GLOBALS.has(target.name));
533
603
  };
604
+ /**
605
+ * The bindings a declaration node introduces, as the scope manager records
606
+ * them. The mutation walk resolves an alias declarator through this rather
607
+ * than looking its name up the scope chain: the scope manager already holds
608
+ * the exact answer, while a name lookup would have to guess which scope a
609
+ * `var` was hoisted into.
610
+ */
611
+ const declaredVariablesOf = (node) => context.getDeclaredVariables(node);
534
612
  const describeValueKind = (node) => {
535
613
  const target = unwrapValueWrappers(node);
536
614
  if (target.type === utils_1.AST_NODE_TYPES.ArrayExpression) {
@@ -722,7 +800,8 @@ exports.default = (0, createRule_1.createRule)({
722
800
  const declaredVariable = context
723
801
  .getDeclaredVariables(declaration)
724
802
  .find((variable) => variable.name === name);
725
- return !declaredVariable || !isBindingMutated(declaredVariable);
803
+ return (!declaredVariable ||
804
+ !isBindingMutated(declaredVariable, declaredVariablesOf));
726
805
  };
727
806
  if (shouldHaveAsConst(init)) {
728
807
  context.report({
@@ -1 +1,2 @@
1
- export declare const noTryCatchAlreadyExistsInTransaction: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"noAlreadyExistsCatchInTransaction", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
1
+ import { TSESLint } from '@typescript-eslint/utils';
2
+ export declare const noTryCatchAlreadyExistsInTransaction: TSESLint.RuleModule<"noAlreadyExistsCatchInTransaction", [], TSESLint.RuleListener>;
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.noTryCatchAlreadyExistsInTransaction = void 0;
4
4
  const utils_1 = require("@typescript-eslint/utils");
5
+ const ASTHelpers_1 = require("../utils/ASTHelpers");
5
6
  const createRule_1 = require("../utils/createRule");
6
7
  const ALREADY_EXISTS_STRINGS = new Set(['already-exists', 'ALREADY_EXISTS']);
7
8
  const ALREADY_EXISTS_NUMBERS = new Set([6, '6']);
@@ -24,6 +25,118 @@ function isRunTransactionCall(node) {
24
25
  }
25
26
  return false;
26
27
  }
28
+ /**
29
+ * The package surfaces whose `runTransaction` is the Firestore one.
30
+ *
31
+ * The bare name is not unique to Firestore: `firebase/database` exports a
32
+ * `runTransaction` for the Realtime Database, which re-applies its update
33
+ * function locally on conflict and carries no gRPC status codes, so
34
+ * `ALREADY_EXISTS` is not part of its error model and neither remedy this rule
35
+ * offers exists there — `runCreateForgivenessTransaction` is backend-Firestore
36
+ * only. Reporting an RTDB transaction leaves a developer with no way to comply.
37
+ */
38
+ const FIRESTORE_MODULE_ROOTS = [
39
+ { packageSegments: ['firebase'], product: 'firestore' },
40
+ { packageSegments: ['firebase-admin'], product: 'firestore' },
41
+ { packageSegments: ['@firebase'], product: 'firestore' },
42
+ { packageSegments: ['@google-cloud'], product: 'firestore' },
43
+ ];
44
+ /**
45
+ * Split a module source into path segments with any version suffix dropped, so
46
+ * a pinned specifier (`firebase@10/firestore`) reduces to the same root as the
47
+ * plain one. A `@` at the start of a segment marks a scope, not a version.
48
+ */
49
+ function moduleSegments(source) {
50
+ return source.split('/').map((segment) => {
51
+ const versionIndex = segment.indexOf('@', 1);
52
+ return versionIndex === -1 ? segment : segment.slice(0, versionIndex);
53
+ });
54
+ }
55
+ /**
56
+ * Match the package root structurally rather than against one spelling: a deep
57
+ * entry point (`firebase/firestore/lite`), a build variant
58
+ * (`@firebase/firestore-compat`) and a pinned version all name the same
59
+ * product, and a trailing segment must not defeat the check.
60
+ */
61
+ function isFirestoreModuleSource(source) {
62
+ const segments = moduleSegments(source);
63
+ return FIRESTORE_MODULE_ROOTS.some(({ packageSegments, product }) => {
64
+ if (!packageSegments.every((segment, index) => segments[index] === segment)) {
65
+ return false;
66
+ }
67
+ const productSegment = segments[packageSegments.length];
68
+ return (productSegment === product || !!productSegment?.startsWith(`${product}-`));
69
+ });
70
+ }
71
+ /**
72
+ * The module `name` is imported from, or null when the file declares the name
73
+ * itself (a local helper, a parameter) or nothing declares it at all.
74
+ */
75
+ function importedSourceOf(scope, name) {
76
+ const variable = ASTHelpers_1.ASTHelpers.findVariableInScope(scope, name);
77
+ if (!variable) {
78
+ return null;
79
+ }
80
+ for (const def of variable.defs) {
81
+ const specifier = def.node;
82
+ if (specifier.type !== utils_1.AST_NODE_TYPES.ImportSpecifier &&
83
+ specifier.type !== utils_1.AST_NODE_TYPES.ImportDefaultSpecifier &&
84
+ specifier.type !== utils_1.AST_NODE_TYPES.ImportNamespaceSpecifier) {
85
+ continue;
86
+ }
87
+ const declaration = specifier.parent;
88
+ if (declaration?.type !== utils_1.AST_NODE_TYPES.ImportDeclaration ||
89
+ typeof declaration.source.value !== 'string') {
90
+ continue;
91
+ }
92
+ return declaration.source.value;
93
+ }
94
+ return null;
95
+ }
96
+ /**
97
+ * The identifier whose binding carries the call's provenance: the callee for
98
+ * `runTransaction(...)`, and the root of the member chain for
99
+ * `database.runTransaction(...)`, since the receiver is what an import names
100
+ * and the property alone matches every `<anything>.runTransaction`.
101
+ */
102
+ function provenanceIdentifier(callee) {
103
+ if (callee.type === utils_1.AST_NODE_TYPES.Identifier) {
104
+ return callee;
105
+ }
106
+ let current = callee;
107
+ while (current.type === utils_1.AST_NODE_TYPES.MemberExpression ||
108
+ current.type === utils_1.AST_NODE_TYPES.ChainExpression ||
109
+ current.type === utils_1.AST_NODE_TYPES.TSNonNullExpression) {
110
+ current =
111
+ current.type === utils_1.AST_NODE_TYPES.MemberExpression
112
+ ? current.object
113
+ : current.expression;
114
+ }
115
+ return current.type === utils_1.AST_NODE_TYPES.Identifier ? current : null;
116
+ }
117
+ /**
118
+ * Whether a `runTransaction` call is the Firestore one this rule speaks about.
119
+ *
120
+ * The gate speaks only when it knows: a binding that resolves to an import is
121
+ * judged by its module source, and anything else — a bare call, a parameter, a
122
+ * local helper, a member call on an unresolvable receiver — keeps the rule's
123
+ * posture of reporting, since a name with no traceable origin is far more often
124
+ * Firestore (`db.runTransaction(...)`) than not.
125
+ */
126
+ function isFirestoreTransactionCall(node, context) {
127
+ if (!isRunTransactionCall(node)) {
128
+ return false;
129
+ }
130
+ const carrier = provenanceIdentifier(unwrapChainExpression(node.callee));
131
+ if (!carrier) {
132
+ return true;
133
+ }
134
+ const source = importedSourceOf(ASTHelpers_1.ASTHelpers.getScope(context, node), carrier.name);
135
+ if (source === null) {
136
+ return true;
137
+ }
138
+ return isFirestoreModuleSource(source);
139
+ }
27
140
  function getCallbackArgument(args) {
28
141
  for (const arg of args) {
29
142
  if (arg.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
@@ -301,7 +414,7 @@ exports.noTryCatchAlreadyExistsInTransaction = (0, createRule_1.createRule)({
301
414
  }
302
415
  return {
303
416
  CallExpression(node) {
304
- if (!isRunTransactionCall(node)) {
417
+ if (!isFirestoreTransactionCall(node, context)) {
305
418
  return;
306
419
  }
307
420
  const callback = getCallbackArgument(node.arguments);
@@ -310,7 +423,7 @@ exports.noTryCatchAlreadyExistsInTransaction = (0, createRule_1.createRule)({
310
423
  }
311
424
  },
312
425
  'CallExpression:exit'(node) {
313
- if (!isRunTransactionCall(node)) {
426
+ if (!isFirestoreTransactionCall(node, context)) {
314
427
  return;
315
428
  }
316
429
  const callback = getCallbackArgument(node.arguments);
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.preferSxPropOverSystemProps = void 0;
4
4
  const utils_1 = require("@typescript-eslint/utils");
5
+ const ASTHelpers_1 = require("../utils/ASTHelpers");
5
6
  const createRule_1 = require("../utils/createRule");
6
7
  /**
7
8
  * Matches Prettier's own default. The autofix rewrites JSX that a formatter
@@ -111,7 +112,12 @@ const MUI_SYSTEM_PROPS = new Set([
111
112
  'textTransform',
112
113
  ]);
113
114
  /**
114
- * Default MUI component names to check. The user can extend this via options.
115
+ * The MUI components this rule covers.
116
+ *
117
+ * The list narrows what provenance has already selected: an element is
118
+ * inspected only when it resolves to an `@mui/*` import AND names one of these,
119
+ * so a name here can never be the whole reason an element is rewritten. The
120
+ * `components` option replaces the list.
115
121
  */
116
122
  const DEFAULT_MUI_COMPONENTS = new Set([
117
123
  'Box',
@@ -229,6 +235,78 @@ function isUpperCase(name) {
229
235
  name[0] === name[0].toUpperCase() &&
230
236
  name[0] !== name[0].toLowerCase());
231
237
  }
238
+ /**
239
+ * The package namespace every MUI distribution publishes under: `@mui/material`,
240
+ * `@mui/joy`, `@mui/system`, `@mui/lab` and their deep entry points
241
+ * (`@mui/material/Box`).
242
+ */
243
+ const MUI_PACKAGE_PREFIX = '@mui/';
244
+ const isMuiSource = (source) => source.startsWith(MUI_PACKAGE_PREFIX);
245
+ /**
246
+ * The import that introduces `name`, or null when the file declares it itself
247
+ * (a local component, a parameter) or nothing declares it at all.
248
+ */
249
+ function importBindingOf(scope, name) {
250
+ const variable = ASTHelpers_1.ASTHelpers.findVariableInScope(scope, name);
251
+ if (!variable) {
252
+ return null;
253
+ }
254
+ for (const def of variable.defs) {
255
+ const specifier = def.node;
256
+ if (specifier.type !== utils_1.AST_NODE_TYPES.ImportSpecifier &&
257
+ specifier.type !== utils_1.AST_NODE_TYPES.ImportDefaultSpecifier &&
258
+ specifier.type !== utils_1.AST_NODE_TYPES.ImportNamespaceSpecifier) {
259
+ continue;
260
+ }
261
+ const declaration = specifier.parent;
262
+ if (declaration?.type !== utils_1.AST_NODE_TYPES.ImportDeclaration ||
263
+ typeof declaration.source.value !== 'string') {
264
+ continue;
265
+ }
266
+ return {
267
+ source: declaration.source.value,
268
+ // A default or namespace import has no exported name to read, so the
269
+ // local name is the only thing that names the component.
270
+ exportedName: specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier
271
+ ? specifier.imported.name
272
+ : name,
273
+ };
274
+ }
275
+ return null;
276
+ }
277
+ /**
278
+ * The MUI export a JSX element names, or null when the element does not come
279
+ * from MUI.
280
+ *
281
+ * Provenance, not spelling, is what makes an element MUI: `Box`, `Button`,
282
+ * `Card` and `Avatar` are ordinary words that design systems, third-party
283
+ * packages and first-party wrappers use too, and this rule ships a fixer that
284
+ * moves props into an `sx` slot a non-MUI component has no reading for. On a
285
+ * wrapper forwarding `width`/`height` to an `<img>`, that rewrite type-checks,
286
+ * lints clean and silently drops the attributes.
287
+ *
288
+ * `<Ns.Box>` resolves through `Ns`, the namespace: the object carries the
289
+ * provenance, so reading the property alone matches every `<Anything.Box>`.
290
+ */
291
+ function muiExportOf(node, scope) {
292
+ const { name } = node;
293
+ if (name.type === utils_1.AST_NODE_TYPES.JSXIdentifier) {
294
+ const binding = importBindingOf(scope, name.name);
295
+ return binding && isMuiSource(binding.source) ? binding.exportedName : null;
296
+ }
297
+ if (name.type === utils_1.AST_NODE_TYPES.JSXMemberExpression) {
298
+ let object = name.object;
299
+ while (object.type === utils_1.AST_NODE_TYPES.JSXMemberExpression) {
300
+ object = object.object;
301
+ }
302
+ if (object.type !== utils_1.AST_NODE_TYPES.JSXIdentifier) {
303
+ return null;
304
+ }
305
+ const binding = importBindingOf(scope, object.name);
306
+ return binding && isMuiSource(binding.source) ? name.property.name : null;
307
+ }
308
+ return null;
309
+ }
232
310
  /**
233
311
  * Convert a string value to a single-quoted JS string literal.
234
312
  * Used when building sx property values from JSX string attributes.
@@ -1023,9 +1101,14 @@ exports.preferSxPropOverSystemProps = (0, createRule_1.createRule)({
1023
1101
  },
1024
1102
  defaultOptions: [{}],
1025
1103
  create(context, [options]) {
1026
- const componentSet = options.components
1104
+ // Naming a component here is the documented opt-in for a first-party
1105
+ // wrapper that forwards its props to MUI. Such a wrapper is defined by
1106
+ // living outside `@mui/*`, so the names the user lists are honored whatever
1107
+ // introduced them.
1108
+ const explicitComponents = options.components
1027
1109
  ? new Set(options.components)
1028
- : DEFAULT_MUI_COMPONENTS;
1110
+ : null;
1111
+ const componentSet = explicitComponents ?? DEFAULT_MUI_COMPONENTS;
1029
1112
  const extraAllowed = options.allowedProps
1030
1113
  ? new Set(options.allowedProps)
1031
1114
  : new Set();
@@ -1052,14 +1135,31 @@ exports.preferSxPropOverSystemProps = (0, createRule_1.createRule)({
1052
1135
  }
1053
1136
  return MUI_SYSTEM_PROPS.has(name) && !isAllowedProp(name);
1054
1137
  }
1138
+ /**
1139
+ * The MUI component this element is, or null when the rule leaves it alone.
1140
+ * An element qualifies on two counts: it resolves to a component MUI
1141
+ * exports, and that component is one the rule covers.
1142
+ */
1143
+ function targetedComponentOf(node) {
1144
+ const writtenName = getComponentName(node);
1145
+ if (!writtenName || !isUpperCase(writtenName)) {
1146
+ return null;
1147
+ }
1148
+ if (explicitComponents?.has(writtenName)) {
1149
+ return writtenName;
1150
+ }
1151
+ const muiExport = muiExportOf(node, ASTHelpers_1.ASTHelpers.getScope(context, node));
1152
+ if (muiExport === null || !componentSet.has(muiExport)) {
1153
+ return null;
1154
+ }
1155
+ // The export name, not the local one: an aliased `Box as MuiBox` is still
1156
+ // MUI's `Box` for the covered-component and owned-prop lookups.
1157
+ return muiExport;
1158
+ }
1055
1159
  return {
1056
1160
  JSXOpeningElement(node) {
1057
- const componentName = getComponentName(node);
1058
- if (!componentName)
1059
- return;
1060
- if (!isUpperCase(componentName))
1061
- return;
1062
- if (!componentSet.has(componentName))
1161
+ const componentName = targetedComponentOf(node);
1162
+ if (componentName === null)
1063
1163
  return;
1064
1164
  const systemPropAttrs = [];
1065
1165
  let sxAttr = null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blumintinc/eslint-plugin-blumint",
3
- "version": "1.21.5",
3
+ "version": "1.21.6",
4
4
  "description": "Custom eslint rules for use within BluMint",
5
5
  "author": {
6
6
  "name": "Brodie McGuire",
@@ -1,4 +1,34 @@
1
1
  [
2
+ {
3
+ "version": "1.21.6",
4
+ "date": "2026-09-04T20:52:21.747Z",
5
+ "rules": [
6
+ {
7
+ "name": "global-const-style",
8
+ "changeType": "fix",
9
+ "issues": [
10
+ 2324
11
+ ],
12
+ "summary": "follow alias chains when detecting mutation (closes #2324)"
13
+ },
14
+ {
15
+ "name": "no-try-catch-already-exists-in-transaction",
16
+ "changeType": "fix",
17
+ "issues": [
18
+ 2325
19
+ ],
20
+ "summary": "gate on Firestore provenance (closes #2325)"
21
+ },
22
+ {
23
+ "name": "prefer-sx-prop-over-system-props",
24
+ "changeType": "fix",
25
+ "issues": [
26
+ 2323
27
+ ],
28
+ "summary": "gate the rewrite on MUI provenance (closes #2323)"
29
+ }
30
+ ]
31
+ },
2
32
  {
3
33
  "version": "1.21.5",
4
34
  "date": "2026-09-04T15:01:41.191Z",