eslint-rule-forge 0.1.0 → 0.3.0

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.
Files changed (47) hide show
  1. package/README.md +49 -9
  2. package/dist/index.d.mts +2 -0
  3. package/dist/index.d.mts.map +1 -1
  4. package/dist/index.mjs +2 -0
  5. package/dist/index.mjs.map +1 -1
  6. package/dist/negation.d.mts +102 -0
  7. package/dist/negation.d.mts.map +1 -0
  8. package/dist/negation.mjs +215 -0
  9. package/dist/negation.mjs.map +1 -0
  10. package/dist/rules/index.d.mts +6 -0
  11. package/dist/rules/index.d.mts.map +1 -0
  12. package/dist/rules/index.mjs +6 -0
  13. package/dist/rules/index.mjs.map +1 -0
  14. package/dist/rules/no-side-effect-import.d.mts +18 -0
  15. package/dist/rules/no-side-effect-import.d.mts.map +1 -0
  16. package/dist/rules/no-side-effect-import.mjs +45 -0
  17. package/dist/rules/no-side-effect-import.mjs.map +1 -0
  18. package/dist/rules/prefer-array-is-array.d.mts +13 -0
  19. package/dist/rules/prefer-array-is-array.d.mts.map +1 -0
  20. package/dist/rules/prefer-array-is-array.mjs +81 -0
  21. package/dist/rules/prefer-array-is-array.mjs.map +1 -0
  22. package/dist/rules/prefer-is-non-null-object.d.mts +11 -0
  23. package/dist/rules/prefer-is-non-null-object.d.mts.map +1 -0
  24. package/dist/rules/prefer-is-non-null-object.mjs +192 -0
  25. package/dist/rules/prefer-is-non-null-object.mjs.map +1 -0
  26. package/dist/rules/prefer-is-record-and-has-key.d.mts +11 -0
  27. package/dist/rules/prefer-is-record-and-has-key.d.mts.map +1 -0
  28. package/dist/rules/prefer-is-record-and-has-key.mjs +226 -0
  29. package/dist/rules/prefer-is-record-and-has-key.mjs.map +1 -0
  30. package/dist/rules/prefer-safe-parse.d.mts +31 -0
  31. package/dist/rules/prefer-safe-parse.d.mts.map +1 -0
  32. package/dist/rules/prefer-safe-parse.mjs +139 -0
  33. package/dist/rules/prefer-safe-parse.mjs.map +1 -0
  34. package/dist/type-wrappers.d.mts +17 -1
  35. package/dist/type-wrappers.d.mts.map +1 -1
  36. package/dist/type-wrappers.mjs +35 -1
  37. package/dist/type-wrappers.mjs.map +1 -1
  38. package/package.json +10 -10
  39. package/src/index.mts +2 -0
  40. package/src/negation.mts +356 -0
  41. package/src/rules/index.mts +5 -0
  42. package/src/rules/no-side-effect-import.mts +68 -0
  43. package/src/rules/prefer-array-is-array.mts +119 -0
  44. package/src/rules/prefer-is-non-null-object.mts +276 -0
  45. package/src/rules/prefer-is-record-and-has-key.mts +321 -0
  46. package/src/rules/prefer-safe-parse.mts +252 -0
  47. package/src/type-wrappers.mts +55 -1
