@definitelytyped/dtslint 0.0.166 → 0.0.167-next.1
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/dist/lint.js +3 -1
- package/dist/lint.js.map +1 -1
- package/dist/rules/dt-header.d.ts +2 -0
- package/dist/rules/dt-header.js +62 -0
- package/dist/rules/dt-header.js.map +1 -0
- package/dist/rules/export-just-namespace.d.ts +2 -0
- package/dist/rules/export-just-namespace.js +70 -0
- package/dist/rules/export-just-namespace.js.map +1 -0
- package/dist/rules/no-any-union.d.ts +4 -0
- package/dist/rules/no-any-union.js +34 -0
- package/dist/rules/no-any-union.js.map +1 -0
- package/dist/rules/no-bad-reference.d.ts +2 -0
- package/dist/rules/no-bad-reference.js +55 -0
- package/dist/rules/no-bad-reference.js.map +1 -0
- package/dist/rules/no-const-enum.d.ts +4 -0
- package/dist/rules/no-const-enum.js +30 -0
- package/dist/rules/no-const-enum.js.map +1 -0
- package/dist/rules/no-dead-reference.d.ts +2 -0
- package/dist/rules/no-dead-reference.js +44 -0
- package/dist/rules/no-dead-reference.js.map +1 -0
- package/dist/rules/no-declare-current-package.d.ts +4 -0
- package/dist/rules/no-declare-current-package.js +43 -0
- package/dist/rules/no-declare-current-package.js.map +1 -0
- package/dist/rules/no-import-default-of-export-equals.d.ts +4 -0
- package/dist/rules/no-import-default-of-export-equals.js +87 -0
- package/dist/rules/no-import-default-of-export-equals.js.map +1 -0
- package/dist/rules/no-outside-dependencies.d.ts +2 -0
- package/dist/rules/no-outside-dependencies.js +41 -0
- package/dist/rules/no-outside-dependencies.js.map +1 -0
- package/dist/rules/no-self-import.d.ts +4 -0
- package/dist/rules/no-self-import.js +38 -0
- package/dist/rules/no-self-import.js.map +1 -0
- package/dist/rules/no-single-element-tuple-type.d.ts +5 -0
- package/dist/rules/no-single-element-tuple-type.js +30 -0
- package/dist/rules/no-single-element-tuple-type.js.map +1 -0
- package/dist/rules/no-unnecessary-generics.d.ts +8 -0
- package/dist/rules/no-unnecessary-generics.js +135 -0
- package/dist/rules/no-unnecessary-generics.js.map +1 -0
- package/dist/rules/no-useless-files.d.ts +2 -0
- package/dist/rules/no-useless-files.js +53 -0
- package/dist/rules/no-useless-files.js.map +1 -0
- package/dist/rules/prefer-declare-function.d.ts +5 -0
- package/dist/rules/prefer-declare-function.js +35 -0
- package/dist/rules/prefer-declare-function.js.map +1 -0
- package/dist/rules/redundant-undefined.d.ts +4 -0
- package/dist/rules/redundant-undefined.js +53 -0
- package/dist/rules/redundant-undefined.js.map +1 -0
- package/dist/rules/trim-file.d.ts +2 -0
- package/dist/rules/trim-file.js +43 -0
- package/dist/rules/trim-file.js.map +1 -0
- package/dist/util.d.ts +4 -0
- package/dist/util.js +23 -1
- package/dist/util.js.map +1 -1
- package/docs/dt-header.md +88 -0
- package/docs/export-just-namespace.md +29 -0
- package/docs/no-any-union.md +27 -0
- package/docs/no-bad-reference.md +28 -0
- package/docs/no-const-enum.md +16 -0
- package/docs/no-dead-reference.md +17 -0
- package/docs/no-declare-current-package.md +35 -0
- package/docs/no-import-default-of-export-equals.md +22 -0
- package/docs/no-outside-dependencies.md +23 -0
- package/docs/no-self-import.md +27 -0
- package/docs/no-single-element-tuple-type.md +15 -0
- package/docs/no-unnecessary-generics.md +69 -0
- package/docs/no-useless-files.md +14 -0
- package/docs/prefer-declare-function.md +15 -0
- package/docs/redundant-undefined.md +15 -0
- package/docs/trim-file.md +17 -0
- package/package.json +2 -2
- package/src/lint.ts +3 -1
- package/src/rules/dt-header.ts +74 -0
- package/src/rules/export-just-namespace.ts +83 -0
- package/src/rules/no-any-union.ts +34 -0
- package/src/rules/no-bad-reference.ts +62 -0
- package/src/rules/no-const-enum.ts +30 -0
- package/src/rules/no-dead-reference.ts +46 -0
- package/src/rules/no-declare-current-package.ts +45 -0
- package/src/rules/no-import-default-of-export-equals.ts +68 -0
- package/src/rules/no-outside-dependencies.ts +42 -0
- package/src/rules/no-self-import.ts +40 -0
- package/src/rules/no-single-element-tuple-type.ts +31 -0
- package/src/rules/no-unnecessary-generics.ts +126 -0
- package/src/rules/no-useless-files.ts +58 -0
- package/src/rules/prefer-declare-function.ts +37 -0
- package/src/rules/redundant-undefined.ts +62 -0
- package/src/rules/trim-file.ts +45 -0
- package/src/util.ts +25 -0
- package/test/dt-header.test.ts +189 -0
- package/test/export-just-namespace.test.ts +70 -0
- package/test/no-any-union.test.ts +22 -0
- package/test/no-bad-reference.test.ts +66 -0
- package/test/no-const-enum.test.ts +22 -0
- package/test/no-dead-reference.test.ts +66 -0
- package/test/no-declare-current-package.test.ts +61 -0
- package/test/no-import-default-of-export-equals.test.ts +49 -0
- package/test/no-self-import.test.ts +47 -0
- package/test/no-single-element-tuple-type.test.ts +28 -0
- package/test/no-unnecessary-generics.test.ts +152 -0
- package/test/no-useless-files.test.ts +42 -0
- package/test/prefer-declare-function.test.ts +66 -0
- package/test/redundant-undefined.test.ts +39 -0
- package/test/trim-file.test.ts +46 -0
- package/test/tsconfig.json +10 -0
- package/test/tsconfig.no-declare-current-package.json +11 -0
- package/test/tsconfig.no-declare-current-package2.json +11 -0
- package/test/tsconfig.no-import-default-of-export-equals.json +11 -0
- package/test/tsconfig.no-self-import.json +7 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const utils_1 = require("@typescript-eslint/utils");
|
|
3
|
+
const util_1 = require("../util");
|
|
4
|
+
const rule = (0, util_1.createRule)({
|
|
5
|
+
name: "no-self-import",
|
|
6
|
+
defaultOptions: [],
|
|
7
|
+
meta: {
|
|
8
|
+
type: "problem",
|
|
9
|
+
docs: {
|
|
10
|
+
description: "Forbids declaration files to import the current package using a global import.",
|
|
11
|
+
recommended: "error",
|
|
12
|
+
},
|
|
13
|
+
messages: {
|
|
14
|
+
useRelativeImport: "Declaration file should not use a global import of itself. Use a relative import.",
|
|
15
|
+
},
|
|
16
|
+
schema: [],
|
|
17
|
+
},
|
|
18
|
+
create(context) {
|
|
19
|
+
if (!context.getFilename().endsWith(".d.ts")) {
|
|
20
|
+
return {};
|
|
21
|
+
}
|
|
22
|
+
const services = utils_1.ESLintUtils.getParserServices(context);
|
|
23
|
+
const packageName = (0, util_1.getCommonDirectoryName)(services.program.getRootFileNames());
|
|
24
|
+
return {
|
|
25
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
26
|
+
ImportDeclaration(node) {
|
|
27
|
+
if (node.source.value === packageName || node.source.value.startsWith(packageName + "/")) {
|
|
28
|
+
context.report({
|
|
29
|
+
messageId: "useRelativeImport",
|
|
30
|
+
node,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
module.exports = rule;
|
|
38
|
+
//# sourceMappingURL=no-self-import.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-self-import.js","sourceRoot":"","sources":["../../src/rules/no-self-import.ts"],"names":[],"mappings":";AAAA,oDAAuD;AACvD,kCAA6D;AAE7D,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,gBAAgB;IACtB,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,gFAAgF;YAC7F,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,iBAAiB,EAAE,mFAAmF;SACvG;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC5C,OAAO,EAAE,CAAC;SACX;QAED,MAAM,QAAQ,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,IAAA,6BAAsB,EAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEhF,OAAO;YACL,gEAAgE;YAChE,iBAAiB,CAAC,IAAI;gBACpB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC,EAAE;oBACxF,OAAO,CAAC,MAAM,CAAC;wBACb,SAAS,EAAE,mBAAmB;wBAC9B,IAAI;qBACL,CAAC,CAAC;iBACJ;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { TSESTree } from "@typescript-eslint/utils";
|
|
2
|
+
declare const rule: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"singleElementTupleType", never[], {
|
|
3
|
+
"TSTupleType[elementTypes.length=1]"(node: TSESTree.TSTupleType): void;
|
|
4
|
+
}>;
|
|
5
|
+
export = rule;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const util_1 = require("../util");
|
|
3
|
+
const rule = (0, util_1.createRule)({
|
|
4
|
+
name: "no-single-element-tuple-type",
|
|
5
|
+
defaultOptions: [],
|
|
6
|
+
meta: {
|
|
7
|
+
type: "problem",
|
|
8
|
+
docs: {
|
|
9
|
+
description: "Forbids `[T]`, which should be `T[]`.",
|
|
10
|
+
recommended: "error",
|
|
11
|
+
},
|
|
12
|
+
messages: {
|
|
13
|
+
singleElementTupleType: `Type [T] is a single-element tuple type. You probably meant T[].`,
|
|
14
|
+
},
|
|
15
|
+
schema: [],
|
|
16
|
+
},
|
|
17
|
+
create(context) {
|
|
18
|
+
return {
|
|
19
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
20
|
+
"TSTupleType[elementTypes.length=1]"(node) {
|
|
21
|
+
context.report({
|
|
22
|
+
messageId: "singleElementTupleType",
|
|
23
|
+
node,
|
|
24
|
+
});
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
},
|
|
28
|
+
});
|
|
29
|
+
module.exports = rule;
|
|
30
|
+
//# sourceMappingURL=no-single-element-tuple-type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-single-element-tuple-type.js","sourceRoot":"","sources":["../../src/rules/no-single-element-tuple-type.ts"],"names":[],"mappings":";AAAA,kCAAqC;AAGrC,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,8BAA8B;IACpC,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,uCAAuC;YACpD,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,sBAAsB,EAAE,kEAAkE;SAC3F;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,gEAAgE;YAChE,oCAAoC,CAAC,IAA0B;gBAC7D,OAAO,CAAC,MAAM,CAAC;oBACb,SAAS,EAAE,wBAAwB;oBACnC,IAAI;iBACL,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { TSESTree } from "@typescript-eslint/utils";
|
|
2
|
+
type ESTreeFunctionLikeWithTypeParameters = TSESTree.FunctionLike & {
|
|
3
|
+
typeParameters: {};
|
|
4
|
+
};
|
|
5
|
+
declare const rule: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"never" | "sole", never[], {
|
|
6
|
+
[x: string]: (esNode: ESTreeFunctionLikeWithTypeParameters) => void;
|
|
7
|
+
}>;
|
|
8
|
+
export = rule;
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
const utils_1 = require("@typescript-eslint/utils");
|
|
26
|
+
const ts = __importStar(require("typescript"));
|
|
27
|
+
const util_1 = require("../util");
|
|
28
|
+
const rule = (0, util_1.createRule)({
|
|
29
|
+
defaultOptions: [],
|
|
30
|
+
meta: {
|
|
31
|
+
docs: {
|
|
32
|
+
description: "Forbids signatures using a generic parameter only once.",
|
|
33
|
+
recommended: "error",
|
|
34
|
+
},
|
|
35
|
+
messages: {
|
|
36
|
+
never: "Type parameter {{name}} is never used.",
|
|
37
|
+
sole: "Type parameter {{name}} is used only once.",
|
|
38
|
+
},
|
|
39
|
+
schema: [],
|
|
40
|
+
type: "problem",
|
|
41
|
+
},
|
|
42
|
+
name: "no-relative-import-in-test",
|
|
43
|
+
create(context) {
|
|
44
|
+
return {
|
|
45
|
+
[[
|
|
46
|
+
"ArrowFunctionExpression[typeParameters]",
|
|
47
|
+
"FunctionDeclaration[typeParameters]",
|
|
48
|
+
"FunctionExpression[typeParameters]",
|
|
49
|
+
"TSCallSignatureDeclaration[typeParameters]",
|
|
50
|
+
"TSConstructorType[typeParameters]",
|
|
51
|
+
"TSDeclareFunction[typeParameters]",
|
|
52
|
+
"TSFunctionType[typeParameters]",
|
|
53
|
+
"TSMethodSignature[typeParameters]",
|
|
54
|
+
].join(", ")](esNode) {
|
|
55
|
+
const parserServices = utils_1.ESLintUtils.getParserServices(context);
|
|
56
|
+
const tsNode = parserServices.esTreeNodeToTSNodeMap.get(esNode);
|
|
57
|
+
if (!tsNode.typeParameters) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
const checker = parserServices.program.getTypeChecker();
|
|
61
|
+
for (const typeParameter of tsNode.typeParameters) {
|
|
62
|
+
const name = typeParameter.name.text;
|
|
63
|
+
const res = getSoleUse(tsNode, assertDefined(checker.getSymbolAtLocation(typeParameter.name)), checker);
|
|
64
|
+
switch (res.type) {
|
|
65
|
+
case "sole":
|
|
66
|
+
context.report({
|
|
67
|
+
data: { name },
|
|
68
|
+
messageId: "sole",
|
|
69
|
+
node: parserServices.tsNodeToESTreeNodeMap.get(res.soleUse),
|
|
70
|
+
});
|
|
71
|
+
break;
|
|
72
|
+
case "never":
|
|
73
|
+
context.report({
|
|
74
|
+
data: { name },
|
|
75
|
+
messageId: "never",
|
|
76
|
+
node: parserServices.tsNodeToESTreeNodeMap.get(typeParameter),
|
|
77
|
+
});
|
|
78
|
+
break;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
};
|
|
83
|
+
},
|
|
84
|
+
});
|
|
85
|
+
function getSoleUse(sig, typeParameterSymbol, checker) {
|
|
86
|
+
const exit = {};
|
|
87
|
+
let soleUse;
|
|
88
|
+
try {
|
|
89
|
+
if (sig.typeParameters) {
|
|
90
|
+
for (const tp of sig.typeParameters) {
|
|
91
|
+
if (tp.constraint) {
|
|
92
|
+
recur(tp.constraint);
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
for (const param of sig.parameters) {
|
|
97
|
+
if (param.type) {
|
|
98
|
+
recur(param.type);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
if (sig.type) {
|
|
102
|
+
recur(sig.type);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
catch (err) {
|
|
106
|
+
if (err === exit) {
|
|
107
|
+
return { type: "ok" };
|
|
108
|
+
}
|
|
109
|
+
throw err;
|
|
110
|
+
}
|
|
111
|
+
return soleUse ? { type: "sole", soleUse } : { type: "never" };
|
|
112
|
+
function recur(node) {
|
|
113
|
+
if (ts.isIdentifier(node)) {
|
|
114
|
+
if (checker.getSymbolAtLocation(node) === typeParameterSymbol) {
|
|
115
|
+
if (soleUse === undefined) {
|
|
116
|
+
soleUse = node;
|
|
117
|
+
}
|
|
118
|
+
else {
|
|
119
|
+
throw exit;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
else {
|
|
124
|
+
node.forEachChild(recur);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
function assertDefined(value) {
|
|
129
|
+
if (value === undefined) {
|
|
130
|
+
throw new Error("unreachable");
|
|
131
|
+
}
|
|
132
|
+
return value;
|
|
133
|
+
}
|
|
134
|
+
module.exports = rule;
|
|
135
|
+
//# sourceMappingURL=no-unnecessary-generics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unnecessary-generics.js","sourceRoot":"","sources":["../../src/rules/no-unnecessary-generics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAiE;AACjE,+CAAiC;AAEjC,kCAAqC;AAUrC,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,yDAAyD;YACtE,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,wCAAwC;YAC/C,IAAI,EAAE,4CAA4C;SACnD;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE,4BAA4B;IAClC,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,CAAC;gBACC,yCAAyC;gBACzC,qCAAqC;gBACrC,oCAAoC;gBACpC,4CAA4C;gBAC5C,mCAAmC;gBACnC,mCAAmC;gBACnC,gCAAgC;gBAChC,mCAAmC;aACpC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAA4C;gBACxD,MAAM,cAAc,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAC9D,MAAM,MAAM,GAAG,cAAc,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAA6C,CAAC;gBAC5G,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;oBAC1B,OAAO;iBACR;gBAED,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAExD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,cAAc,EAAE;oBACjD,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;oBACrC,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;oBACxG,QAAQ,GAAG,CAAC,IAAI,EAAE;wBAChB,KAAK,MAAM;4BACT,OAAO,CAAC,MAAM,CAAC;gCACb,IAAI,EAAE,EAAE,IAAI,EAAE;gCACd,SAAS,EAAE,MAAM;gCACjB,IAAI,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;6BAC5D,CAAC,CAAC;4BACH,MAAM;wBACR,KAAK,OAAO;4BACV,OAAO,CAAC,MAAM,CAAC;gCACb,IAAI,EAAE,EAAE,IAAI,EAAE;gCACd,SAAS,EAAE,OAAO;gCAClB,IAAI,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,CAAC,aAAa,CAAC;6BAC9D,CAAC,CAAC;4BACH,MAAM;qBACT;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAGH,SAAS,UAAU,CAAC,GAA4B,EAAE,mBAA8B,EAAE,OAAuB;IACvG,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,OAAkC,CAAC;IAEvC,IAAI;QACF,IAAI,GAAG,CAAC,cAAc,EAAE;YACtB,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,cAAc,EAAE;gBACnC,IAAI,EAAE,CAAC,UAAU,EAAE;oBACjB,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;iBACtB;aACF;SACF;QACD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,UAAU,EAAE;YAClC,IAAI,KAAK,CAAC,IAAI,EAAE;gBACd,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aACnB;SACF;QACD,IAAI,GAAG,CAAC,IAAI,EAAE;YACZ,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACjB;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;SACvB;QACD,MAAM,GAAG,CAAC;KACX;IAED,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAE/D,SAAS,KAAK,CAAC,IAAa;QAC1B,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,mBAAmB,EAAE;gBAC7D,IAAI,OAAO,KAAK,SAAS,EAAE;oBACzB,OAAO,GAAG,IAAI,CAAC;iBAChB;qBAAM;oBACL,MAAM,IAAI,CAAC;iBACZ;aACF;SACF;aAAM;YACL,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;SAC1B;IACH,CAAC;AACH,CAAC;AAID,SAAS,aAAa,CAAI,KAAoB;IAC5C,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;KAChC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const util_1 = require("../util");
|
|
3
|
+
const rule = (0, util_1.createRule)({
|
|
4
|
+
name: "no-useless-files",
|
|
5
|
+
defaultOptions: [],
|
|
6
|
+
meta: {
|
|
7
|
+
type: "problem",
|
|
8
|
+
docs: {
|
|
9
|
+
description: "Forbids files with no content.",
|
|
10
|
+
recommended: "error",
|
|
11
|
+
},
|
|
12
|
+
messages: {
|
|
13
|
+
noContent: "File has no content.",
|
|
14
|
+
},
|
|
15
|
+
schema: [],
|
|
16
|
+
},
|
|
17
|
+
create(context) {
|
|
18
|
+
var _a;
|
|
19
|
+
const { ast: { tokens, comments }, } = context.getSourceCode();
|
|
20
|
+
if (tokens.length === 0) {
|
|
21
|
+
if (comments.length === 0) {
|
|
22
|
+
reportNoContent();
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
const referenceRegExp = /^\/\s*<reference\s*(types|path)\s*=\s*["|'](.*)["|']/;
|
|
26
|
+
let noReferenceFound = true;
|
|
27
|
+
for (const comment of comments) {
|
|
28
|
+
const referenceMatch = (_a = comment.value.match(referenceRegExp)) === null || _a === void 0 ? void 0 : _a[1];
|
|
29
|
+
if (!referenceMatch) {
|
|
30
|
+
continue;
|
|
31
|
+
}
|
|
32
|
+
noReferenceFound = false;
|
|
33
|
+
break;
|
|
34
|
+
}
|
|
35
|
+
if (noReferenceFound) {
|
|
36
|
+
reportNoContent();
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return {};
|
|
41
|
+
function reportNoContent() {
|
|
42
|
+
context.report({
|
|
43
|
+
messageId: "noContent",
|
|
44
|
+
loc: {
|
|
45
|
+
start: { line: 1, column: 0 },
|
|
46
|
+
end: { line: 1, column: 0 },
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
module.exports = rule;
|
|
53
|
+
//# sourceMappingURL=no-useless-files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-useless-files.js","sourceRoot":"","sources":["../../src/rules/no-useless-files.ts"],"names":[],"mappings":";AAAA,kCAAqC;AAErC,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,kBAAkB;IACxB,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,SAAS,EAAE,sBAAsB;SAClC;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;;QACZ,MAAM,EACJ,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,GAC1B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAE5B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzB,eAAe,EAAE,CAAC;aACnB;iBAAM;gBACL,MAAM,eAAe,GAAG,sDAAsD,CAAC;gBAC/E,IAAI,gBAAgB,GAAG,IAAI,CAAC;gBAE5B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;oBAC9B,MAAM,cAAc,GAAG,MAAA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,0CAAG,CAAC,CAAC,CAAC;oBACjE,IAAI,CAAC,cAAc,EAAE;wBACnB,SAAS;qBACV;oBACD,gBAAgB,GAAG,KAAK,CAAC;oBACzB,MAAM;iBACP;gBAED,IAAI,gBAAgB,EAAE;oBACpB,eAAe,EAAE,CAAC;iBACnB;aACF;SACF;QAED,OAAO,EAAE,CAAC;QAEV,SAAS,eAAe;YACtB,OAAO,CAAC,MAAM,CAAC;gBACb,SAAS,EAAE,WAAW;gBACtB,GAAG,EAAE;oBACH,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;iBAC5B;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { TSESTree } from "@typescript-eslint/utils";
|
|
2
|
+
declare const rule: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"variableFunction", never[], {
|
|
3
|
+
"VariableDeclaration > VariableDeclarator"(node: TSESTree.VariableDeclarator): void;
|
|
4
|
+
}>;
|
|
5
|
+
export = rule;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const utils_1 = require("@typescript-eslint/utils");
|
|
3
|
+
const util_1 = require("../util");
|
|
4
|
+
const rule = (0, util_1.createRule)({
|
|
5
|
+
defaultOptions: [],
|
|
6
|
+
meta: {
|
|
7
|
+
docs: {
|
|
8
|
+
description: "Forbids `const x: () => void`.",
|
|
9
|
+
recommended: "error",
|
|
10
|
+
},
|
|
11
|
+
messages: {
|
|
12
|
+
variableFunction: "Use a function declaration instead of a variable of function type.",
|
|
13
|
+
},
|
|
14
|
+
schema: [],
|
|
15
|
+
type: "problem",
|
|
16
|
+
},
|
|
17
|
+
name: "prefer-declare-function",
|
|
18
|
+
create(context) {
|
|
19
|
+
return {
|
|
20
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
21
|
+
"VariableDeclaration > VariableDeclarator"(node) {
|
|
22
|
+
var _a;
|
|
23
|
+
if (((_a = node.id.typeAnnotation) === null || _a === void 0 ? void 0 : _a.typeAnnotation.type) === utils_1.AST_NODE_TYPES.TSFunctionType &&
|
|
24
|
+
context.getFilename().endsWith(".d.ts")) {
|
|
25
|
+
context.report({
|
|
26
|
+
messageId: "variableFunction",
|
|
27
|
+
node: node.id,
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
module.exports = rule;
|
|
35
|
+
//# sourceMappingURL=prefer-declare-function.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-declare-function.js","sourceRoot":"","sources":["../../src/rules/prefer-declare-function.ts"],"names":[],"mappings":";AAAA,oDAAoE;AAEpE,kCAAqC;AAErC,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,gCAAgC;YAC7C,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,gBAAgB,EAAE,oEAAoE;SACvF;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KAChB;IACD,IAAI,EAAE,yBAAyB;IAC/B,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,gEAAgE;YAChE,0CAA0C,CAAC,IAAiC;;gBAC1E,IACE,CAAA,MAAA,IAAI,CAAC,EAAE,CAAC,cAAc,0CAAE,cAAc,CAAC,IAAI,MAAK,sBAAc,CAAC,cAAc;oBAC7E,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,EACvC;oBACA,OAAO,CAAC,MAAM,CAAC;wBACb,SAAS,EAAE,kBAAkB;wBAC7B,IAAI,EAAE,IAAI,CAAC,EAAE;qBACd,CAAC,CAAC;iBACJ;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const util_1 = require("../util");
|
|
3
|
+
const utils_1 = require("@typescript-eslint/utils");
|
|
4
|
+
const rule = (0, util_1.createRule)({
|
|
5
|
+
name: "redundant-undefined",
|
|
6
|
+
defaultOptions: [],
|
|
7
|
+
meta: {
|
|
8
|
+
type: "problem",
|
|
9
|
+
docs: {
|
|
10
|
+
description: "Forbids optional parameters from including an explicit `undefined` in their type; requires it in optional properties.",
|
|
11
|
+
recommended: "error",
|
|
12
|
+
},
|
|
13
|
+
messages: {
|
|
14
|
+
redundantUndefined: `Parameter is optional, so no need to include \`undefined\` in the type.`,
|
|
15
|
+
},
|
|
16
|
+
schema: [],
|
|
17
|
+
},
|
|
18
|
+
create(context) {
|
|
19
|
+
return {
|
|
20
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
21
|
+
TSUnionType(node) {
|
|
22
|
+
const hasUndefinedType = node.types.some((t) => t.type === utils_1.AST_NODE_TYPES.TSUndefinedKeyword);
|
|
23
|
+
if (node.parent.type === utils_1.AST_NODE_TYPES.TSTypeAnnotation &&
|
|
24
|
+
isParameter(node.parent.parent) &&
|
|
25
|
+
node.parent.parent.optional &&
|
|
26
|
+
isFunctionLike(node.parent.parent.parent) &&
|
|
27
|
+
hasUndefinedType) {
|
|
28
|
+
context.report({
|
|
29
|
+
messageId: "redundantUndefined",
|
|
30
|
+
node,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
function isFunctionLike(node) {
|
|
38
|
+
return (node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
|
|
39
|
+
node.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
|
|
40
|
+
node.type === utils_1.AST_NODE_TYPES.FunctionExpression ||
|
|
41
|
+
node.type === utils_1.AST_NODE_TYPES.TSDeclareFunction ||
|
|
42
|
+
node.type === utils_1.AST_NODE_TYPES.TSEmptyBodyFunctionExpression);
|
|
43
|
+
}
|
|
44
|
+
/** Note: Does not include parameter properties because those can't be optional */
|
|
45
|
+
function isParameter(node) {
|
|
46
|
+
return (node.type === utils_1.AST_NODE_TYPES.ArrayPattern ||
|
|
47
|
+
node.type === utils_1.AST_NODE_TYPES.AssignmentPattern ||
|
|
48
|
+
node.type === utils_1.AST_NODE_TYPES.Identifier ||
|
|
49
|
+
node.type === utils_1.AST_NODE_TYPES.ObjectPattern ||
|
|
50
|
+
node.type === utils_1.AST_NODE_TYPES.RestElement);
|
|
51
|
+
}
|
|
52
|
+
module.exports = rule;
|
|
53
|
+
//# sourceMappingURL=redundant-undefined.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"redundant-undefined.js","sourceRoot":"","sources":["../../src/rules/redundant-undefined.ts"],"names":[],"mappings":";AAAA,kCAAqC;AACrC,oDAA0D;AAG1D,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,qBAAqB;IAC3B,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,uHAAuH;YACzH,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,kBAAkB,EAAE,yEAAyE;SAC9F;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,gEAAgE;YAChE,WAAW,CAAC,IAAI;gBACd,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,sBAAc,CAAC,kBAAkB,CAAC,CAAC;gBAC9F,IACE,IAAI,CAAC,MAAO,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB;oBACrD,WAAW,CAAC,IAAI,CAAC,MAAO,CAAC,MAAO,CAAC;oBACjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ;oBAC3B,cAAc,CAAC,IAAI,CAAC,MAAO,CAAC,MAAO,CAAC,MAAO,CAAC;oBAC5C,gBAAgB,EAChB;oBACA,OAAO,CAAC,MAAM,CAAC;wBACb,SAAS,EAAE,oBAAoB;wBAC/B,IAAI;qBACL,CAAC,CAAC;iBACJ;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,cAAc,CAAC,IAAmB;IACzC,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,uBAAuB;QACpD,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,mBAAmB;QAChD,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,kBAAkB;QAC/C,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,iBAAiB;QAC9C,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,6BAA6B,CAC3D,CAAC;AACJ,CAAC;AACD,kFAAkF;AAClF,SAAS,WAAW,CAAC,IAAmB;IACtC,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,YAAY;QACzC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,iBAAiB;QAC9C,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;QACvC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,aAAa;QAC1C,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,WAAW,CACzC,CAAC;AACJ,CAAC;AAED,iBAAS,IAAI,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
const util_1 = require("../util");
|
|
3
|
+
const rule = (0, util_1.createRule)({
|
|
4
|
+
name: "trim-file",
|
|
5
|
+
defaultOptions: [],
|
|
6
|
+
meta: {
|
|
7
|
+
type: "layout",
|
|
8
|
+
docs: {
|
|
9
|
+
description: "Forbids leading/trailing blank lines in a file. Allows file to end in '\n'",
|
|
10
|
+
recommended: "error",
|
|
11
|
+
},
|
|
12
|
+
messages: {
|
|
13
|
+
leadingBlankLine: "File should not begin with a blank line.",
|
|
14
|
+
trailingBlankLine: "File should not end with a blank line. (Ending in one newline OK, ending in two newlines not OK.)",
|
|
15
|
+
},
|
|
16
|
+
schema: [],
|
|
17
|
+
},
|
|
18
|
+
create(context) {
|
|
19
|
+
const { lines, text } = context.getSourceCode();
|
|
20
|
+
if (text.startsWith("\r") || text.startsWith("\n")) {
|
|
21
|
+
context.report({
|
|
22
|
+
messageId: "leadingBlankLine",
|
|
23
|
+
loc: {
|
|
24
|
+
start: { line: 1, column: 0 },
|
|
25
|
+
end: { line: 1, column: 0 },
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
if (text.endsWith("\n\n") || text.endsWith("\r\n\r\n")) {
|
|
30
|
+
const line = lines.length;
|
|
31
|
+
context.report({
|
|
32
|
+
messageId: "trailingBlankLine",
|
|
33
|
+
loc: {
|
|
34
|
+
start: { line, column: 0 },
|
|
35
|
+
end: { line, column: 0 },
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
return {};
|
|
40
|
+
},
|
|
41
|
+
});
|
|
42
|
+
module.exports = rule;
|
|
43
|
+
//# sourceMappingURL=trim-file.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"trim-file.js","sourceRoot":"","sources":["../../src/rules/trim-file.ts"],"names":[],"mappings":";AAAA,kCAAqC;AAErC,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC;IACtB,IAAI,EAAE,WAAW;IACjB,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE;YACJ,WAAW,EAAE,4EAA4E;YACzF,WAAW,EAAE,OAAO;SACrB;QACD,QAAQ,EAAE;YACR,gBAAgB,EAAE,0CAA0C;YAC5D,iBAAiB,EACf,mGAAmG;SACtG;QACD,MAAM,EAAE,EAAE;KACX;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;QAChD,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAClD,OAAO,CAAC,MAAM,CAAC;gBACb,SAAS,EAAE,kBAAkB;gBAC7B,GAAG,EAAE;oBACH,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;iBAC5B;aACF,CAAC,CAAC;SACJ;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACtD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;YAC1B,OAAO,CAAC,MAAM,CAAC;gBACb,SAAS,EAAE,mBAAmB;gBAC9B,GAAG,EAAE;oBACH,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC1B,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE;iBACzB;aACF,CAAC,CAAC;SACJ;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC,CAAC;AAEH,iBAAS,IAAI,CAAC"}
|
package/dist/util.d.ts
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
+
import { ESLintUtils } from "@typescript-eslint/utils";
|
|
1
2
|
import * as ts from "typescript";
|
|
3
|
+
export declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string, TRuleListener extends import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener = import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>>) => import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<TMessageIds, TOptions, TRuleListener>;
|
|
2
4
|
export declare function readJson(path: string): Promise<any>;
|
|
3
5
|
export declare function failure(ruleName: string, s: string): string;
|
|
6
|
+
export declare function getCommonDirectoryName(files: readonly string[]): string;
|
|
4
7
|
export declare function getCompilerOptions(dirPath: string): Promise<ts.CompilerOptions>;
|
|
5
8
|
export declare function withoutPrefix(s: string, prefix: string): string | undefined;
|
|
6
9
|
export declare function last<T>(a: readonly T[]): T;
|
|
10
|
+
export declare function assertDefined<T>(a: T | undefined): T;
|
|
7
11
|
export declare function mapDefinedAsync<T, U>(arr: Iterable<T>, mapper: (t: T) => Promise<U | undefined>): Promise<U[]>;
|
|
8
12
|
export declare function isMainFile(fileName: string, allowNested: boolean): boolean;
|
package/dist/util.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isMainFile = exports.mapDefinedAsync = exports.last = exports.withoutPrefix = exports.getCompilerOptions = exports.failure = exports.readJson = void 0;
|
|
3
|
+
exports.isMainFile = exports.mapDefinedAsync = exports.assertDefined = exports.last = exports.withoutPrefix = exports.getCompilerOptions = exports.getCommonDirectoryName = exports.failure = exports.readJson = exports.createRule = void 0;
|
|
4
|
+
const utils_1 = require("@typescript-eslint/utils");
|
|
4
5
|
const assert = require("assert");
|
|
5
6
|
const fs_extra_1 = require("fs-extra");
|
|
6
7
|
const path_1 = require("path");
|
|
7
8
|
const stripJsonComments = require("strip-json-comments");
|
|
9
|
+
exports.createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint/src/rules/${name}.ts`);
|
|
8
10
|
async function readJson(path) {
|
|
9
11
|
const text = await (0, fs_extra_1.readFile)(path, "utf-8");
|
|
10
12
|
return JSON.parse(stripJsonComments(text));
|
|
@@ -14,6 +16,19 @@ function failure(ruleName, s) {
|
|
|
14
16
|
return `${s} See: https://github.com/microsoft/DefinitelyTyped-tools/blob/master/packages/dtslint/docs/${ruleName}.md`;
|
|
15
17
|
}
|
|
16
18
|
exports.failure = failure;
|
|
19
|
+
function getCommonDirectoryName(files) {
|
|
20
|
+
let minLen = 999;
|
|
21
|
+
let minDir = "";
|
|
22
|
+
for (const file of files) {
|
|
23
|
+
const dir = (0, path_1.dirname)(file);
|
|
24
|
+
if (dir.length < minLen) {
|
|
25
|
+
minDir = dir;
|
|
26
|
+
minLen = dir.length;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return (0, path_1.basename)(minDir);
|
|
30
|
+
}
|
|
31
|
+
exports.getCommonDirectoryName = getCommonDirectoryName;
|
|
17
32
|
async function getCompilerOptions(dirPath) {
|
|
18
33
|
const tsconfigPath = (0, path_1.join)(dirPath, "tsconfig.json");
|
|
19
34
|
if (!(await (0, fs_extra_1.pathExists)(tsconfigPath))) {
|
|
@@ -31,6 +46,13 @@ function last(a) {
|
|
|
31
46
|
return a[a.length - 1];
|
|
32
47
|
}
|
|
33
48
|
exports.last = last;
|
|
49
|
+
function assertDefined(a) {
|
|
50
|
+
if (a === undefined) {
|
|
51
|
+
throw new Error();
|
|
52
|
+
}
|
|
53
|
+
return a;
|
|
54
|
+
}
|
|
55
|
+
exports.assertDefined = assertDefined;
|
|
34
56
|
async function mapDefinedAsync(arr, mapper) {
|
|
35
57
|
const out = [];
|
|
36
58
|
for (const a of arr) {
|
package/dist/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAAA,iCAAkC;AAClC,uCAAgD;AAChD,+BAA+C;AAC/C,yDAA0D;
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAAA,oDAAuD;AACvD,iCAAkC;AAClC,uCAAgD;AAChD,+BAA+C;AAC/C,yDAA0D;AAG7C,QAAA,UAAU,GAAG,mBAAW,CAAC,WAAW,CAC/C,CAAC,IAAI,EAAE,EAAE,CAAC,6FAA6F,IAAI,KAAK,CACjH,CAAC;AAEK,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,IAAI,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC;AAHD,4BAGC;AAED,SAAgB,OAAO,CAAC,QAAgB,EAAE,CAAS;IACjD,OAAO,GAAG,CAAC,8FAA8F,QAAQ,KAAK,CAAC;AACzH,CAAC;AAFD,0BAEC;AAED,SAAgB,sBAAsB,CAAC,KAAwB;IAC7D,IAAI,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE;YACvB,MAAM,GAAG,GAAG,CAAC;YACb,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;SACrB;KACF;IACD,OAAO,IAAA,eAAQ,EAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAXD,wDAWC;AAEM,KAAK,UAAU,kBAAkB,CAAC,OAAe;IACtD,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACpD,IAAI,CAAC,CAAC,MAAM,IAAA,qBAAU,EAAC,YAAY,CAAC,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;KAC9D;IACD,OAAO,CAAC,MAAM,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC;AACxD,CAAC;AAND,gDAMC;AAED,SAAgB,aAAa,CAAC,CAAS,EAAE,MAAc;IACrD,OAAO,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnE,CAAC;AAFD,sCAEC;AAED,SAAgB,IAAI,CAAI,CAAe;IACrC,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACzB,CAAC;AAHD,oBAGC;AAED,SAAgB,aAAa,CAAI,CAAgB;IAC/C,IAAI,CAAC,KAAK,SAAS,EAAE;QACnB,MAAM,IAAI,KAAK,EAAE,CAAC;KACnB;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AALD,sCAKC;AAEM,KAAK,UAAU,eAAe,CAAO,GAAgB,EAAE,MAAwC;IACpG,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACf;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AATD,0CASC;AAED,SAAgB,UAAU,CAAC,QAAgB,EAAE,WAAoB;IAC/D,2GAA2G;IAC3G,IAAI,QAAQ,KAAK,YAAY,EAAE;QAC7B,OAAO,IAAI,CAAC;KACb;IAED,IAAI,IAAA,eAAQ,EAAC,QAAQ,CAAC,KAAK,YAAY,EAAE;QACvC,OAAO,KAAK,CAAC;KACd;IAED,IAAI,MAAM,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;IAC/B,sDAAsD;IACtD,oEAAoE;IACpE,IAAI,WAAW,IAAI,cAAc,CAAC,IAAI,CAAC,IAAA,eAAQ,EAAC,MAAM,CAAC,CAAC,EAAE;QACxD,MAAM,GAAG,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC;KAC1B;IAED,iEAAiE;IACjE,OAAO,IAAA,eAAQ,EAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC;AAC/C,CAAC;AAnBD,gCAmBC"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# dt-header
|
|
2
|
+
|
|
3
|
+
(This rule is specific to DefinitelyTyped.)
|
|
4
|
+
|
|
5
|
+
Checks the format of DefinitelyTyped header comments.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
**Bad**:
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
// Type definitions for foo v1.2.3
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
* Don't include `v`
|
|
16
|
+
* Don't include a patch version
|
|
17
|
+
|
|
18
|
+
**Good**:
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
// Type definitions for foo 1.2
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
**Bad**:
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
// Definitions by: My Name <http://geocities.com/myname>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Good**:
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
// Definitions by: My Name <https://github.com/myname>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
* Prefer a GitHub username, not a personal web site.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
**Bad**:
|
|
43
|
+
|
|
44
|
+
`foo/index.d.ts`:
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
// Type definitions for abs 1.2
|
|
48
|
+
// Project: https://github.com/foo/foo
|
|
49
|
+
// Definitions by: My Name <https://github.com/myname>
|
|
50
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
51
|
+
export { f } from "./subModule";
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
`foo/subModule.d.ts`:
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
// Type definitions for abs 1.2
|
|
58
|
+
// Project: https://github.com/foo/foo
|
|
59
|
+
// Definitions by: My Name <https://github.com/myname>
|
|
60
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
61
|
+
export function f(): number;
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`foo/ts3.1/index.d.ts`:
|
|
65
|
+
```ts
|
|
66
|
+
// Type definitions for abs 1.2
|
|
67
|
+
// Project: https://github.com/foo/foo
|
|
68
|
+
// Definitions by: My Name <https://github.com/myname>
|
|
69
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
70
|
+
export function f(): number;
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
**Good**:
|
|
75
|
+
|
|
76
|
+
`foo/index.d.ts`: Same
|
|
77
|
+
|
|
78
|
+
`foo/subModule.d.ts`:
|
|
79
|
+
```ts
|
|
80
|
+
export function f(): number;
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
`foo/ts3.1/index.d.ts`:
|
|
84
|
+
```ts
|
|
85
|
+
export function f(): number;
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Don't repeat the header -- only do it in the index of the root.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# export-just-namespace
|
|
2
|
+
|
|
3
|
+
Declaring a namespace is unnecessary if that is the module's only content; just use ES6 export syntax instead.
|
|
4
|
+
|
|
5
|
+
**Bad**:
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
namespace MyLib {
|
|
9
|
+
export function f(): number;
|
|
10
|
+
}
|
|
11
|
+
export = MyLib;
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
**Good**:
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
export function f(): number;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**Also good**:
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
namespace MyLib {
|
|
24
|
+
export function f(): number;
|
|
25
|
+
}
|
|
26
|
+
function MyLib(): number;
|
|
27
|
+
export = MyLib;
|
|
28
|
+
```
|
|
29
|
+
|