@darraghor/eslint-plugin-nestjs-typed 7.1.20 → 7.1.22
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.
|
@@ -2,7 +2,7 @@ import { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
|
|
|
2
2
|
import { EnumTestResultModel } from "./enumTestResultModel.js";
|
|
3
3
|
export declare const hasEnumSpecifiedCorrectly: (node: TSESTree.Node, isEnumType: boolean) => EnumTestResultModel;
|
|
4
4
|
export declare const needsEnumNameMatchingEnumType: (enumNameProperty: TSESTree.Property, enumProperty: TSESTree.Property) => boolean;
|
|
5
|
-
declare const rule: ESLintUtils.RuleModule<"needsEnumNameAdded" | "needsTypeRemoved" | "enumNameShouldMatchType", [], unknown, ESLintUtils.RuleListener> & {
|
|
5
|
+
declare const rule: ESLintUtils.RuleModule<"needsEnumAdded" | "needsEnumNameAdded" | "needsTypeRemoved" | "enumNameShouldMatchType", [], unknown, ESLintUtils.RuleListener> & {
|
|
6
6
|
name: string;
|
|
7
7
|
};
|
|
8
8
|
export default rule;
|
|
@@ -21,21 +21,13 @@ export const hasEnumSpecifiedCorrectly = (node, isEnumType) => {
|
|
|
21
21
|
// check if there is an enum property in the provided options (enums should specify the enum property)
|
|
22
22
|
const firstArgument = decorators[0].expression
|
|
23
23
|
.arguments[0];
|
|
24
|
-
|
|
25
|
-
return new EnumTestResultModel({
|
|
26
|
-
needsEnumAdded: true,
|
|
27
|
-
needsEnumNameAdded: true,
|
|
28
|
-
needsEnumNameToMatchEnumType: false,
|
|
29
|
-
needsTypeRemoved: false,
|
|
30
|
-
});
|
|
31
|
-
}
|
|
32
|
-
const enumProperty = firstArgument.properties.find((p) => p.key.name ===
|
|
24
|
+
const enumProperty = firstArgument?.properties?.find((p) => p.key.name ===
|
|
33
25
|
"enum");
|
|
34
26
|
// check if there is a type: property in the provided options (enums shouldn't specify type)
|
|
35
|
-
const hasTypeProperty = firstArgument
|
|
27
|
+
const hasTypeProperty = firstArgument?.properties?.find((p) => p.key.name ===
|
|
36
28
|
"type") !== undefined;
|
|
37
29
|
// check if there is an enumName: property in the provided options (enums should specify a name)
|
|
38
|
-
const enumNameProperty = firstArgument
|
|
30
|
+
const enumNameProperty = firstArgument?.properties?.find((p) => p.key.name ===
|
|
39
31
|
"enumName");
|
|
40
32
|
return new EnumTestResultModel({
|
|
41
33
|
needsEnumAdded: enumProperty === undefined,
|
|
@@ -60,6 +52,7 @@ const rule = createRule({
|
|
|
60
52
|
description: "Enums should use the best practices for api documentation",
|
|
61
53
|
},
|
|
62
54
|
messages: {
|
|
55
|
+
needsEnumAdded: `Enum properties should specify an enum`,
|
|
63
56
|
needsEnumNameAdded: `Properties with enum should also specify an enumName property to keep generated models clean`,
|
|
64
57
|
needsTypeRemoved: `Properties with enum should not specify a type property`,
|
|
65
58
|
enumNameShouldMatchType: `The enumName should match the enum type provided`,
|
|
@@ -79,6 +72,12 @@ const rule = createRule({
|
|
|
79
72
|
const objectType = typeChecker.getTypeAtLocation(mappedNode);
|
|
80
73
|
const isEnumType = typedTokenHelpers.isEnumType(objectType);
|
|
81
74
|
const result = hasEnumSpecifiedCorrectly(node, isEnumType);
|
|
75
|
+
if (result.needsEnumAdded) {
|
|
76
|
+
context.report({
|
|
77
|
+
node: node,
|
|
78
|
+
messageId: "needsEnumAdded",
|
|
79
|
+
});
|
|
80
|
+
}
|
|
82
81
|
if (result.needsEnumNameAdded) {
|
|
83
82
|
context.report({
|
|
84
83
|
node: node,
|
|
@@ -102,4 +101,4 @@ const rule = createRule({
|
|
|
102
101
|
},
|
|
103
102
|
});
|
|
104
103
|
export default rule;
|
|
105
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpRW51bVByb3BlcnR5QmVzdFByYWN0aWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ydWxlcy9hcGlFbnVtUHJvcGVydHlCZXN0UHJhY3RpY2VzL2FwaUVudW1Qcm9wZXJ0eUJlc3RQcmFjdGljZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFDLFdBQVcsRUFBVyxNQUFNLDBCQUEwQixDQUFDO0FBQy9ELE9BQU8sRUFBQyxVQUFVLEVBQUMsTUFBTSwyQkFBMkIsQ0FBQztBQUNyRCxPQUFPLEVBQUMsaUJBQWlCLEVBQUMsTUFBTSxrQ0FBa0MsQ0FBQztBQUNuRSxPQUFPLEVBQUMsbUJBQW1CLEVBQUMsTUFBTSwwQkFBMEIsQ0FBQztBQUU3RCxNQUFNLHVCQUF1QixHQUFHLElBQUksbUJBQW1CLENBQUM7SUFDcEQsY0FBYyxFQUFFLEtBQUs7SUFDckIsa0JBQWtCLEVBQUUsS0FBSztJQUN6Qiw0QkFBNEIsRUFBRSxLQUFLO0lBQ25DLGdCQUFnQixFQUFFLEtBQUs7Q0FDMUIsQ0FBQyxDQUFDO0FBRUgsTUFBTSxDQUFDLE1BQU0seUJBQXlCLEdBQUcsQ0FDckMsSUFBbUIsRUFDbkIsVUFBbUIsRUFDQSxFQUFFO0lBQ3JCLGtCQUFrQjtJQUNsQixJQUFJLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDZCxPQUFPLHVCQUF1QixDQUFDO0lBQ25DLENBQUM7SUFFRCwyQ0FBMkM7SUFDM0MsTUFBTSxVQUFVLEdBQUcsaUJBQWlCLENBQUMsa0JBQWtCLENBQ25ELElBQW1DLEVBQ25DLENBQUMscUJBQXFCLEVBQUUsYUFBYSxDQUFDLENBQ3pDLENBQUM7SUFFRixJQUFJLFVBQVUsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDMUIsT0FBTyx1QkFBdUIsQ0FBQztJQUNuQyxDQUFDO0lBRUQsc0dBQXNHO0lBQ3RHLE1BQU0sYUFBYSxHQUFJLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxVQUFzQztTQUN0RSxTQUFTLENBQUMsQ0FBQyxDQUE4QixDQUFDO0lBRS9DLE1BQU0sWUFBWSxHQUFHLGFBQWEsRUFBRSxVQUFVLEVBQUUsSUFBSSxDQUNoRCxDQUFDLENBQUMsRUFBRSxFQUFFLENBQ0EsQ0FBdUIsQ0FBQyxHQUEyQixDQUFDLElBQUk7UUFDMUQsTUFBTSxDQUNiLENBQUM7SUFFRiw0RkFBNEY7SUFDNUYsTUFBTSxlQUFlLEdBQ2pCLGFBQWEsRUFBRSxVQUFVLEVBQUUsSUFBSSxDQUMzQixDQUFDLENBQUMsRUFBRSxFQUFFLENBQ0EsQ0FBdUIsQ0FBQyxHQUEyQixDQUFDLElBQUk7UUFDMUQsTUFBTSxDQUNiLEtBQUssU0FBUyxDQUFDO0lBRXBCLGdHQUFnRztJQUNoRyxNQUFNLGdCQUFnQixHQUFHLGFBQWEsRUFBRSxVQUFVLEVBQUUsSUFBSSxDQUNwRCxDQUFDLENBQUMsRUFBRSxFQUFFLENBQ0EsQ0FBdUIsQ0FBQyxHQUEyQixDQUFDLElBQUk7UUFDMUQsVUFBVSxDQUNqQixDQUFDO0lBQ0YsT0FBTyxJQUFJLG1CQUFtQixDQUFDO1FBQzNCLGNBQWMsRUFBRSxZQUFZLEtBQUssU0FBUztRQUMxQyxrQkFBa0IsRUFBRSxnQkFBZ0IsS0FBSyxTQUFTO1FBQ2xELDRCQUE0QixFQUFFLDZCQUE2QixDQUN2RCxnQkFBcUMsRUFDckMsWUFBaUMsQ0FDcEM7UUFDRCxnQkFBZ0IsRUFBRSxlQUFlO0tBQ3BDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQztBQUVGLE1BQU0sQ0FBQyxNQUFNLDZCQUE2QixHQUFHLENBQ3pDLGdCQUFtQyxFQUNuQyxZQUErQixFQUN4QixFQUFFO0lBQ1QsbUVBQW1FO0lBQ25FLElBQUksZ0JBQWdCLEtBQUssU0FBUyxJQUFJLFlBQVksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvRCxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRUQsTUFBTSwwQkFBMEIsR0FDM0IsZ0JBQWdCLENBQUMsS0FBMEIsQ0FBQyxLQUFLO1FBQ2pELFlBQVksQ0FBQyxLQUE2QixFQUFFLElBQUksQ0FBQztJQUV0RCxPQUFPLENBQUMsMEJBQTBCLENBQUM7QUFDdkMsQ0FBQyxDQUFDO0FBRUYsTUFBTSxJQUFJLEdBQUcsVUFBVSxDQU1yQjtJQUNFLElBQUksRUFBRSxrQ0FBa0M7SUFDeEMsSUFBSSxFQUFFO1FBQ0YsSUFBSSxFQUFFO1lBQ0YsV0FBVyxFQUNQLDJEQUEyRDtTQUNsRTtRQUNELFFBQVEsRUFBRTtZQUNOLGNBQWMsRUFBRSx3Q0FBd0M7WUFDeEQsa0JBQWtCLEVBQUUsOEZBQThGO1lBQ2xILGdCQUFnQixFQUFFLHlEQUF5RDtZQUMzRSx1QkFBdUIsRUFBRSxrREFBa0Q7U0FDOUU7UUFDRCxNQUFNLEVBQUUsRUFBRTtRQUNWLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLElBQUksRUFBRSxZQUFZO0tBQ3JCO0lBQ0QsY0FBYyxFQUFFLEVBQUU7SUFFbEIsTUFBTSxDQUFDLE9BQU87UUFDVix5Q0FBeUM7UUFDekMsTUFBTSxjQUFjLEdBQUcsV0FBVyxDQUFDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzlELE1BQU0sV0FBVyxHQUFHLGNBQWMsQ0FBQyxPQUFPLENBQUMsY0FBYyxFQUFFLENBQUM7UUFFNUQsT0FBTztZQUNILGtCQUFrQixDQUFDLElBQW1CO2dCQUNsQyxNQUFNLFVBQVUsR0FDWixjQUFjLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNuRCxNQUFNLFVBQVUsR0FBRyxXQUFXLENBQUMsaUJBQWlCLENBQUMsVUFBVSxDQUFDLENBQUM7Z0JBQzdELE1BQU0sVUFBVSxHQUFHLGlCQUFpQixDQUFDLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQztnQkFFNUQsTUFBTSxNQUFNLEdBQUcseUJBQXlCLENBQUMsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO2dCQUMzRCxJQUFJLE1BQU0sQ0FBQyxjQUFjLEVBQUUsQ0FBQztvQkFDeEIsT0FBTyxDQUFDLE1BQU0sQ0FBQzt3QkFDWCxJQUFJLEVBQUUsSUFBSTt3QkFDVixTQUFTLEVBQUUsZ0JBQWdCO3FCQUM5QixDQUFDLENBQUM7Z0JBQ1AsQ0FBQztnQkFDRCxJQUFJLE1BQU0sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO29CQUM1QixPQUFPLENBQUMsTUFBTSxDQUFDO3dCQUNYLElBQUksRUFBRSxJQUFJO3dCQUNWLFNBQVMsRUFBRSxvQkFBb0I7cUJBQ2xDLENBQUMsQ0FBQztnQkFDUCxDQUFDO2dCQUNELElBQUksTUFBTSxDQUFDLGdCQUFnQixFQUFFLENBQUM7b0JBQzFCLE9BQU8sQ0FBQyxNQUFNLENBQUM7d0JBQ1gsSUFBSSxFQUFFLElBQUk7d0JBQ1YsU0FBUyxFQUFFLGtCQUFrQjtxQkFDaEMsQ0FBQyxDQUFDO2dCQUNQLENBQUM7Z0JBQ0QsSUFBSSxNQUFNLENBQUMsNEJBQTRCLEVBQUUsQ0FBQztvQkFDdEMsT0FBTyxDQUFDLE1BQU0sQ0FBQzt3QkFDWCxJQUFJLEVBQUUsSUFBSTt3QkFDVixTQUFTLEVBQUUseUJBQXlCO3FCQUN2QyxDQUFDLENBQUM7Z0JBQ1AsQ0FBQztZQUNMLENBQUM7U0FDSixDQUFDO0lBQ04sQ0FBQztDQUNKLENBQUMsQ0FBQztBQUVILGVBQWUsSUFBSSxDQUFDIn0=
|
package/dist/rules/index.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ declare const allRules: {
|
|
|
30
30
|
"api-method-should-specify-api-operation": import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldSpecifyApiOperation", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
31
31
|
name: string;
|
|
32
32
|
};
|
|
33
|
-
"api-enum-property-best-practices": import("@typescript-eslint/utils/ts-eslint").RuleModule<"needsEnumNameAdded" | "needsTypeRemoved" | "enumNameShouldMatchType", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
33
|
+
"api-enum-property-best-practices": import("@typescript-eslint/utils/ts-eslint").RuleModule<"needsEnumAdded" | "needsEnumNameAdded" | "needsTypeRemoved" | "enumNameShouldMatchType", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
34
34
|
name: string;
|
|
35
35
|
};
|
|
36
36
|
"api-property-returning-array-should-set-array": import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldSetArrayPropertyTrue" | "shouldSetArrayPropertyFalse", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@darraghor/eslint-plugin-nestjs-typed",
|
|
3
|
-
"version": "7.1.
|
|
3
|
+
"version": "7.1.22",
|
|
4
4
|
"description": "Eslint rules for nestjs projects",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"clean": "rm -Rf ./dist/",
|
|
@@ -59,9 +59,9 @@
|
|
|
59
59
|
"types": "./dist/index.d.ts",
|
|
60
60
|
"sideEffects": false,
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@typescript-eslint/scope-manager": "^8.
|
|
63
|
-
"@typescript-eslint/type-utils": "^8.
|
|
64
|
-
"@typescript-eslint/utils": "^8.
|
|
62
|
+
"@typescript-eslint/scope-manager": "^8.55.0",
|
|
63
|
+
"@typescript-eslint/type-utils": "^8.55.0",
|
|
64
|
+
"@typescript-eslint/utils": "^8.55.0",
|
|
65
65
|
"eslint-module-utils": "2.12.1",
|
|
66
66
|
"glob": "13.0.0",
|
|
67
67
|
"reflect-metadata": "0.2.2",
|
|
@@ -76,9 +76,9 @@
|
|
|
76
76
|
"@types/eslint": "9.6.1",
|
|
77
77
|
"@types/jest": "30.0.0",
|
|
78
78
|
"@types/node": "25.0.3",
|
|
79
|
-
"@typescript-eslint/eslint-plugin": "8.
|
|
80
|
-
"@typescript-eslint/parser": "8.
|
|
81
|
-
"@typescript-eslint/rule-tester": "8.
|
|
79
|
+
"@typescript-eslint/eslint-plugin": "8.55.0",
|
|
80
|
+
"@typescript-eslint/parser": "8.55.0",
|
|
81
|
+
"@typescript-eslint/rule-tester": "8.55.0",
|
|
82
82
|
"class-validator": "0.14.3",
|
|
83
83
|
"eslint": "9.39.2",
|
|
84
84
|
"eslint-config-prettier": "10.1.8",
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
"ts-jest": "29.4.6",
|
|
96
96
|
"ts-node": "10.9.2",
|
|
97
97
|
"typescript": "5.9.3",
|
|
98
|
-
"typescript-eslint": "8.
|
|
98
|
+
"typescript-eslint": "8.55.0",
|
|
99
99
|
"vite": "7.3.0",
|
|
100
100
|
"vitest": "4.0.16"
|
|
101
101
|
},
|
|
@@ -113,6 +113,6 @@
|
|
|
113
113
|
"lint",
|
|
114
114
|
"style"
|
|
115
115
|
],
|
|
116
|
-
"packageManager": "pnpm@10.
|
|
116
|
+
"packageManager": "pnpm@10.29.1",
|
|
117
117
|
"license": "ISC"
|
|
118
118
|
}
|