@@ -0,0 +1,11 @@
1
+ import { type TSESLint } from '@typescript-eslint/utils';
2
+ /**
3
+ * Builds a rule that replaces `typeof u === 'object' && u !== null`, in either
4
+ * order and anywhere in an `&&` chain, with `isNonNullObject(u)` imported from
5
+ * `moduleName`.
6
+ */
7
+ export declare const createPreferIsNonNullObject: ({ moduleName, }: Readonly<{
8
+ /** The module that exports `isNonNullObject`. */
9
+ moduleName: string;
10
+ }>) => TSESLint.RuleModule<'useIsNonNullObject', readonly []>;
11
+ //# sourceMappingURL=prefer-is-non-null-object.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-is-non-null-object.d.mts","sourceRoot":"","sources":["../../src/rules/prefer-is-non-null-object.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EAEd,MAAM,0BAA0B,CAAC;AASlC;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,oBAErC,QAAQ,CAAC;IACV,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC,KAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,EAAE,SAAS,EAAE,CAwE7C,CAAC"}
@@ -0,0 +1,192 @@
1
+ import { AST_NODE_TYPES, } from '@typescript-eslint/utils';
2
+ import { buildNamedImportFix, getImportDeclarations, getNamedImports, } from '../imports.mjs';
3
+ import { getRangeWithParens, parenthesesDepth } from '../parentheses.mjs';
4
+ import { skipTypeWrappers } from '../type-wrappers.mjs';
5
+
6
+
7
+
8
+
9
+
10
+ export const createPreferIsNonNullObject = ({ moduleName, }) => ({
11
+ meta: {
12
+ type: 'suggestion',
13
+ docs: {
14
+ description: `Replace \`typeof u === "object" && u !== null\`, in either order and anywhere in an \`&&\` chain, with \`isNonNullObject(u)\` from ${moduleName}.`,
15
+ },
16
+ fixable: 'code',
17
+ schema: [],
18
+ messages: {
19
+ useIsNonNullObject: `Replace the object/null check with \`isNonNullObject()\` from ${moduleName}.`,
20
+ },
21
+ },
22
+ create: (context) => {
23
+ const sourceCode = context.sourceCode;
24
+ const program = sourceCode.ast;
25
+ const moduleImports = getImportDeclarations(program, moduleName);
26
+ const mut_pairsToFix = [];
27
+ return {
28
+ LogicalExpression: (node) => {
29
+
30
+ if (node.operator !== '&&' || isChainOperand(sourceCode, node)) {
31
+ return;
32
+ }
33
+ mut_pairsToFix.push(...findNonNullObjectPairs(sourceCode, node));
34
+ },
35
+ 'Program:exit': () => {
36
+ const hasIsNonNullObjectImport = getNamedImports(moduleImports).includes('isNonNullObject');
37
+
38
+
39
+
40
+
41
+
42
+ for (const [index, { range, identifierName },] of mut_pairsToFix.entries()) {
43
+ context.report({
44
+ loc: {
45
+ start: sourceCode.getLocFromIndex(range[0]),
46
+ end: sourceCode.getLocFromIndex(range[1]),
47
+ },
48
+ messageId: 'useIsNonNullObject',
49
+ fix: (fixer) => {
50
+ const replacement = `isNonNullObject(${identifierName})`;
51
+ const importFixes = index === 0 && !hasIsNonNullObjectImport
52
+ ? buildNamedImportFix(fixer, program, moduleName, [
53
+ 'isNonNullObject',
54
+ ])
55
+ : [];
56
+ return [
57
+ ...importFixes,
58
+ fixer.replaceTextRange(range, replacement),
59
+ ];
60
+ },
61
+ });
62
+ }
63
+ },
64
+ };
65
+ },
66
+ defaultOptions: [],
67
+ });
68
+
69
+
70
+
71
+
72
+ const isChainOperand = (
73
+
74
+ sourceCode,
75
+
76
+ node) => node.parent.type === AST_NODE_TYPES.LogicalExpression &&
77
+ node.parent.operator === '&&' &&
78
+ parenthesesDepth(sourceCode, node) === 0;
79
+
80
+
81
+
82
+
83
+
84
+
85
+ const findNonNullObjectPairs = (
86
+
87
+ sourceCode,
88
+
89
+ node) => {
90
+ const operands = chainOperands(sourceCode, node);
91
+ const pairsFrom = (index) => {
92
+ const first = operands[index];
93
+ const second = operands[index + 1];
94
+ if (first === undefined || second === undefined) {
95
+ return [];
96
+ }
97
+ const identifierName = pairIdentifierName(first, second) ?? pairIdentifierName(second, first);
98
+ return identifierName === undefined
99
+ ? pairsFrom(index + 1)
100
+ : [
101
+ {
102
+ range: [
103
+ getRangeWithParens(sourceCode, first)[0],
104
+ getRangeWithParens(sourceCode, second)[1],
105
+ ],
106
+ identifierName,
107
+ },
108
+ ...pairsFrom(index + 2),
109
+ ];
110
+ };
111
+ return pairsFrom(0);
112
+ };
113
+
114
+
115
+
116
+
117
+ const chainOperands = (
118
+
119
+ sourceCode,
120
+
121
+ node) => [node.left, node.right].flatMap((operand) => operand.type === AST_NODE_TYPES.LogicalExpression &&
122
+ operand.operator === '&&' &&
123
+ parenthesesDepth(sourceCode, operand) === 0
124
+ ? chainOperands(sourceCode, operand)
125
+ : [operand]);
126
+
127
+
128
+
129
+
130
+
131
+
132
+ const pairIdentifierName = (
133
+
134
+ typeofCheck,
135
+
136
+ nullCheck) => {
137
+ const identifierName = getTypeofObjectIdentifierName(skipTypeWrappers(typeofCheck));
138
+ return identifierName !== undefined &&
139
+ identifierName ===
140
+ getNonNullCheckIdentifierName(skipTypeWrappers(nullCheck))
141
+ ? identifierName
142
+ : undefined;
143
+ };
144
+
145
+ const getTypeofObjectIdentifierName = (
146
+
147
+ node) => {
148
+ if (node.type !== AST_NODE_TYPES.BinaryExpression ||
149
+ node.operator !== '===') {
150
+ return undefined;
151
+ }
152
+ const left = skipTypeWrappers(node.left);
153
+ const right = skipTypeWrappers(node.right);
154
+ const typeofSide = isLiteralOf(right, 'object')
155
+ ? left
156
+ : isLiteralOf(left, 'object')
157
+ ? right
158
+ : undefined;
159
+ if (typeofSide?.type !== AST_NODE_TYPES.UnaryExpression ||
160
+ typeofSide.operator !== 'typeof') {
161
+ return undefined;
162
+ }
163
+ const argument = skipTypeWrappers(typeofSide.argument);
164
+ return argument.type === AST_NODE_TYPES.Identifier
165
+ ? argument.name
166
+ : undefined;
167
+ };
168
+
169
+
170
+
171
+
172
+
173
+ const getNonNullCheckIdentifierName = (
174
+
175
+ node) => {
176
+ if (node.type !== AST_NODE_TYPES.BinaryExpression ||
177
+ (node.operator !== '!==' && node.operator !== '!=')) {
178
+ return undefined;
179
+ }
180
+ const left = skipTypeWrappers(node.left);
181
+ const right = skipTypeWrappers(node.right);
182
+ const checked = isLiteralOf(right, null)
183
+ ? left
184
+ : isLiteralOf(left, null)
185
+ ? right
186
+ : undefined;
187
+ return checked?.type === AST_NODE_TYPES.Identifier ? checked.name : undefined;
188
+ };
189
+ const isLiteralOf = (
190
+
191
+ node, value) => node.type === AST_NODE_TYPES.Literal && node.value === value;
192
+ //# sourceMappingURL=prefer-is-non-null-object.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-is-non-null-object.mjs","sourceRoot":"","sources":["../../src/rules/prefer-is-non-null-object.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,EAC1C,UAAU,GAIV,EAA0D,EAAE,CAC5D,CAAC;IACC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,sIAAsI,UAAU,GAAG;SACjK;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,kBAAkB,EAAE,iEAAiE,UAAU,GAAG;SACnG;KACF;IAED,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEtC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC;QAE/B,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEjE,MAAM,cAAc,GAAwB,EAAE,CAAC;QAE/C,OAAO;YACL,iBAAiB,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC1B,iDAAiD;gBACjD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;oBAC/D,OAAO;gBACT,CAAC;gBAED,cAAc,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;YACnE,CAAC;YACD,cAAc,EAAE,GAAG,EAAE;gBACnB,MAAM,wBAAwB,GAC5B,eAAe,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;gBAE7D,iDAAiD;gBACjD,6DAA6D;gBAC7D,+DAA+D;gBAC/D,iEAAiE;gBACjE,sBAAsB;gBACtB,KAAK,MAAM,CACT,KAAK,EACL,EAAE,KAAK,EAAE,cAAc,EAAE,EAC1B,IAAI,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC9B,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE;4BACH,KAAK,EAAE,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;4BAC3C,GAAG,EAAE,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;yBAC1C;wBACD,SAAS,EAAE,oBAAoB;wBAC/B,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;4BACb,MAAM,WAAW,GAAG,mBAAmB,cAAc,GAAG,CAAC;4BAEzD,MAAM,WAAW,GACf,KAAK,KAAK,CAAC,IAAI,CAAC,wBAAwB;gCACtC,CAAC,CAAC,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;oCAC9C,iBAAiB;iCAClB,CAAC;gCACJ,CAAC,CAAC,EAAE,CAAC;4BAET,OAAO;gCACL,GAAG,WAAW;gCACd,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC;6BAC3C,CAAC;wBACJ,CAAC;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;CACnB,CAAU,CAAC;AAYd;;;GAGG;AACH,MAAM,cAAc,GAAG;AACrB,8EAA8E;AAC9E,UAA+B;AAC/B,8EAA8E;AAC9E,IAAgC,EACvB,EAAE,CACX,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,IAAI;IAC7B,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG;AAC7B,8EAA8E;AAC9E,UAA+B;AAC/B,8EAA8E;AAC9E,IAAgC,EACF,EAAE;IAChC,MAAM,QAAQ,GAAG,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAEjD,MAAM,SAAS,GAAG,CAAC,KAAa,EAAgC,EAAE;QAChE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE9B,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAEnC,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAChD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,cAAc,GAClB,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAEzE,OAAO,cAAc,KAAK,SAAS;YACjC,CAAC,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC;YACtB,CAAC,CAAC;gBACE;oBACE,KAAK,EAAE;wBACL,kBAAkB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;wBACxC,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;qBAC1C;oBACD,cAAc;iBACf;gBACD,GAAG,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC;aACxB,CAAC;IACR,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,aAAa,GAAG;AACpB,8EAA8E;AAC9E,UAA+B;AAC/B,8EAA8E;AAC9E,IAAgC,EACA,EAAE,CAClC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC1C,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IACjD,OAAO,CAAC,QAAQ,KAAK,IAAI;IACzB,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC;IACzC,CAAC,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC;IACpC,CAAC,CAAC,CAAC,OAAO,CAAC,CACd,CAAC;AAEJ,8EAA8E;AAC9E,2DAA2D;AAE3D;;;GAGG;AACH,MAAM,kBAAkB,GAAG;AACzB,8EAA8E;AAC9E,WAAgC;AAChC,8EAA8E;AAC9E,SAA8B,EACV,EAAE;IACtB,MAAM,cAAc,GAAG,6BAA6B,CAClD,gBAAgB,CAAC,WAAW,CAAC,CAC9B,CAAC;IAEF,OAAO,cAAc,KAAK,SAAS;QACjC,cAAc;YACZ,6BAA6B,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,6BAA6B,GAAG;AACpC,8EAA8E;AAC9E,IAAmB,EACC,EAAE;IACtB,IACE,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;QAC7C,IAAI,CAAC,QAAQ,KAAK,KAAK,EACvB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAE3C,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;QAC7C,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC;YAC3B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,SAAS,CAAC;IAEhB,IACE,UAAU,EAAE,IAAI,KAAK,cAAc,CAAC,eAAe;QACnD,UAAU,CAAC,QAAQ,KAAK,QAAQ,EAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEvD,OAAO,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;QAChD,CAAC,CAAC,QAAQ,CAAC,IAAI;QACf,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,6BAA6B,GAAG;AACpC,8EAA8E;AAC9E,IAAmB,EACC,EAAE;IACtB,IACE,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;QAC7C,CAAC,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,EACnD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAE3C,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC;QACtC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC;YACvB,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,OAAO,EAAE,IAAI,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAChF,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG;AAClB,8EAA8E;AAC9E,IAAmB,EACnB,KAAoB,EACX,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { type TSESLint } from '@typescript-eslint/utils';
2
+ /**
3
+ * Builds a rule that replaces `Object.hasOwn(obj, key)` and `key in obj` with
4
+ * `isRecord(obj) && hasKey(obj, key)` imported from `moduleName`, or with
5
+ * `hasKey(obj, key)` alone when `obj` is already a record.
6
+ */
7
+ export declare const createPreferIsRecordAndHasKey: ({ moduleName, }: Readonly<{
8
+ /** The module that exports `isRecord` and `hasKey`. */
9
+ moduleName: string;
10
+ }>) => TSESLint.RuleModule<'useIsRecordAndHasKey' | 'useHasKey', readonly []>;
11
+ //# sourceMappingURL=prefer-is-record-and-has-key.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-is-record-and-has-key.d.mts","sourceRoot":"","sources":["../../src/rules/prefer-is-record-and-has-key.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EAEd,MAAM,0BAA0B,CAAC;AAclC;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,oBAEvC,QAAQ,CAAC;IACV,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC,KAAG,QAAQ,CAAC,UAAU,CAAC,sBAAsB,GAAG,WAAW,EAAE,SAAS,EAAE,CAqN7D,CAAC"}
@@ -0,0 +1,226 @@
1
+ import { AST_NODE_TYPES, } from '@typescript-eslint/utils';
2
+ import * as ts from 'typescript';
3
+ import { buildNamedImportFix, getImportDeclarations, getNamedImports, } from '../imports.mjs';
4
+ import { getArgumentText } from '../parentheses.mjs';
5
+ import { isIdentifierNamed, skipTypeWrappers, typeHoldsAtEveryLayer, } from '../type-wrappers.mjs';
6
+
7
+
8
+
9
+
10
+
11
+ export const createPreferIsRecordAndHasKey = ({ moduleName, }) => ({
12
+ meta: {
13
+ type: 'suggestion',
14
+ docs: {
15
+ description: `Replace \`Object.hasOwn(obj, key)\` or \`key in obj\` with \`isRecord(obj) && hasKey(obj, key)\` from ${moduleName}`,
16
+ },
17
+ fixable: 'code',
18
+ schema: [],
19
+ messages: {
20
+ useIsRecordAndHasKey: `Replace \`{{original}}\` with \`isRecord({{objName}}) && hasKey({{objName}}, {{keyName}})\` from ${moduleName}.`,
21
+ useHasKey: `Replace \`{{original}}\` with \`hasKey({{objName}}, {{keyName}})\` from ${moduleName}.`,
22
+ },
23
+ },
24
+ create: (context) => {
25
+ const sourceCode = context.sourceCode;
26
+ const program = sourceCode.ast;
27
+ const moduleImports = getImportDeclarations(program, moduleName);
28
+
29
+
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+ const isKnownRecord = (
38
+
39
+ expression) => typeHoldsAtEveryLayer(sourceCode, expression, (type, checker) => isAlreadyRecordType(checker, type));
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+ const mayBeArray = (
48
+
49
+ expression) => sourceCode.parserServices?.program != null &&
50
+ !typeHoldsAtEveryLayer(sourceCode, expression, (type, checker) => !mayBeArrayType(checker, type));
51
+ const mut_nodesToFix = [];
52
+ return {
53
+
54
+ CallExpression: (node) => {
55
+ const callee = skipTypeWrappers(node.callee);
56
+ if (callee.type !== AST_NODE_TYPES.MemberExpression ||
57
+ !isIdentifierNamed(callee.object, 'Object') ||
58
+ callee.property.type !== AST_NODE_TYPES.Identifier ||
59
+ callee.property.name !== 'hasOwn') {
60
+ return;
61
+ }
62
+
63
+ if (node.arguments.length !== 2) {
64
+ return;
65
+ }
66
+ const objArg = node.arguments[0];
67
+ const keyArg = node.arguments[1];
68
+ if (objArg === undefined || keyArg === undefined) {
69
+ return;
70
+ }
71
+
72
+ if (objArg.type === AST_NODE_TYPES.SpreadElement ||
73
+ keyArg.type === AST_NODE_TYPES.SpreadElement ||
74
+ mayBeArray(objArg)) {
75
+ return;
76
+ }
77
+ mut_nodesToFix.push({
78
+ node,
79
+ objExpression: objArg,
80
+ keyExpression: keyArg,
81
+ });
82
+ },
83
+
84
+ BinaryExpression: (node) => {
85
+ if (node.operator !== 'in') {
86
+ return;
87
+ }
88
+ const keyExpression = node.left;
89
+ const objExpression = node.right;
90
+
91
+ if (keyExpression.type === AST_NODE_TYPES.PrivateIdentifier ||
92
+ mayBeArray(objExpression)) {
93
+ return;
94
+ }
95
+ mut_nodesToFix.push({
96
+ node,
97
+ objExpression,
98
+ keyExpression,
99
+ });
100
+ },
101
+ 'Program:exit': () => {
102
+ const namedImports = getNamedImports(moduleImports);
103
+ const rewrites = mut_nodesToFix.map((entry) => {
104
+
105
+
106
+ const needsIsRecord = !isKnownRecord(entry.objExpression);
107
+ return {
108
+ ...entry,
109
+ needsIsRecord,
110
+
111
+ fixable: !needsIsRecord || isSideEffectFree(entry.objExpression),
112
+ };
113
+ });
114
+ const fixableRewrites = rewrites.filter(({ fixable }) => fixable);
115
+ const importsToAdd = fixableRewrites.length === 0
116
+ ? []
117
+ : [
118
+ ...(fixableRewrites.some(({ needsIsRecord }) => needsIsRecord) && !namedImports.includes('isRecord')
119
+ ? ['isRecord']
120
+ : []),
121
+ ...(namedImports.includes('hasKey') ? [] : ['hasKey']),
122
+ ];
123
+ const importCarrier = fixableRewrites[0];
124
+ for (const rewrite of rewrites) {
125
+ const { node, objExpression, keyExpression, needsIsRecord } = rewrite;
126
+ const objText = getArgumentText(sourceCode, objExpression);
127
+ const keyText = getArgumentText(sourceCode, keyExpression);
128
+ const originalText = sourceCode.getText(node);
129
+ context.report({
130
+ node,
131
+ messageId: needsIsRecord ? 'useIsRecordAndHasKey' : 'useHasKey',
132
+ data: {
133
+ original: originalText,
134
+ objName: objText,
135
+ keyName: keyText,
136
+ },
137
+ fix: !rewrite.fixable
138
+ ? undefined
139
+ : (fixer) => {
140
+ const replacement = needsIsRecord
141
+ ? `(isRecord(${objText}) && hasKey(${objText}, ${keyText}))`
142
+ : `hasKey(${objText}, ${keyText})`;
143
+
144
+
145
+
146
+
147
+ const importFixes = rewrite === importCarrier && importsToAdd.length > 0
148
+ ? buildNamedImportFix(fixer, program, moduleName, importsToAdd)
149
+ : [];
150
+ return [
151
+ ...importFixes,
152
+ fixer.replaceText(node, replacement),
153
+ ];
154
+ },
155
+ });
156
+ }
157
+ },
158
+ };
159
+ },
160
+ defaultOptions: [],
161
+ });
162
+
163
+
164
+
165
+
166
+ const isSideEffectFree = (
167
+
168
+ wrapped) => {
169
+ const node = skipTypeWrappers(wrapped);
170
+ return (node.type === AST_NODE_TYPES.Identifier ||
171
+ node.type === AST_NODE_TYPES.ThisExpression ||
172
+ (node.type === AST_NODE_TYPES.MemberExpression &&
173
+ !node.computed &&
174
+ isSideEffectFree(node.object)));
175
+ };
176
+
177
+
178
+
179
+
180
+
181
+ const mayBeArrayType = (
182
+
183
+ checker,
184
+
185
+ type) => {
186
+ if (type.isUnionOrIntersection()) {
187
+ return type.types.some((member) => mayBeArrayType(checker, member));
188
+ }
189
+ if ((type.flags &
190
+ (ts.TypeFlags.TypeParameter |
191
+ ts.TypeFlags.IndexedAccess |
192
+ ts.TypeFlags.Conditional |
193
+ ts.TypeFlags.Substitution)) !==
194
+ 0) {
195
+ const constraint = checker.getBaseConstraintOfType(type);
196
+ return constraint !== undefined && mayBeArrayType(checker, constraint);
197
+ }
198
+ return checker.isArrayType(type) || checker.isTupleType(type);
199
+ };
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ const isAlreadyRecordType = (
215
+
216
+ checker,
217
+
218
+ type) => type.isUnion()
219
+ ? type.types.every((member) => isAlreadyRecordType(checker, member))
220
+ : checker.getIndexInfoOfType(type, ts.IndexKind.String) !== undefined &&
221
+ checker.getSignaturesOfType(type, ts.SignatureKind.Call).length === 0 &&
222
+ checker.getSignaturesOfType(type, ts.SignatureKind.Construct).length ===
223
+ 0 &&
224
+ !checker.isArrayType(type) &&
225
+ !checker.isTupleType(type);
226
+ //# sourceMappingURL=prefer-is-record-and-has-key.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-is-record-and-has-key.mjs","sourceRoot":"","sources":["../../src/rules/prefer-is-record-and-has-key.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAE9B;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,EAC5C,UAAU,GAIV,EAA0E,EAAE,CAC5E,CAAC;IACC,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,yGAAyG,UAAU,EAAE;SACnI;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,oBAAoB,EAAE,oGAAoG,UAAU,GAAG;YACvI,SAAS,EAAE,2EAA2E,UAAU,GAAG;SACpG;KACF;IAED,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEtC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC;QAE/B,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEjE;;;;;;;;WAQG;QACH,MAAM,aAAa,GAAG;QACpB,8EAA8E;QAC9E,UAA+B,EACtB,EAAE,CACX,qBAAqB,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAC9D,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,CACnC,CAAC;QAEJ;;;;;;WAMG;QACH,MAAM,UAAU,GAAG;QACjB,8EAA8E;QAC9E,UAA+B,EACtB,EAAE,CACX,UAAU,CAAC,cAAc,EAAE,OAAO,IAAI,IAAI;YAC1C,CAAC,qBAAqB,CACpB,UAAU,EACV,UAAU,EACV,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAClD,CAAC;QAEJ,MAAM,cAAc,GAId,EAAE,CAAC;QAET,OAAO;YACL,iCAAiC;YACjC,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;gBACvB,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7C,IACE,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;oBAC/C,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;oBAC3C,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;oBAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EACjC,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,2CAA2C;gBAC3C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAChC,OAAO;gBACT,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAEjC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAEjC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBAED,mEAAmE;gBACnE,IACE,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa;oBAC5C,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa;oBAC5C,UAAU,CAAC,MAAM,CAAC,EAClB,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI;oBACJ,aAAa,EAAE,MAAM;oBACrB,aAAa,EAAE,MAAM;iBACtB,CAAC,CAAC;YACL,CAAC;YAED,oBAAoB;YACpB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO;gBACT,CAAC;gBAED,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC;gBAEhC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;gBAEjC,yEAAyE;gBACzE,IACE,aAAa,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;oBACvD,UAAU,CAAC,aAAa,CAAC,EACzB,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI;oBACJ,aAAa;oBACb,aAAa;iBACd,CAAC,CAAC;YACL,CAAC;YAED,cAAc,EAAE,GAAG,EAAE;gBACnB,MAAM,YAAY,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;gBAEpD,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC5C,kEAAkE;oBAClE,uDAAuD;oBACvD,MAAM,aAAa,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;oBAE1D,OAAO;wBACL,GAAG,KAAK;wBACR,aAAa;wBACb,6DAA6D;wBAC7D,OAAO,EAAE,CAAC,aAAa,IAAI,gBAAgB,CAAC,KAAK,CAAC,aAAa,CAAC;qBACjE,CAAC;gBACJ,CAAC,CAAC,CAAC;gBAEH,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;gBAElE,MAAM,YAAY,GAChB,eAAe,CAAC,MAAM,KAAK,CAAC;oBAC1B,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC;wBACE,GAAG,CAAC,eAAe,CAAC,IAAI,CACtB,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,aAAa,CACrC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC;4BACrC,CAAC,CAAC,CAAC,UAAU,CAAC;4BACd,CAAC,CAAC,EAAE,CAAC;wBACP,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;qBACvD,CAAC;gBAER,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;gBAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;oBAC/B,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,GACzD,OAAO,CAAC;oBAEV,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;oBAE3D,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;oBAE3D,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAE9C,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,WAAW;wBAC/D,IAAI,EAAE;4BACJ,QAAQ,EAAE,YAAY;4BACtB,OAAO,EAAE,OAAO;4BAChB,OAAO,EAAE,OAAO;yBACjB;wBACD,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO;4BACnB,CAAC,CAAC,SAAS;4BACX,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;gCACR,MAAM,WAAW,GAAG,aAAa;oCAC/B,CAAC,CAAC,aAAa,OAAO,eAAe,OAAO,KAAK,OAAO,IAAI;oCAC5D,CAAC,CAAC,UAAU,OAAO,KAAK,OAAO,GAAG,CAAC;gCAErC,qDAAqD;gCACrD,kDAAkD;gCAClD,0DAA0D;gCAC1D,kBAAkB;gCAClB,MAAM,WAAW,GACf,OAAO,KAAK,aAAa,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;oCAClD,CAAC,CAAC,mBAAmB,CACjB,KAAK,EACL,OAAO,EACP,UAAU,EACV,YAAY,CACb;oCACH,CAAC,CAAC,EAAE,CAAC;gCAET,OAAO;oCACL,GAAG,WAAW;oCACd,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC;iCACrC,CAAC;4BACJ,CAAC;qBACN,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;CACnB,CAAU,CAAC;AAEd;;;GAGG;AACH,MAAM,gBAAgB,GAAG;AACvB,8EAA8E;AAC9E,OAAsB,EACb,EAAE;IACX,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAEvC,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;QACvC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc;QAC3C,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;YAC5C,CAAC,IAAI,CAAC,QAAQ;YACd,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CACjC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAG;AACrB,8EAA8E;AAC9E,OAAuB;AACvB,8EAA8E;AAC9E,IAAa,EACJ,EAAE;IACX,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,IACE,CAAC,IAAI,CAAC,KAAK;QACT,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa;YACzB,EAAE,CAAC,SAAS,CAAC,aAAa;YAC1B,EAAE,CAAC,SAAS,CAAC,WAAW;YACxB,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC,EACD,CAAC;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAEzD,OAAO,UAAU,KAAK,SAAS,IAAI,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,mBAAmB,GAAG;AAC1B,8EAA8E;AAC9E,OAAuB;AACvB,8EAA8E;AAC9E,IAAa,EACJ,EAAE,CACX,IAAI,CAAC,OAAO,EAAE;IACZ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS;QACnE,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QACrE,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,MAAM;YAClE,CAAC;QACH,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QAC1B,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC"}
@@ -0,0 +1,31 @@
1
+ import { type TSESLint } from '@typescript-eslint/utils';
2
+ /** What {@link createPreferSafeParseInt} and its float twin are told. */
3
+ export type SafeParseRuleConfig = Readonly<{
4
+ /** The module that exports `namespace` and `Result`. */
5
+ moduleName: string;
6
+ /** The exported namespace the parse function is reached through. */
7
+ namespace: string;
8
+ /**
9
+ * The member of `namespace` that parses a `string` into a
10
+ * `Result<number, …>`.
11
+ */
12
+ method: string;
13
+ }>;
14
+ /**
15
+ * Builds a rule that replaces the base-10 forms of `parseInt` and
16
+ * `Number.parseInt` — `parseInt(x)` and `parseInt(x, 10)` — with
17
+ * `Result.unwrapOkOr(<namespace>.<method>(x), Number.NaN)`.
18
+ *
19
+ * A call that passes another radix is left alone: the replacement takes none,
20
+ * so it would mean something the replacement cannot say.
21
+ */
22
+ export declare const createPreferSafeParseInt: (config: SafeParseRuleConfig) => TSESLint.RuleModule<'useSafeParseInt', readonly []>;
23
+ /**
24
+ * Builds a rule that replaces `parseFloat(x)`, `Number.parseFloat(x)` and
25
+ * `Number(x)` with `Result.unwrapOkOr(<namespace>.<method>(x), Number.NaN)`.
26
+ *
27
+ * Like every rewrite here, `Number(x)` is only flagged when `x` is purely a
28
+ * `string`, which leaves `Number(someBoolean)` and `Number(someNumber)` alone.
29
+ */
30
+ export declare const createPreferSafeParseFloat: (config: SafeParseRuleConfig) => TSESLint.RuleModule<'useSafeParseFloat', readonly []>;
31
+ //# sourceMappingURL=prefer-safe-parse.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-safe-parse.d.mts","sourceRoot":"","sources":["../../src/rules/prefer-safe-parse.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EAEd,MAAM,0BAA0B,CAAC;AAelC,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;IACzC,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;IAEnB,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,WAC3B,mBAAmB,KAC1B,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,SAAS,EAAE,CAsBjD,CAAC;AAEL;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,WAC7B,mBAAmB,KAC1B,QAAQ,CAAC,UAAU,CAAC,mBAAmB,EAAE,SAAS,EAAE,CAUnD,CAAC"}
@@ -0,0 +1,139 @@
1
+ import { AST_NODE_TYPES, } from '@typescript-eslint/utils';
2
+ import * as ts from 'typescript';
3
+ import { buildNamedImportFix, getImportDeclarations, getNamedImports, } from '../imports.mjs';
4
+ import { getArgumentText } from '../parentheses.mjs';
5
+ import { isIdentifierNamed, skipTypeWrappers, typeHoldsAtEveryLayer, } from '../type-wrappers.mjs';
6
+
7
+
8
+
9
+
10
+
11
+
12
+
13
+
14
+ export const createPreferSafeParseInt = (config) => createSafeParseRule(config, 'useSafeParseInt', {
15
+ messages: { useSafeParseInt: messageText(config) },
16
+ description: `Replace \`parseInt(x)\` or \`Number.parseInt(x, 10)\` with \`Result.unwrapOkOr(${config.namespace}.${config.method}(x), Number.NaN)\` from ${config.moduleName}.`,
17
+ isTarget: (callee, args) => {
18
+ if (!isGlobalCall(callee, 'parseInt') &&
19
+ !isNumberMethod(callee, 'parseInt')) {
20
+ return false;
21
+ }
22
+
23
+
24
+ const radix = args[1] === undefined ? undefined : skipTypeWrappers(args[1]);
25
+ return (radix === undefined ||
26
+ (radix.type === AST_NODE_TYPES.Literal && radix.value === 10));
27
+ },
28
+ });
29
+
30
+
31
+
32
+
33
+
34
+
35
+
36
+ export const createPreferSafeParseFloat = (config) => createSafeParseRule(config, 'useSafeParseFloat', {
37
+ messages: { useSafeParseFloat: messageText(config) },
38
+ description: `Replace \`parseFloat(x)\`, \`Number.parseFloat(x)\`, or \`Number(x)\` (when x is a string) with \`Result.unwrapOkOr(${config.namespace}.${config.method}(x), Number.NaN)\` from ${config.moduleName}.`,
39
+
40
+
41
+ isTarget: (callee) => isGlobalCall(callee, 'parseFloat') ||
42
+ isNumberMethod(callee, 'parseFloat') ||
43
+ isGlobalCall(callee, 'Number'),
44
+ });
45
+
46
+ const createSafeParseRule = ({ moduleName, namespace, method }, messageId, { messages, description, isTarget, }) => {
47
+ const parseFunction = `${namespace}.${method}`;
48
+
49
+ const requiredImports = [namespace, 'Result'].toSorted();
50
+ return {
51
+ meta: {
52
+ type: 'suggestion',
53
+ docs: { description },
54
+ fixable: 'code',
55
+ schema: [],
56
+ messages,
57
+ },
58
+ create: (context) => {
59
+ const sourceCode = context.sourceCode;
60
+ const program = sourceCode.ast;
61
+ const moduleImports = getImportDeclarations(program, moduleName);
62
+ const mut_nodesToFix = [];
63
+ return {
64
+ CallExpression: (node) => {
65
+ if (!isTarget(skipTypeWrappers(node.callee), node.arguments)) {
66
+ return;
67
+ }
68
+ const firstArg = node.arguments[0];
69
+
70
+
71
+ if (firstArg === undefined ||
72
+ firstArg.type === AST_NODE_TYPES.SpreadElement) {
73
+ return;
74
+ }
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+ if (!typeHoldsAtEveryLayer(sourceCode, firstArg, isStringType)) {
83
+ return;
84
+ }
85
+ mut_nodesToFix.push({ node, argExpression: firstArg });
86
+ },
87
+ 'Program:exit': () => {
88
+ const namedImports = getNamedImports(moduleImports);
89
+ const missingImports = requiredImports.filter((name) => !namedImports.includes(name));
90
+
91
+
92
+
93
+ for (const [index, { node, argExpression },] of mut_nodesToFix.entries()) {
94
+ const argText = getArgumentText(sourceCode, argExpression);
95
+ context.report({
96
+ node,
97
+ messageId,
98
+ data: {
99
+ original: sourceCode.getText(node),
100
+ argName: argText,
101
+ },
102
+ fix: (fixer) => {
103
+ const core = `Result.unwrapOkOr(${parseFunction}(${argText}), Number.NaN)`;
104
+ const importFixes = index === 0 && missingImports.length > 0
105
+ ? buildNamedImportFix(fixer, program, moduleName, missingImports)
106
+ : [];
107
+ return [...importFixes, fixer.replaceText(node, core)];
108
+ },
109
+ });
110
+ }
111
+ },
112
+ };
113
+ },
114
+ defaultOptions: [],
115
+ };
116
+ };
117
+ const messageText = ({ moduleName, namespace, method, }) => `Replace \`{{original}}\` with \`Result.unwrapOkOr(${namespace}.${method}({{argName}}), Number.NaN)\` from ${moduleName}.`;
118
+
119
+ const isGlobalCall = (callee, name) => callee.type === AST_NODE_TYPES.Identifier && callee.name === name;
120
+
121
+
122
+
123
+
124
+ const isNumberMethod = (callee, name) => callee.type === AST_NODE_TYPES.MemberExpression &&
125
+ !callee.computed &&
126
+ isIdentifierNamed(callee.object, 'Number') &&
127
+ callee.property.type === AST_NODE_TYPES.Identifier &&
128
+ callee.property.name === name;
129
+
130
+
131
+
132
+
133
+
134
+ const isStringType = (type) => {
135
+ const parts = type.isUnion() ? type.types : [type];
136
+ return (parts.length > 0 &&
137
+ parts.every((t) => (t.flags & ts.TypeFlags.StringLike) !== 0));
138
+ };
139
+ //# sourceMappingURL=prefer-safe-parse.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"prefer-safe-parse.mjs","sourceRoot":"","sources":["../../src/rules/prefer-safe-parse.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAiB9B;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,MAA2B,EAC0B,EAAE,CACvD,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE;IAC7C,QAAQ,EAAE,EAAE,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE;IAClD,WAAW,EAAE,kFAAkF,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,2BAA2B,MAAM,CAAC,UAAU,GAAG;IAC/K,QAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACzB,IACE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;YACjC,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,EACnC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,oEAAoE;QACpE,kEAAkE;QAClE,MAAM,KAAK,GACT,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhE,OAAO,CACL,KAAK,KAAK,SAAS;YACnB,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC,CAC9D,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEL;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,MAA2B,EAC4B,EAAE,CACzD,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,EAAE;IAC/C,QAAQ,EAAE,EAAE,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE;IACpD,WAAW,EAAE,uHAAuH,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,2BAA2B,MAAM,CAAC,UAAU,GAAG;IACpN,kEAAkE;IAClE,iDAAiD;IACjD,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACnB,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC;QAClC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC;QACpC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC;CACjC,CAAC,CAAC;AAEL,uEAAuE;AAEvE,MAAM,mBAAmB,GAAG,CAC1B,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAuB,EACtD,SAAoB,EACpB,EACE,QAAQ,EACR,WAAW,EACX,QAAQ,GAcR,EAC2C,EAAE;IAC/C,MAAM,aAAa,GAAG,GAAG,SAAS,IAAI,MAAM,EAAW,CAAC;IAExD,gDAAgD;IAChD,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IAEzD,OAAO;QACL,IAAI,EAAE;YACJ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,EAAE,WAAW,EAAE;YACrB,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,EAAE;YACV,QAAQ;SACT;QAED,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YAClB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;YAEtC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC;YAE/B,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAEjE,MAAM,cAAc,GAGd,EAAE,CAAC;YAET,OAAO;gBACL,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;oBACvB,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC7D,OAAO;oBACT,CAAC;oBAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAEnC,8DAA8D;oBAC9D,UAAU;oBACV,IACE,QAAQ,KAAK,SAAS;wBACtB,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa,EAC9C,CAAC;wBACD,OAAO;oBACT,CAAC;oBAED,8DAA8D;oBAC9D,kEAAkE;oBAClE,gEAAgE;oBAChE,oEAAoE;oBACpE,iEAAiE;oBACjE,kEAAkE;oBAClE,0BAA0B;oBAC1B,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,CAAC;wBAC/D,OAAO;oBACT,CAAC;oBAED,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACzD,CAAC;gBACD,cAAc,EAAE,GAAG,EAAE;oBACnB,MAAM,YAAY,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;oBAEpD,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAC3C,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CACvC,CAAC;oBAEF,iDAAiD;oBACjD,6DAA6D;oBAC7D,uDAAuD;oBACvD,KAAK,MAAM,CACT,KAAK,EACL,EAAE,IAAI,EAAE,aAAa,EAAE,EACxB,IAAI,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;wBAC9B,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;wBAE3D,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI;4BACJ,SAAS;4BACT,IAAI,EAAE;gCACJ,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;gCAClC,OAAO,EAAE,OAAO;6BACjB;4BACD,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;gCACb,MAAM,IAAI,GACR,qBAAqB,aAAa,IAAI,OAAO,gBAAyB,CAAC;gCAEzE,MAAM,WAAW,GACf,KAAK,KAAK,CAAC,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;oCACtC,CAAC,CAAC,mBAAmB,CACjB,KAAK,EACL,OAAO,EACP,UAAU,EACV,cAAc,CACf;oCACH,CAAC,CAAE,EAAY,CAAC;gCAEpB,OAAO,CAAC,GAAG,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;4BACzD,CAAC;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;aACF,CAAC;QACJ,CAAC;QACD,cAAc,EAAE,EAAE;KACV,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,EACnB,UAAU,EACV,SAAS,EACT,MAAM,GACc,EAAU,EAAE,CAChC,qDAAqD,SAAS,IAAI,MAAM,qCAAqC,UAAU,GAAY,CAAC;AAEtI,6EAA6E;AAC7E,MAAM,YAAY,GAAG,CAAC,MAA2B,EAAE,IAAY,EAAW,EAAE,CAC1E,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,cAAc,GAAG,CAAC,MAA2B,EAAE,IAAY,EAAW,EAAE,CAC5E,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;IAC/C,CAAC,MAAM,CAAC,QAAQ;IAChB,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;IAClD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC;AAEhC;;;;GAIG;AACH,MAAM,YAAY,GAAG,CAAC,IAAa,EAAW,EAAE;IAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,CAAW,CAAC;IAE9D,OAAO,CACL,KAAK,CAAC,MAAM,GAAG,CAAC;QAChB,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC,CAAC"}