@checkdigit/eslint-plugin 7.13.0-PR.57-4258 → 7.13.0-PR.57-b371
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.
|
@@ -1,84 +1,85 @@
|
|
|
1
1
|
// src/file-path-comment.ts
|
|
2
|
-
|
|
2
|
+
import { ESLintUtils } from "@typescript-eslint/utils";
|
|
3
|
+
var ruleId = "validate-first-line-path";
|
|
4
|
+
var VALIDATE_FIRST_LINE_PATH = "VALIDATE_FIRST_LINE_PATH";
|
|
5
|
+
var DISABLE_NEXT_LINE = "eslint-disable-next-line";
|
|
6
|
+
var DISABLED_RULE = "no-util";
|
|
7
|
+
var createRule = ESLintUtils.RuleCreator((name) => name);
|
|
8
|
+
var rule = createRule({
|
|
9
|
+
name: ruleId,
|
|
3
10
|
meta: {
|
|
4
11
|
type: "suggestion",
|
|
5
12
|
docs: {
|
|
6
13
|
description: "Validate that first line of file is a path to the file",
|
|
7
14
|
url: "https://github.com/checkdigit/eslint-plugin"
|
|
8
15
|
},
|
|
9
|
-
fixable: "code"
|
|
16
|
+
fixable: "code",
|
|
17
|
+
schema: [],
|
|
18
|
+
messages: {
|
|
19
|
+
[VALIDATE_FIRST_LINE_PATH]: "First line '{{firstLine}}' is not a valid path to the file."
|
|
20
|
+
}
|
|
10
21
|
},
|
|
22
|
+
defaultOptions: [],
|
|
11
23
|
create(context) {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
+
return {
|
|
25
|
+
Program() {
|
|
26
|
+
const firstLine = context.sourceCode.getLines()[0];
|
|
27
|
+
const expectedPath = context.filename.split("src/")[1];
|
|
28
|
+
if (firstLine === void 0 || expectedPath === void 0) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
if (!firstLine.startsWith("//")) {
|
|
32
|
+
context.report({
|
|
33
|
+
loc: {
|
|
34
|
+
start: {
|
|
35
|
+
line: 0,
|
|
36
|
+
column: 0
|
|
37
|
+
},
|
|
38
|
+
end: {
|
|
39
|
+
line: 0,
|
|
40
|
+
column: 1
|
|
41
|
+
}
|
|
24
42
|
},
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
},
|
|
30
|
-
message: "first line cannot be a block comment",
|
|
31
|
-
fix(fixer) {
|
|
32
|
-
return fixer.insertTextBeforeRange([0, 0], `// ${expectedPath}
|
|
43
|
+
messageId: VALIDATE_FIRST_LINE_PATH,
|
|
44
|
+
data: { firstLine },
|
|
45
|
+
fix(fixer) {
|
|
46
|
+
return fixer.insertTextBeforeRange([0, 0], `// ${expectedPath}
|
|
33
47
|
|
|
34
48
|
`);
|
|
35
|
-
}
|
|
36
|
-
});
|
|
37
|
-
} else {
|
|
38
|
-
context.report({
|
|
39
|
-
loc: {
|
|
40
|
-
start: {
|
|
41
|
-
line: 0,
|
|
42
|
-
column: 0
|
|
43
|
-
},
|
|
44
|
-
end: {
|
|
45
|
-
line: 0,
|
|
46
|
-
column: 1
|
|
47
49
|
}
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
`);
|
|
50
|
+
});
|
|
51
|
+
} else {
|
|
52
|
+
const actualComment = firstLine.split("// ")[1];
|
|
53
|
+
if (actualComment?.startsWith(DISABLE_NEXT_LINE) === true && actualComment.endsWith(DISABLED_RULE)) {
|
|
54
|
+
return;
|
|
54
55
|
}
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
return fixer.replaceTextRange([0, firstLine.length], `// ${expectedPath}`);
|
|
56
|
+
if (expectedPath !== actualComment) {
|
|
57
|
+
context.report({
|
|
58
|
+
loc: {
|
|
59
|
+
start: {
|
|
60
|
+
line: 0,
|
|
61
|
+
column: 0
|
|
62
|
+
},
|
|
63
|
+
end: {
|
|
64
|
+
line: 0,
|
|
65
|
+
column: 1
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
messageId: VALIDATE_FIRST_LINE_PATH,
|
|
69
|
+
data: { firstLine },
|
|
70
|
+
fix(fixer) {
|
|
71
|
+
return fixer.replaceTextRange([0, firstLine.length], `// ${expectedPath}`);
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
74
|
}
|
|
75
|
-
}
|
|
75
|
+
}
|
|
76
76
|
}
|
|
77
|
-
}
|
|
78
|
-
return {};
|
|
77
|
+
};
|
|
79
78
|
}
|
|
80
|
-
};
|
|
79
|
+
});
|
|
80
|
+
var file_path_comment_default = rule;
|
|
81
81
|
export {
|
|
82
|
-
file_path_comment_default as default
|
|
82
|
+
file_path_comment_default as default,
|
|
83
|
+
ruleId
|
|
83
84
|
};
|
|
84
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
85
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2ZpbGUtcGF0aC1jb21tZW50LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVFBLFNBQVMsbUJBQW1CO0FBRXJCLElBQU0sU0FBUztBQUN0QixJQUFNLDJCQUEyQjtBQUNqQyxJQUFNLG9CQUFvQjtBQUMxQixJQUFNLGdCQUFnQjtBQUV0QixJQUFNLGFBQWEsWUFBWSxZQUFZLENBQUMsU0FBUyxJQUFJO0FBRXpELElBQU0sT0FBZ0UsV0FBVztBQUFBLEVBQy9FLE1BQU07QUFBQSxFQUNOLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxJQUNOLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxNQUNiLEtBQUs7QUFBQSxJQUNQO0FBQUEsSUFDQSxTQUFTO0FBQUEsSUFDVCxRQUFRLENBQUM7QUFBQSxJQUNULFVBQVU7QUFBQSxNQUNSLENBQUMsd0JBQXdCLEdBQUc7QUFBQSxJQUM5QjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGdCQUFnQixDQUFDO0FBQUEsRUFDakIsT0FBTyxTQUFTO0FBQ2QsV0FBTztBQUFBLE1BQ0wsVUFBVTtBQUNSLGNBQU0sWUFBWSxRQUFRLFdBQVcsU0FBUyxFQUFFLENBQUM7QUFDakQsY0FBTSxlQUFlLFFBQVEsU0FBUyxNQUFNLE1BQU0sRUFBRSxDQUFDO0FBRXJELFlBQUksY0FBYyxVQUFhLGlCQUFpQixRQUFXO0FBQ3pEO0FBQUEsUUFDRjtBQUVBLFlBQUksQ0FBQyxVQUFVLFdBQVcsSUFBSSxHQUFHO0FBQy9CLGtCQUFRLE9BQU87QUFBQSxZQUNiLEtBQUs7QUFBQSxjQUNILE9BQU87QUFBQSxnQkFDTCxNQUFNO0FBQUEsZ0JBQ04sUUFBUTtBQUFBLGNBQ1Y7QUFBQSxjQUNBLEtBQUs7QUFBQSxnQkFDSCxNQUFNO0FBQUEsZ0JBQ04sUUFBUTtBQUFBLGNBQ1Y7QUFBQSxZQUNGO0FBQUEsWUFDQSxXQUFXO0FBQUEsWUFDWCxNQUFNLEVBQUUsVUFBVTtBQUFBLFlBQ2xCLElBQUksT0FBTztBQUNULHFCQUFPLE1BQU0sc0JBQXNCLENBQUMsR0FBRyxDQUFDLEdBQUcsTUFBTSxZQUFZO0FBQUE7QUFBQSxDQUFNO0FBQUEsWUFDckU7QUFBQSxVQUNGLENBQUM7QUFBQSxRQUNILE9BQU87QUFDTCxnQkFBTSxnQkFBZ0IsVUFBVSxNQUFNLEtBQUssRUFBRSxDQUFDO0FBRTlDLGNBQUksZUFBZSxXQUFXLGlCQUFpQixNQUFNLFFBQVEsY0FBYyxTQUFTLGFBQWEsR0FBRztBQUNsRztBQUFBLFVBQ0Y7QUFFQSxjQUFJLGlCQUFpQixlQUFlO0FBQ2xDLG9CQUFRLE9BQU87QUFBQSxjQUNiLEtBQUs7QUFBQSxnQkFDSCxPQUFPO0FBQUEsa0JBQ0wsTUFBTTtBQUFBLGtCQUNOLFFBQVE7QUFBQSxnQkFDVjtBQUFBLGdCQUNBLEtBQUs7QUFBQSxrQkFDSCxNQUFNO0FBQUEsa0JBQ04sUUFBUTtBQUFBLGdCQUNWO0FBQUEsY0FDRjtBQUFBLGNBQ0EsV0FBVztBQUFBLGNBQ1gsTUFBTSxFQUFFLFVBQVU7QUFBQSxjQUNsQixJQUFJLE9BQU87QUFDVCx1QkFBTyxNQUFNLGlCQUFpQixDQUFDLEdBQUcsVUFBVSxNQUFNLEdBQUcsTUFBTSxZQUFZLEVBQUU7QUFBQSxjQUMzRTtBQUFBLFlBQ0YsQ0FBQztBQUFBLFVBQ0g7QUFBQSxRQUNGO0FBQUEsTUFDRjtBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBQ0YsQ0FBQztBQUVELElBQU8sNEJBQVE7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
import
|
|
2
|
-
declare const
|
|
3
|
-
|
|
1
|
+
import { ESLintUtils } from '@typescript-eslint/utils';
|
|
2
|
+
export declare const ruleId = "validate-first-line-path";
|
|
3
|
+
declare const VALIDATE_FIRST_LINE_PATH = "VALIDATE_FIRST_LINE_PATH";
|
|
4
|
+
declare const rule: ESLintUtils.RuleModule<typeof VALIDATE_FIRST_LINE_PATH>;
|
|
5
|
+
export default rule;
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/eslint-plugin","version":"7.13.0-PR.57-
|
|
1
|
+
{"name":"@checkdigit/eslint-plugin","version":"7.13.0-PR.57-b371","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.23.0","@typescript-eslint/utils":"^8.23.0","http-status-codes":"^2.3.0","ts-api-utils":"^2.0.1"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^6.1.0","@checkdigit/typescript-config":"^9.0.0","@eslint/js":"^9.19.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.23.0","@typescript-eslint/rule-tester":"^8.23.0","eslint":"^9.19.0","eslint-config-prettier":"^10.0.1","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-eslint-plugin":"^6.4.0","eslint-plugin-import":"^2.31.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^2.2.1","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","rimraf":"^6.0.1","typescript-eslint":"^8.23.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=20.17"}}
|
package/src/file-path-comment.ts
CHANGED
|
@@ -1,14 +1,22 @@
|
|
|
1
1
|
// file-path-comment.ts
|
|
2
2
|
|
|
3
|
-
import type { Rule } from 'eslint';
|
|
4
|
-
|
|
5
3
|
/*
|
|
6
|
-
* Copyright (c) 2021-
|
|
4
|
+
* Copyright (c) 2021-2025 Check Digit, LLC
|
|
7
5
|
*
|
|
8
6
|
* This code is licensed under the MIT license (see LICENSE.txt for details).
|
|
9
7
|
*/
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
import { ESLintUtils } from '@typescript-eslint/utils';
|
|
10
|
+
|
|
11
|
+
export const ruleId = 'validate-first-line-path';
|
|
12
|
+
const VALIDATE_FIRST_LINE_PATH = 'VALIDATE_FIRST_LINE_PATH';
|
|
13
|
+
const DISABLE_NEXT_LINE = 'eslint-disable-next-line';
|
|
14
|
+
const DISABLED_RULE = 'no-util';
|
|
15
|
+
|
|
16
|
+
const createRule = ESLintUtils.RuleCreator((name) => name);
|
|
17
|
+
|
|
18
|
+
const rule: ESLintUtils.RuleModule<typeof VALIDATE_FIRST_LINE_PATH> = createRule({
|
|
19
|
+
name: ruleId,
|
|
12
20
|
meta: {
|
|
13
21
|
type: 'suggestion',
|
|
14
22
|
docs: {
|
|
@@ -16,73 +24,70 @@ export default {
|
|
|
16
24
|
url: 'https://github.com/checkdigit/eslint-plugin',
|
|
17
25
|
},
|
|
18
26
|
fixable: 'code',
|
|
27
|
+
schema: [],
|
|
28
|
+
messages: {
|
|
29
|
+
[VALIDATE_FIRST_LINE_PATH]: "First line '{{firstLine}}' is not a valid path to the file.",
|
|
30
|
+
},
|
|
19
31
|
},
|
|
32
|
+
defaultOptions: [],
|
|
20
33
|
create(context) {
|
|
21
|
-
|
|
22
|
-
|
|
34
|
+
return {
|
|
35
|
+
Program() {
|
|
36
|
+
const firstLine = context.sourceCode.getLines()[0];
|
|
37
|
+
const expectedPath = context.filename.split('src/')[1];
|
|
23
38
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
39
|
+
if (firstLine === undefined || expectedPath === undefined) {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
27
42
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
43
|
+
if (!firstLine.startsWith('//')) {
|
|
44
|
+
context.report({
|
|
45
|
+
loc: {
|
|
46
|
+
start: {
|
|
47
|
+
line: 0,
|
|
48
|
+
column: 0,
|
|
49
|
+
},
|
|
50
|
+
end: {
|
|
51
|
+
line: 0,
|
|
52
|
+
column: 1,
|
|
53
|
+
},
|
|
39
54
|
},
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
},
|
|
45
|
-
});
|
|
46
|
-
} else {
|
|
47
|
-
context.report({
|
|
48
|
-
loc: {
|
|
49
|
-
start: {
|
|
50
|
-
line: 0,
|
|
51
|
-
column: 0,
|
|
55
|
+
messageId: VALIDATE_FIRST_LINE_PATH,
|
|
56
|
+
data: { firstLine },
|
|
57
|
+
fix(fixer) {
|
|
58
|
+
return fixer.insertTextBeforeRange([0, 0], `// ${expectedPath}\n\n`);
|
|
52
59
|
},
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
},
|
|
57
|
-
},
|
|
58
|
-
message: 'first line is not a comment with the file path',
|
|
59
|
-
fix(fixer: Rule.RuleFixer) {
|
|
60
|
-
return fixer.insertTextBeforeRange([0, 0], `// ${expectedPath}\n\n`);
|
|
61
|
-
},
|
|
62
|
-
});
|
|
63
|
-
}
|
|
64
|
-
} else {
|
|
65
|
-
const actualComment = firstLine.split('// ')[1];
|
|
66
|
-
if (expectedPath !== actualComment) {
|
|
67
|
-
context.report({
|
|
68
|
-
loc: {
|
|
69
|
-
start: {
|
|
70
|
-
line: 0,
|
|
71
|
-
column: 0,
|
|
72
|
-
},
|
|
73
|
-
end: {
|
|
74
|
-
line: 0,
|
|
75
|
-
column: 1,
|
|
76
|
-
},
|
|
77
|
-
},
|
|
78
|
-
message: 'first line is a comment but is not a path to the file',
|
|
79
|
-
fix(fixer: Rule.RuleFixer) {
|
|
80
|
-
return fixer.replaceTextRange([0, firstLine.length], `// ${expectedPath}`);
|
|
81
|
-
},
|
|
82
|
-
});
|
|
83
|
-
}
|
|
84
|
-
}
|
|
60
|
+
});
|
|
61
|
+
} else {
|
|
62
|
+
const actualComment = firstLine.split('// ')[1];
|
|
85
63
|
|
|
86
|
-
|
|
64
|
+
if (actualComment?.startsWith(DISABLE_NEXT_LINE) === true && actualComment.endsWith(DISABLED_RULE)) {
|
|
65
|
+
return;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
if (expectedPath !== actualComment) {
|
|
69
|
+
context.report({
|
|
70
|
+
loc: {
|
|
71
|
+
start: {
|
|
72
|
+
line: 0,
|
|
73
|
+
column: 0,
|
|
74
|
+
},
|
|
75
|
+
end: {
|
|
76
|
+
line: 0,
|
|
77
|
+
column: 1,
|
|
78
|
+
},
|
|
79
|
+
},
|
|
80
|
+
messageId: VALIDATE_FIRST_LINE_PATH,
|
|
81
|
+
data: { firstLine },
|
|
82
|
+
fix(fixer) {
|
|
83
|
+
return fixer.replaceTextRange([0, firstLine.length], `// ${expectedPath}`);
|
|
84
|
+
},
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
};
|
|
87
90
|
},
|
|
88
|
-
}
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
export default rule;
|