@blumintinc/eslint-plugin-blumint 1.13.0 → 1.14.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.
- package/README.md +170 -139
- package/lib/index.js +190 -1
- package/lib/rules/array-methods-this-context.js +1 -1
- package/lib/rules/class-methods-read-top-to-bottom.js +24 -5
- package/lib/rules/consistent-callback-naming.js +1 -1
- package/lib/rules/dynamic-https-errors.js +3 -4
- package/lib/rules/enforce-assert-safe-object-key.js +11 -11
- package/lib/rules/enforce-boolean-naming-prefixes.js +11 -23
- package/lib/rules/enforce-callback-memo.js +1 -1
- package/lib/rules/enforce-centralized-mock-firestore.js +1 -1
- package/lib/rules/enforce-console-error.js +35 -7
- package/lib/rules/enforce-dynamic-file-naming.d.ts +2 -0
- package/lib/rules/enforce-dynamic-file-naming.js +53 -28
- package/lib/rules/enforce-early-destructuring.d.ts +2 -0
- package/lib/rules/enforce-early-destructuring.js +980 -0
- package/lib/rules/enforce-empty-object-check.d.ts +11 -0
- package/lib/rules/enforce-empty-object-check.js +502 -0
- package/lib/rules/enforce-exported-function-types.js +1 -1
- package/lib/rules/enforce-fieldpath-syntax-in-docsetter.js +100 -50
- package/lib/rules/enforce-firestore-doc-ref-generic.js +15 -3
- package/lib/rules/enforce-firestore-facade.js +4 -2
- package/lib/rules/enforce-firestore-set-merge.js +3 -4
- package/lib/rules/enforce-global-constants.js +1 -1
- package/lib/rules/enforce-identifiable-firestore-type.js +108 -58
- package/lib/rules/enforce-memoize-async.js +2 -6
- package/lib/rules/enforce-memoize-getters.js +39 -15
- package/lib/rules/enforce-microdiff.js +1 -1
- package/lib/rules/enforce-object-literal-as-const.js +4 -4
- package/lib/rules/enforce-positive-naming.js +4 -0
- package/lib/rules/enforce-props-argument-name.js +2 -2
- package/lib/rules/enforce-safe-stringify.js +1 -1
- package/lib/rules/enforce-serializable-params.js +3 -3
- package/lib/rules/enforce-singular-type-names.js +1 -1
- package/lib/rules/enforce-stable-hash-spread-props.d.ts +13 -0
- package/lib/rules/enforce-stable-hash-spread-props.js +342 -0
- package/lib/rules/enforce-storage-context.d.ts +9 -0
- package/lib/rules/enforce-storage-context.js +646 -0
- package/lib/rules/enforce-timestamp-now.js +23 -7
- package/lib/rules/enforce-transform-memoization.d.ts +4 -0
- package/lib/rules/enforce-transform-memoization.js +416 -0
- package/lib/rules/enforce-typescript-markdown-code-blocks.js +7 -3
- package/lib/rules/enforce-unique-cursor-headers.d.ts +16 -0
- package/lib/rules/enforce-unique-cursor-headers.js +365 -0
- package/lib/rules/enforce-verb-noun-naming.js +5 -4
- package/lib/rules/ensure-pointer-events-none.js +28 -2
- package/lib/rules/export-if-in-doubt.js +27 -4
- package/lib/rules/extract-global-constants.js +40 -13
- package/lib/rules/fast-deep-equal-over-microdiff.js +29 -39
- package/lib/rules/firestore-transaction-reads-before-writes.js +50 -4
- package/lib/rules/flatten-push-calls.d.ts +2 -0
- package/lib/rules/flatten-push-calls.js +428 -0
- package/lib/rules/global-const-style.js +50 -19
- package/lib/rules/jsdoc-above-field.d.ts +11 -0
- package/lib/rules/jsdoc-above-field.js +208 -0
- package/lib/rules/key-only-outermost-element.js +21 -3
- package/lib/rules/logical-top-to-bottom-grouping.d.ts +5 -0
- package/lib/rules/logical-top-to-bottom-grouping.js +1258 -0
- package/lib/rules/memo-compare-deeply-complex-props.d.ts +3 -0
- package/lib/rules/memo-compare-deeply-complex-props.js +788 -0
- package/lib/rules/memo-nested-react-components.d.ts +8 -0
- package/lib/rules/memo-nested-react-components.js +410 -0
- package/lib/rules/no-always-true-false-conditions.d.ts +2 -1
- package/lib/rules/no-always-true-false-conditions.js +68 -8
- package/lib/rules/no-array-length-in-deps.js +9 -3
- package/lib/rules/no-async-foreach.js +210 -12
- package/lib/rules/no-circular-references.js +18 -17
- package/lib/rules/no-class-instance-destructuring.js +55 -12
- package/lib/rules/no-complex-cloud-params.js +7 -3
- package/lib/rules/no-compositing-layer-props.js +2 -2
- package/lib/rules/no-conditional-literals-in-jsx.js +37 -12
- package/lib/rules/no-console-error.d.ts +9 -0
- package/lib/rules/no-console-error.js +525 -0
- package/lib/rules/no-curly-brackets-around-commented-properties.d.ts +2 -0
- package/lib/rules/no-curly-brackets-around-commented-properties.js +258 -0
- package/lib/rules/no-empty-dependency-use-callbacks.d.ts +11 -0
- package/lib/rules/no-empty-dependency-use-callbacks.js +576 -0
- package/lib/rules/no-entire-object-hook-deps.js +4 -6
- package/lib/rules/no-excessive-parent-chain.js +1 -1
- package/lib/rules/no-explicit-return-type.d.ts +2 -1
- package/lib/rules/no-explicit-return-type.js +215 -26
- package/lib/rules/no-filter-without-return.js +5 -1
- package/lib/rules/no-firestore-jest-mock.d.ts +2 -1
- package/lib/rules/no-firestore-jest-mock.js +126 -8
- package/lib/rules/no-firestore-object-arrays.js +67 -12
- package/lib/rules/no-handler-suffix.d.ts +12 -0
- package/lib/rules/no-handler-suffix.js +305 -0
- package/lib/rules/no-hungarian.js +1 -1
- package/lib/rules/no-inline-component-prop.d.ts +10 -0
- package/lib/rules/no-inline-component-prop.js +456 -0
- package/lib/rules/no-jsx-in-hooks.js +6 -1
- package/lib/rules/no-jsx-whitespace-literal.js +8 -2
- package/lib/rules/no-margin-properties.js +6 -6
- package/lib/rules/no-memoize-on-static.js +9 -1
- package/lib/rules/no-misleading-boolean-prefixes.js +7 -3
- package/lib/rules/no-misused-switch-case.js +22 -1
- package/lib/rules/no-mixed-firestore-transactions.d.ts +3 -1
- package/lib/rules/no-mixed-firestore-transactions.js +296 -34
- package/lib/rules/no-mock-firebase-admin.js +5 -2
- package/lib/rules/no-object-values-on-strings.js +10 -2
- package/lib/rules/no-overridable-method-calls-in-constructor.js +29 -17
- package/lib/rules/no-passthrough-getters.js +38 -2
- package/lib/rules/no-redundant-annotation-assertion.d.ts +2 -0
- package/lib/rules/no-redundant-annotation-assertion.js +402 -0
- package/lib/rules/no-redundant-param-types.js +16 -6
- package/lib/rules/no-redundant-this-params.d.ts +3 -0
- package/lib/rules/no-redundant-this-params.js +459 -0
- package/lib/rules/no-redundant-usecallback-wrapper.js +16 -3
- package/lib/rules/no-res-error-status-in-onrequest.d.ts +4 -0
- package/lib/rules/no-res-error-status-in-onrequest.js +521 -0
- package/lib/rules/no-restricted-properties-fix.js +11 -10
- package/lib/rules/no-separate-loading-state.js +7 -16
- package/lib/rules/no-stale-state-across-await.js +1 -1
- package/lib/rules/no-type-assertion-returns.js +43 -49
- package/lib/rules/no-undefined-null-passthrough.js +61 -31
- package/lib/rules/no-unmemoized-memo-without-props.d.ts +8 -0
- package/lib/rules/no-unmemoized-memo-without-props.js +426 -0
- package/lib/rules/no-unnecessary-destructuring-rename.d.ts +2 -0
- package/lib/rules/no-unnecessary-destructuring-rename.js +347 -0
- package/lib/rules/no-unnecessary-destructuring.js +14 -4
- package/lib/rules/no-unnecessary-verb-suffix.js +2 -1
- package/lib/rules/no-unpinned-dependencies.js +36 -5
- package/lib/rules/no-unused-props.d.ts +2 -2
- package/lib/rules/no-unused-props.js +295 -91
- package/lib/rules/no-unused-usestate.js +6 -2
- package/lib/rules/no-useless-fragment.js +28 -2
- package/lib/rules/no-useless-usememo-primitives.d.ts +9 -0
- package/lib/rules/no-useless-usememo-primitives.js +393 -0
- package/lib/rules/no-usememo-for-pass-by-value.d.ts +13 -0
- package/lib/rules/no-usememo-for-pass-by-value.js +757 -0
- package/lib/rules/no-uuidv4-base62-as-key.js +18 -13
- package/lib/rules/omit-index-html.d.ts +2 -1
- package/lib/rules/omit-index-html.js +62 -7
- package/lib/rules/optimize-object-boolean-conditions.js +6 -4
- package/lib/rules/parallelize-async-operations.js +24 -5
- package/lib/rules/prefer-batch-operations.d.ts +1 -3
- package/lib/rules/prefer-batch-operations.js +32 -5
- package/lib/rules/prefer-block-comments-for-declarations.js +9 -4
- package/lib/rules/prefer-clone-deep.js +3 -3
- package/lib/rules/prefer-destructuring-no-class.d.ts +2 -1
- package/lib/rules/prefer-destructuring-no-class.js +244 -59
- package/lib/rules/prefer-docsetter-setall.d.ts +2 -0
- package/lib/rules/prefer-docsetter-setall.js +243 -0
- package/lib/rules/prefer-field-paths-in-transforms.js +4 -3
- package/lib/rules/prefer-fragment-component.js +1 -1
- package/lib/rules/prefer-fragment-shorthand.js +2 -1
- package/lib/rules/prefer-getter-over-parameterless-method.d.ts +13 -0
- package/lib/rules/prefer-getter-over-parameterless-method.js +648 -0
- package/lib/rules/prefer-global-router-state-key.js +88 -13
- package/lib/rules/prefer-memoized-props.d.ts +3 -0
- package/lib/rules/prefer-memoized-props.js +445 -0
- package/lib/rules/prefer-next-dynamic.js +60 -69
- package/lib/rules/prefer-nullish-coalescing-boolean-props.js +9 -4
- package/lib/rules/prefer-nullish-coalescing-override.d.ts +2 -1
- package/lib/rules/prefer-nullish-coalescing-override.js +11 -5
- package/lib/rules/prefer-params-over-parent-id.js +220 -171
- package/lib/rules/prefer-settings-object.js +2 -2
- package/lib/rules/prefer-type-over-interface.js +7 -2
- package/lib/rules/prefer-url-tostring-over-tojson.js +6 -3
- package/lib/rules/prefer-use-deep-compare-memo.js +8 -5
- package/lib/rules/prefer-usecallback-over-usememo-for-functions.js +1 -1
- package/lib/rules/prefer-utility-function-over-private-static.js +34 -2
- package/lib/rules/prevent-children-clobber.d.ts +2 -0
- package/lib/rules/prevent-children-clobber.js +536 -0
- package/lib/rules/react-memoize-literals.d.ts +4 -0
- package/lib/rules/react-memoize-literals.js +495 -0
- package/lib/rules/react-usememo-should-be-component.js +2 -2
- package/lib/rules/require-hooks-default-params.js +17 -16
- package/lib/rules/require-https-error-cause.d.ts +4 -0
- package/lib/rules/require-https-error-cause.js +136 -0
- package/lib/rules/require-https-error.js +43 -21
- package/lib/rules/require-image-optimized.js +1 -1
- package/lib/rules/require-memo.js +1 -1
- package/lib/rules/require-memoize-jsx-returners.d.ts +3 -0
- package/lib/rules/require-memoize-jsx-returners.js +485 -0
- package/lib/rules/require-usememo-object-literals.js +2 -3
- package/lib/rules/test-file-location-enforcement.js +1 -1
- package/lib/rules/use-latest-callback.js +6 -5
- package/lib/rules/vertically-group-related-functions.d.ts +16 -0
- package/lib/rules/vertically-group-related-functions.js +480 -0
- package/lib/utils/ASTHelpers.d.ts +13 -1
- package/lib/utils/ASTHelpers.js +24 -0
- package/lib/utils/getMethodName.d.ts +27 -0
- package/lib/utils/getMethodName.js +35 -0
- package/lib/utils/tsTypeClassifier.d.ts +30 -0
- package/lib/utils/tsTypeClassifier.js +149 -0
- package/package.json +3 -1
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.classifyExpressionType = exports.classifyType = exports.describeTypeKind = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Describes the kind of a primitive type for error messages.
|
|
6
|
+
*/
|
|
7
|
+
function describeTypeKind(t, tsModule, options) {
|
|
8
|
+
if (t.isUnion()) {
|
|
9
|
+
const kinds = new Set(t.types
|
|
10
|
+
.map((part) => describeTypeKind(part, tsModule, options))
|
|
11
|
+
.filter((k) => k !== 'primitive value'));
|
|
12
|
+
if (kinds.size === 0) {
|
|
13
|
+
return 'primitive value';
|
|
14
|
+
}
|
|
15
|
+
if (kinds.size === 1) {
|
|
16
|
+
return kinds.values().next().value ?? 'primitive value';
|
|
17
|
+
}
|
|
18
|
+
// Multiple distinct primitive kinds
|
|
19
|
+
const sortedKinds = Array.from(kinds).sort();
|
|
20
|
+
return `${sortedKinds.join(' or ')}`;
|
|
21
|
+
}
|
|
22
|
+
const flags = t.flags;
|
|
23
|
+
if (flags & tsModule.TypeFlags.String)
|
|
24
|
+
return 'string value';
|
|
25
|
+
if (flags & tsModule.TypeFlags.StringLiteral)
|
|
26
|
+
return 'string value';
|
|
27
|
+
if (flags & tsModule.TypeFlags.TemplateLiteral)
|
|
28
|
+
return 'string value';
|
|
29
|
+
if (flags & tsModule.TypeFlags.Number)
|
|
30
|
+
return 'number value';
|
|
31
|
+
if (flags & tsModule.TypeFlags.NumberLiteral)
|
|
32
|
+
return 'number value';
|
|
33
|
+
if (flags & tsModule.TypeFlags.Enum)
|
|
34
|
+
return 'number value';
|
|
35
|
+
if (flags & tsModule.TypeFlags.EnumLiteral)
|
|
36
|
+
return 'number value';
|
|
37
|
+
if (flags & tsModule.TypeFlags.Boolean)
|
|
38
|
+
return 'boolean value';
|
|
39
|
+
if (flags & tsModule.TypeFlags.BooleanLiteral)
|
|
40
|
+
return 'boolean value';
|
|
41
|
+
if (flags & tsModule.TypeFlags.BigInt)
|
|
42
|
+
return 'bigint value';
|
|
43
|
+
if (flags & tsModule.TypeFlags.BigIntLiteral)
|
|
44
|
+
return 'bigint value';
|
|
45
|
+
if (flags & tsModule.TypeFlags.Null)
|
|
46
|
+
return 'null value';
|
|
47
|
+
if (flags & tsModule.TypeFlags.Undefined)
|
|
48
|
+
return 'undefined value';
|
|
49
|
+
if (flags &
|
|
50
|
+
(tsModule.TypeFlags.ESSymbol | tsModule.TypeFlags.UniqueESSymbol)) {
|
|
51
|
+
return 'symbol value';
|
|
52
|
+
}
|
|
53
|
+
return 'primitive value';
|
|
54
|
+
}
|
|
55
|
+
exports.describeTypeKind = describeTypeKind;
|
|
56
|
+
/**
|
|
57
|
+
* Classifies a TypeScript type as primitive, non-primitive, or unknown.
|
|
58
|
+
*/
|
|
59
|
+
function classifyType(t, tsModule, options) {
|
|
60
|
+
if (t.isUnion()) {
|
|
61
|
+
let sawUnknown = false;
|
|
62
|
+
for (const part of t.types) {
|
|
63
|
+
const result = classifyType(part, tsModule, options);
|
|
64
|
+
if (result === 'non-primitive') {
|
|
65
|
+
return 'non-primitive';
|
|
66
|
+
}
|
|
67
|
+
if (result === 'unknown') {
|
|
68
|
+
sawUnknown = true;
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
return sawUnknown ? 'unknown' : 'primitive';
|
|
72
|
+
}
|
|
73
|
+
if (t.isIntersection())
|
|
74
|
+
return 'non-primitive';
|
|
75
|
+
const flags = t.getFlags();
|
|
76
|
+
if (flags &
|
|
77
|
+
(tsModule.TypeFlags.Any |
|
|
78
|
+
tsModule.TypeFlags.Unknown |
|
|
79
|
+
tsModule.TypeFlags.Never |
|
|
80
|
+
tsModule.TypeFlags.TypeParameter)) {
|
|
81
|
+
return 'unknown';
|
|
82
|
+
}
|
|
83
|
+
if (flags &
|
|
84
|
+
(tsModule.TypeFlags.Object |
|
|
85
|
+
tsModule.TypeFlags.NonPrimitive |
|
|
86
|
+
tsModule.TypeFlags.Index |
|
|
87
|
+
tsModule.TypeFlags.IndexedAccess |
|
|
88
|
+
tsModule.TypeFlags.Conditional |
|
|
89
|
+
tsModule.TypeFlags.Substitution)) {
|
|
90
|
+
return 'non-primitive';
|
|
91
|
+
}
|
|
92
|
+
if (flags & tsModule.TypeFlags.Void) {
|
|
93
|
+
return 'unknown';
|
|
94
|
+
}
|
|
95
|
+
if (flags &
|
|
96
|
+
(tsModule.TypeFlags.ESSymbol | tsModule.TypeFlags.UniqueESSymbol)) {
|
|
97
|
+
return options.ignoreSymbol ? 'non-primitive' : 'primitive';
|
|
98
|
+
}
|
|
99
|
+
if (flags &
|
|
100
|
+
(tsModule.TypeFlags.String |
|
|
101
|
+
tsModule.TypeFlags.StringLiteral |
|
|
102
|
+
tsModule.TypeFlags.TemplateLiteral |
|
|
103
|
+
tsModule.TypeFlags.Number |
|
|
104
|
+
tsModule.TypeFlags.NumberLiteral |
|
|
105
|
+
tsModule.TypeFlags.Enum |
|
|
106
|
+
tsModule.TypeFlags.EnumLiteral |
|
|
107
|
+
tsModule.TypeFlags.Boolean |
|
|
108
|
+
tsModule.TypeFlags.BooleanLiteral |
|
|
109
|
+
tsModule.TypeFlags.BigInt |
|
|
110
|
+
tsModule.TypeFlags.BigIntLiteral |
|
|
111
|
+
tsModule.TypeFlags.Null |
|
|
112
|
+
tsModule.TypeFlags.Undefined)) {
|
|
113
|
+
return 'primitive';
|
|
114
|
+
}
|
|
115
|
+
return 'unknown';
|
|
116
|
+
}
|
|
117
|
+
exports.classifyType = classifyType;
|
|
118
|
+
/**
|
|
119
|
+
* Classifies the type of an expression using TypeScript's type checker.
|
|
120
|
+
*/
|
|
121
|
+
function classifyExpressionType(expr, { checker, tsModule, parserServices, options, }) {
|
|
122
|
+
try {
|
|
123
|
+
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(expr);
|
|
124
|
+
if (!tsNode) {
|
|
125
|
+
/* istanbul ignore next -- rare when parser services mismatch */
|
|
126
|
+
return { status: 'unknown', kind: 'unknown value' };
|
|
127
|
+
}
|
|
128
|
+
const type = checker.getTypeAtLocation(tsNode);
|
|
129
|
+
const classification = classifyType(type, tsModule, options);
|
|
130
|
+
if (classification === 'primitive') {
|
|
131
|
+
return {
|
|
132
|
+
status: 'primitive',
|
|
133
|
+
kind: describeTypeKind(type, tsModule, options),
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
return {
|
|
137
|
+
status: classification,
|
|
138
|
+
kind: classification === 'non-primitive'
|
|
139
|
+
? 'non-primitive value'
|
|
140
|
+
: 'unknown value',
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
catch {
|
|
144
|
+
/* istanbul ignore next -- defensive fallback when type evaluation fails */
|
|
145
|
+
return { status: 'unknown', kind: 'unknown value' };
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
exports.classifyExpressionType = classifyExpressionType;
|
|
149
|
+
//# sourceMappingURL=tsTypeClassifier.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blumintinc/eslint-plugin-blumint",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.14.0",
|
|
4
4
|
"description": "Custom eslint rules for use within BluMint",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Brodie McGuire",
|
|
@@ -33,6 +33,8 @@
|
|
|
33
33
|
"test": "jest --passWithNoTests --reporters=default --reporters=jest-junit",
|
|
34
34
|
"test:ci": "jest --ci --passWithNoTests --reporters=default --reporters=jest-junit",
|
|
35
35
|
"address-review": "tsx ./.github/scripts/address-review.ts",
|
|
36
|
+
"address-merge-conflicts": "tsx ./.github/scripts/address-merge-conflicts.ts",
|
|
37
|
+
"check-merge-conflicts": "bash ./scripts/check-merge-conflicts.sh",
|
|
36
38
|
"merge-review": "tsx ./.github/scripts/merge-review.ts",
|
|
37
39
|
"fetch-unresolved-comments": "./scripts/pr-check-comments.sh",
|
|
38
40
|
"fetch-unresolved-bot-comments": "./scripts/pr-check-bot-comments.sh",
|