@checkdigit/eslint-plugin 7.7.0 → 7.8.0-PR.79-d6b4
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 +1 -0
- package/dist-mjs/index.mjs +5 -1
- package/dist-mjs/no-enum.mjs +52 -0
- package/dist-types/no-enum.d.ts +5 -0
- package/package.json +1 -96
- package/src/index.ts +4 -0
- package/src/no-enum.ts +68 -0
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@ Copyright (c) 2021-2024 [Check Digit, LLC](https://checkdigit.com)
|
|
|
21
21
|
- `@checkdigit/require-resolve-full-response`
|
|
22
22
|
- `@checkdigit/require-type-out-of-type-only-imports`
|
|
23
23
|
- `@checkdigit/require-ts-extension-imports`
|
|
24
|
+
- `@checkdigit/no-enum`
|
|
24
25
|
|
|
25
26
|
## Configurations
|
|
26
27
|
|
package/dist-mjs/index.mjs
CHANGED
|
@@ -15,6 +15,7 @@ import requireTypeOutOfTypeOnlyImports, {
|
|
|
15
15
|
import noServeRuntime, { ruleId as noServeRuntimeRuleId } from "./no-serve-runtime.mjs";
|
|
16
16
|
import filePathComment from "./file-path-comment.mjs";
|
|
17
17
|
import noCardNumbers from "./no-card-numbers.mjs";
|
|
18
|
+
import noEnum from "./no-enum.mjs";
|
|
18
19
|
import noSideEffects from "./no-side-effects.mjs";
|
|
19
20
|
import noRandomV4UUID from "./no-random-v4-uuid.mjs";
|
|
20
21
|
import noTestImport from "./no-test-import.mjs";
|
|
@@ -28,6 +29,7 @@ import requireTsExtensionImports from "./require-ts-extension-imports.mjs";
|
|
|
28
29
|
var rules = {
|
|
29
30
|
"file-path-comment": filePathComment,
|
|
30
31
|
"no-card-numbers": noCardNumbers,
|
|
32
|
+
"no-enum": noEnum,
|
|
31
33
|
"no-random-v4-uuid": noRandomV4UUID,
|
|
32
34
|
"no-uuid": noUuid,
|
|
33
35
|
"require-strict-assert": requireStrictAssert,
|
|
@@ -59,6 +61,7 @@ var configs = {
|
|
|
59
61
|
},
|
|
60
62
|
rules: {
|
|
61
63
|
"@checkdigit/no-card-numbers": "error",
|
|
64
|
+
"@checkdigit/no-enum": "error",
|
|
62
65
|
"@checkdigit/file-path-comment": "error",
|
|
63
66
|
"@checkdigit/no-random-v4-uuid": "error",
|
|
64
67
|
"@checkdigit/no-uuid": "error",
|
|
@@ -89,6 +92,7 @@ var configs = {
|
|
|
89
92
|
},
|
|
90
93
|
rules: {
|
|
91
94
|
"@checkdigit/no-card-numbers": "error",
|
|
95
|
+
"@checkdigit/no-enum": "error",
|
|
92
96
|
"@checkdigit/file-path-comment": "off",
|
|
93
97
|
"@checkdigit/no-random-v4-uuid": "error",
|
|
94
98
|
"@checkdigit/no-uuid": "error",
|
|
@@ -120,4 +124,4 @@ var src_default = defaultToExport;
|
|
|
120
124
|
export {
|
|
121
125
|
src_default as default
|
|
122
126
|
};
|
|
123
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
127
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8seUJBQXlCLFVBQVUsbUNBQW1DO0FBQzdFLE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU8scUJBQXFCO0FBQzVCLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sWUFBWTtBQUNuQixPQUFPLG1CQUFtQjtBQUMxQixPQUFPLG9CQUFvQjtBQUMzQixPQUFPLGtCQUFrQjtBQUN6QixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFDaEMsT0FBTywrQkFBK0I7QUFFdEMsSUFBTSxRQUFzRDtBQUFBLEVBQzFELHFCQUFxQjtBQUFBLEVBQ3JCLG1CQUFtQjtBQUFBLEVBQ25CLFdBQVc7QUFBQSxFQUNYLHFCQUFxQjtBQUFBLEVBQ3JCLFdBQVc7QUFBQSxFQUNYLHlCQUF5QjtBQUFBLEVBQ3pCLGdDQUFnQztBQUFBLEVBQ2hDLGtCQUFrQjtBQUFBLEVBQ2xCLHNCQUFzQjtBQUFBLEVBQ3RCLG1CQUFtQjtBQUFBLEVBQ25CLDhCQUE4QjtBQUFBLEVBQzlCLDJDQUEyQztBQUFBLEVBQzNDLDJCQUEyQjtBQUFBLEVBQzNCLENBQUMsMEJBQTBCLEdBQUc7QUFBQSxFQUM5QixDQUFDLDZCQUE2QixHQUFHO0FBQUEsRUFDakMsQ0FBQywyQkFBMkIsR0FBRztBQUFBLEVBQy9CLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxvQkFBb0IsR0FBRztBQUFBLEVBQ3hCLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHFDQUFxQyxHQUFHO0FBQzNDO0FBRUEsSUFBTSxTQUFxQztBQUFBLEVBQ3pDO0FBQ0Y7QUFFQSxJQUFNLFVBQXdEO0FBQUEsRUFDNUQsS0FBSztBQUFBLElBQ0g7QUFBQSxNQUNFLE9BQU8sQ0FBQyxTQUFTO0FBQUEsTUFDakIsU0FBUztBQUFBLFFBQ1AsZUFBZTtBQUFBLE1BQ2pCO0FBQUEsTUFDQSxPQUFPO0FBQUEsUUFDTCwrQkFBK0I7QUFBQSxRQUMvQix1QkFBdUI7QUFBQSxRQUN2QixpQ0FBaUM7QUFBQSxRQUNqQyxpQ0FBaUM7QUFBQSxRQUNqQyx1QkFBdUI7QUFBQSxRQUN2QixxQ0FBcUM7QUFBQSxRQUNyQyw0Q0FBNEM7QUFBQSxRQUM1QyxrQ0FBa0M7QUFBQSxRQUNsQywrQkFBK0IsQ0FBQyxTQUFTLEVBQUUscUJBQXFCLENBQUMsVUFBVSxTQUFTLE9BQU8sV0FBVyxFQUFFLENBQUM7QUFBQSxRQUN6RywwQ0FBMEM7QUFBQSxRQUMxQyx1REFBdUQ7QUFBQSxRQUN2RCx1Q0FBdUM7QUFBQSxRQUN2Qyw4QkFBOEI7QUFBQSxRQUM5QixDQUFDLGVBQWUsMEJBQTBCLEVBQUUsR0FBRztBQUFBLFFBQy9DLENBQUMsZUFBZSw2QkFBNkIsRUFBRSxHQUFHO0FBQUEsUUFDbEQsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsZ0NBQWdDLEVBQUUsR0FBRztBQUFBLFFBQ3JELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsUUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLFFBQzFELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsTUFDM0M7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUFBLEVBQ0EsYUFBYTtBQUFBLElBQ1g7QUFBQSxNQUNFLE9BQU8sQ0FBQyxTQUFTO0FBQUEsTUFDakIsU0FBUztBQUFBLFFBQ1AsZUFBZTtBQUFBLE1BQ2pCO0FBQUEsTUFDQSxPQUFPO0FBQUEsUUFDTCwrQkFBK0I7QUFBQSxRQUMvQix1QkFBdUI7QUFBQSxRQUN2QixpQ0FBaUM7QUFBQSxRQUNqQyxpQ0FBaUM7QUFBQSxRQUNqQyx1QkFBdUI7QUFBQSxRQUN2QixxQ0FBcUM7QUFBQSxRQUNyQyw0Q0FBNEM7QUFBQSxRQUM1QyxrQ0FBa0M7QUFBQSxRQUNsQywrQkFBK0I7QUFBQSxRQUMvQiwwQ0FBMEM7QUFBQSxRQUMxQyx1REFBdUQ7QUFBQSxRQUN2RCx1Q0FBdUM7QUFBQSxRQUN2Qyw4QkFBOEI7QUFBQSxRQUM5QixDQUFDLGVBQWUsMEJBQTBCLEVBQUUsR0FBRztBQUFBLFFBQy9DLENBQUMsZUFBZSw2QkFBNkIsRUFBRSxHQUFHO0FBQUEsUUFDbEQsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsZ0NBQWdDLEVBQUUsR0FBRztBQUFBLFFBQ3JELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsUUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLFFBQzFELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsTUFDM0M7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUNGO0FBRUEsSUFBTSxrQkFFRjtBQUFBLEVBQ0YsR0FBRztBQUFBLEVBQ0g7QUFDRjtBQUNBLElBQU8sY0FBUTsiLAogICJuYW1lcyI6IFtdCn0K
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// src/no-enum.ts
|
|
2
|
+
import { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
|
|
3
|
+
var ruleId = "no-enum";
|
|
4
|
+
var NO_ENUM = "NO_ENUM";
|
|
5
|
+
var createRule = ESLintUtils.RuleCreator((name) => name);
|
|
6
|
+
function isJsonSchemaProperty(node) {
|
|
7
|
+
if (!node) {
|
|
8
|
+
return false;
|
|
9
|
+
}
|
|
10
|
+
if (node.type === TSESTree.AST_NODE_TYPES.Property && node.key.type === TSESTree.AST_NODE_TYPES.Identifier && node.key.name === "properties") {
|
|
11
|
+
return true;
|
|
12
|
+
}
|
|
13
|
+
return isJsonSchemaProperty(node.parent);
|
|
14
|
+
}
|
|
15
|
+
var rule = createRule({
|
|
16
|
+
name: ruleId,
|
|
17
|
+
meta: {
|
|
18
|
+
type: "problem",
|
|
19
|
+
docs: {
|
|
20
|
+
description: "Disallow the use of `enum` in TypeScript"
|
|
21
|
+
},
|
|
22
|
+
schema: [],
|
|
23
|
+
messages: {
|
|
24
|
+
[NO_ENUM]: "Avoid using `enum` in TypeScript."
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
defaultOptions: [],
|
|
28
|
+
create(context) {
|
|
29
|
+
return {
|
|
30
|
+
TSEnumDeclaration(node) {
|
|
31
|
+
context.report({
|
|
32
|
+
node,
|
|
33
|
+
messageId: NO_ENUM
|
|
34
|
+
});
|
|
35
|
+
},
|
|
36
|
+
Property(node) {
|
|
37
|
+
if (node.key.type === TSESTree.AST_NODE_TYPES.Identifier && node.key.name === "enum" && node.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression && !isJsonSchemaProperty(node.parent)) {
|
|
38
|
+
context.report({
|
|
39
|
+
node,
|
|
40
|
+
messageId: NO_ENUM
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
var no_enum_default = rule;
|
|
48
|
+
export {
|
|
49
|
+
no_enum_default as default,
|
|
50
|
+
ruleId
|
|
51
|
+
};
|
|
52
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL25vLWVudW0udHMiXSwKICAibWFwcGluZ3MiOiAiO0FBUUEsU0FBUyxhQUFhLGdCQUFnQjtBQUUvQixJQUFNLFNBQVM7QUFDdEIsSUFBTSxVQUFVO0FBRWhCLElBQU0sYUFBYSxZQUFZLFlBQVksQ0FBQyxTQUFTLElBQUk7QUFFekQsU0FBUyxxQkFBcUIsTUFBK0I7QUFDM0QsTUFBSSxDQUFDLE1BQU07QUFDVCxXQUFPO0FBQUEsRUFDVDtBQUNBLE1BQ0UsS0FBSyxTQUFTLFNBQVMsZUFBZSxZQUN0QyxLQUFLLElBQUksU0FBUyxTQUFTLGVBQWUsY0FDMUMsS0FBSyxJQUFJLFNBQVMsY0FDbEI7QUFDQSxXQUFPO0FBQUEsRUFDVDtBQUNBLFNBQU8scUJBQXFCLEtBQUssTUFBTTtBQUN6QztBQUVBLElBQU0sT0FBK0MsV0FBVztBQUFBLEVBQzlELE1BQU07QUFBQSxFQUNOLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxJQUNOLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxJQUNmO0FBQUEsSUFDQSxRQUFRLENBQUM7QUFBQSxJQUNULFVBQVU7QUFBQSxNQUNSLENBQUMsT0FBTyxHQUFHO0FBQUEsSUFDYjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGdCQUFnQixDQUFDO0FBQUEsRUFDakIsT0FBTyxTQUFTO0FBQ2QsV0FBTztBQUFBLE1BQ0wsa0JBQWtCLE1BQWtDO0FBQ2xELGdCQUFRLE9BQU87QUFBQSxVQUNiO0FBQUEsVUFDQSxXQUFXO0FBQUEsUUFDYixDQUFDO0FBQUEsTUFDSDtBQUFBLE1BQ0EsU0FBUyxNQUF5QjtBQUNoQyxZQUNFLEtBQUssSUFBSSxTQUFTLFNBQVMsZUFBZSxjQUMxQyxLQUFLLElBQUksU0FBUyxVQUNsQixLQUFLLE1BQU0sU0FBUyxTQUFTLGVBQWUsbUJBQzVDLENBQUMscUJBQXFCLEtBQUssTUFBTSxHQUNqQztBQUNBLGtCQUFRLE9BQU87QUFBQSxZQUNiO0FBQUEsWUFDQSxXQUFXO0FBQUEsVUFDYixDQUFDO0FBQUEsUUFDSDtBQUFBLE1BQ0Y7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUNGLENBQUM7QUFFRCxJQUFPLGtCQUFROyIsCiAgIm5hbWVzIjogW10KfQo=
|
package/package.json
CHANGED
|
@@ -1,96 +1 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@checkdigit/eslint-plugin",
|
|
3
|
-
"version": "7.7.0",
|
|
4
|
-
"description": "Check Digit eslint plugins",
|
|
5
|
-
"keywords": [
|
|
6
|
-
"eslint",
|
|
7
|
-
"eslintplugin"
|
|
8
|
-
],
|
|
9
|
-
"homepage": "https://github.com/checkdigit/eslint-plugin#readme",
|
|
10
|
-
"bugs": {
|
|
11
|
-
"url": "https://github.com/checkdigit/eslint-plugin/issues"
|
|
12
|
-
},
|
|
13
|
-
"repository": {
|
|
14
|
-
"type": "git",
|
|
15
|
-
"url": "https://github.com/checkdigit/eslint-plugin"
|
|
16
|
-
},
|
|
17
|
-
"license": "MIT",
|
|
18
|
-
"author": "Check Digit, LLC",
|
|
19
|
-
"sideEffects": false,
|
|
20
|
-
"type": "module",
|
|
21
|
-
"exports": {
|
|
22
|
-
".": {
|
|
23
|
-
"types": "./dist-types/index.d.ts",
|
|
24
|
-
"import": "./dist-mjs/index.mjs",
|
|
25
|
-
"default": "./dist-mjs/index.mjs"
|
|
26
|
-
}
|
|
27
|
-
},
|
|
28
|
-
"files": [
|
|
29
|
-
"src",
|
|
30
|
-
"dist-types",
|
|
31
|
-
"dist-mjs",
|
|
32
|
-
"!src/**/test/**",
|
|
33
|
-
"!src/**/*.test.ts",
|
|
34
|
-
"!src/**/*.spec.ts",
|
|
35
|
-
"!dist-types/**/test/**",
|
|
36
|
-
"!dist-types/**/*.test.d.ts",
|
|
37
|
-
"!dist-types/**/*.spec.d.ts",
|
|
38
|
-
"!dist-mjs/**/test/**",
|
|
39
|
-
"!dist-mjs/**/*.test.mjs",
|
|
40
|
-
"!dist-mjs/**/*.spec.mjs",
|
|
41
|
-
"SECURITY.md"
|
|
42
|
-
],
|
|
43
|
-
"scripts": {
|
|
44
|
-
"build:dist-mjs": "rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs",
|
|
45
|
-
"build:dist-types": "rimraf dist-types && npx builder --type=types --outDir=dist-types",
|
|
46
|
-
"ci:compile": "tsc --noEmit",
|
|
47
|
-
"ci:coverage": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true",
|
|
48
|
-
"ci:lint": "npm run lint",
|
|
49
|
-
"ci:style": "npm run prettier",
|
|
50
|
-
"ci:test": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false",
|
|
51
|
-
"lint": "eslint --max-warnings 0 .",
|
|
52
|
-
"lint:fix": "eslint --max-warnings 0 --fix .",
|
|
53
|
-
"prepare": "",
|
|
54
|
-
"prepublishOnly": "npm run build:dist-types && npm run build:dist-mjs",
|
|
55
|
-
"prettier": "prettier --ignore-path .gitignore --list-different .",
|
|
56
|
-
"prettier:fix": "prettier --ignore-path .gitignore --write .",
|
|
57
|
-
"test": "npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"
|
|
58
|
-
},
|
|
59
|
-
"prettier": "@checkdigit/prettier-config",
|
|
60
|
-
"jest": {
|
|
61
|
-
"preset": "@checkdigit/jest-config"
|
|
62
|
-
},
|
|
63
|
-
"dependencies": {
|
|
64
|
-
"@typescript-eslint/type-utils": "^8.18.1",
|
|
65
|
-
"@typescript-eslint/utils": "^8.18.1",
|
|
66
|
-
"ts-api-utils": "^2.0.0"
|
|
67
|
-
},
|
|
68
|
-
"devDependencies": {
|
|
69
|
-
"@checkdigit/jest-config": "^6.0.2",
|
|
70
|
-
"@checkdigit/prettier-config": "^6.0.0",
|
|
71
|
-
"@checkdigit/typescript-config": "^9.0.0",
|
|
72
|
-
"@eslint/js": "^9.17.0",
|
|
73
|
-
"@types/eslint": "^9.6.1",
|
|
74
|
-
"@types/eslint-config-prettier": "^6.11.3",
|
|
75
|
-
"@typescript-eslint/parser": "^8.18.1",
|
|
76
|
-
"@typescript-eslint/rule-tester": "^8.18.1",
|
|
77
|
-
"eslint": "^9.17.0",
|
|
78
|
-
"eslint-config-prettier": "^9.1.0",
|
|
79
|
-
"eslint-import-resolver-typescript": "^3.7.0",
|
|
80
|
-
"eslint-plugin-eslint-plugin": "^6.3.2",
|
|
81
|
-
"eslint-plugin-import": "^2.31.0",
|
|
82
|
-
"eslint-plugin-no-only-tests": "^3.3.0",
|
|
83
|
-
"eslint-plugin-no-secrets": "^2.1.1",
|
|
84
|
-
"eslint-plugin-node": "^11.1.0",
|
|
85
|
-
"eslint-plugin-sonarjs": "1.0.4",
|
|
86
|
-
"http-status-codes": "^2.3.0",
|
|
87
|
-
"rimraf": "^6.0.1",
|
|
88
|
-
"typescript-eslint": "^8.18.1"
|
|
89
|
-
},
|
|
90
|
-
"peerDependencies": {
|
|
91
|
-
"eslint": ">=9 <10"
|
|
92
|
-
},
|
|
93
|
-
"engines": {
|
|
94
|
-
"node": ">=20.17"
|
|
95
|
-
}
|
|
96
|
-
}
|
|
1
|
+
{"name":"@checkdigit/eslint-plugin","version":"7.8.0-PR.79-d6b4","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 .","lint:fix":"eslint --max-warnings 0 --fix .","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"dependencies":{"@typescript-eslint/type-utils":"^8.18.1","@typescript-eslint/utils":"^8.18.1","ts-api-utils":"^2.0.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^6.0.0","@checkdigit/typescript-config":"^9.0.0","@eslint/js":"^9.17.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.18.1","@typescript-eslint/rule-tester":"^8.18.1","eslint":"^9.17.0","eslint-config-prettier":"^9.1.0","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-eslint-plugin":"^6.3.2","eslint-plugin-import":"^2.31.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^2.1.1","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","http-status-codes":"^2.3.0","rimraf":"^6.0.1","typescript-eslint":"^8.18.1"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=20.17"}}
|
package/src/index.ts
CHANGED
|
@@ -24,6 +24,7 @@ import requireTypeOutOfTypeOnlyImports, {
|
|
|
24
24
|
import noServeRuntime, { ruleId as noServeRuntimeRuleId } from './no-serve-runtime.ts';
|
|
25
25
|
import filePathComment from './file-path-comment.ts';
|
|
26
26
|
import noCardNumbers from './no-card-numbers.ts';
|
|
27
|
+
import noEnum from './no-enum.ts';
|
|
27
28
|
import noSideEffects from './no-side-effects.ts';
|
|
28
29
|
import noRandomV4UUID from './no-random-v4-uuid.ts';
|
|
29
30
|
import noTestImport from './no-test-import.ts';
|
|
@@ -38,6 +39,7 @@ import requireTsExtensionImports from './require-ts-extension-imports';
|
|
|
38
39
|
const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
39
40
|
'file-path-comment': filePathComment,
|
|
40
41
|
'no-card-numbers': noCardNumbers,
|
|
42
|
+
'no-enum': noEnum,
|
|
41
43
|
'no-random-v4-uuid': noRandomV4UUID,
|
|
42
44
|
'no-uuid': noUuid,
|
|
43
45
|
'require-strict-assert': requireStrictAssert,
|
|
@@ -71,6 +73,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
71
73
|
},
|
|
72
74
|
rules: {
|
|
73
75
|
'@checkdigit/no-card-numbers': 'error',
|
|
76
|
+
'@checkdigit/no-enum': 'error',
|
|
74
77
|
'@checkdigit/file-path-comment': 'error',
|
|
75
78
|
'@checkdigit/no-random-v4-uuid': 'error',
|
|
76
79
|
'@checkdigit/no-uuid': 'error',
|
|
@@ -101,6 +104,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
101
104
|
},
|
|
102
105
|
rules: {
|
|
103
106
|
'@checkdigit/no-card-numbers': 'error',
|
|
107
|
+
'@checkdigit/no-enum': 'error',
|
|
104
108
|
'@checkdigit/file-path-comment': 'off',
|
|
105
109
|
'@checkdigit/no-random-v4-uuid': 'error',
|
|
106
110
|
'@checkdigit/no-uuid': 'error',
|
package/src/no-enum.ts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
// no-enum.ts
|
|
2
|
+
|
|
3
|
+
/*
|
|
4
|
+
* Copyright (c) 2021-2024 Check Digit, LLC
|
|
5
|
+
*
|
|
6
|
+
* This code is licensed under the MIT license (see LICENSE.txt for details).
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
|
10
|
+
|
|
11
|
+
export const ruleId = 'no-enum';
|
|
12
|
+
const NO_ENUM = 'NO_ENUM';
|
|
13
|
+
|
|
14
|
+
const createRule = ESLintUtils.RuleCreator((name) => name);
|
|
15
|
+
|
|
16
|
+
function isJsonSchemaProperty(node?: TSESTree.Node): boolean {
|
|
17
|
+
if (!node) {
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
if (
|
|
21
|
+
node.type === TSESTree.AST_NODE_TYPES.Property &&
|
|
22
|
+
node.key.type === TSESTree.AST_NODE_TYPES.Identifier &&
|
|
23
|
+
node.key.name === 'properties'
|
|
24
|
+
) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
return isJsonSchemaProperty(node.parent);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const rule: ESLintUtils.RuleModule<typeof NO_ENUM> = createRule({
|
|
31
|
+
name: ruleId,
|
|
32
|
+
meta: {
|
|
33
|
+
type: 'problem',
|
|
34
|
+
docs: {
|
|
35
|
+
description: 'Disallow the use of `enum` in TypeScript',
|
|
36
|
+
},
|
|
37
|
+
schema: [],
|
|
38
|
+
messages: {
|
|
39
|
+
[NO_ENUM]: 'Avoid using `enum` in TypeScript.',
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
defaultOptions: [],
|
|
43
|
+
create(context) {
|
|
44
|
+
return {
|
|
45
|
+
TSEnumDeclaration(node: TSESTree.TSEnumDeclaration) {
|
|
46
|
+
context.report({
|
|
47
|
+
node,
|
|
48
|
+
messageId: NO_ENUM,
|
|
49
|
+
});
|
|
50
|
+
},
|
|
51
|
+
Property(node: TSESTree.Property) {
|
|
52
|
+
if (
|
|
53
|
+
node.key.type === TSESTree.AST_NODE_TYPES.Identifier &&
|
|
54
|
+
node.key.name === 'enum' &&
|
|
55
|
+
node.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression &&
|
|
56
|
+
!isJsonSchemaProperty(node.parent)
|
|
57
|
+
) {
|
|
58
|
+
context.report({
|
|
59
|
+
node,
|
|
60
|
+
messageId: NO_ENUM,
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
export default rule;
|