@progressive-victory/eslint-plugin-index-file 1.1.5 → 1.2.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/dist/index.d.ts +15 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/rules/enforce-index-import.d.ts +7 -1
- package/dist/rules/enforce-index-import.d.ts.map +1 -1
- package/dist/rules/enforce-index-import.js +24 -3
- package/dist/rules/enforce-index-import.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
declare const
|
|
1
|
+
declare const enforceIndexUsage: {
|
|
2
2
|
configs: {
|
|
3
3
|
readonly recommended: {
|
|
4
4
|
plugins: {
|
|
@@ -42,15 +42,19 @@ declare const plugin: {
|
|
|
42
42
|
};
|
|
43
43
|
devDependencies: {
|
|
44
44
|
"@types/node": string;
|
|
45
|
+
"@typescript-eslint/eslint-plugin": string;
|
|
46
|
+
"@typescript-eslint/parser": string;
|
|
45
47
|
"@typescript-eslint/rule-tester": string;
|
|
48
|
+
"@typescript-eslint/utils": string;
|
|
46
49
|
esbuild: string;
|
|
50
|
+
eslint: string;
|
|
47
51
|
globals: string;
|
|
48
52
|
prettier: string;
|
|
49
53
|
typescript: string;
|
|
50
54
|
"typescript-eslint": string;
|
|
51
55
|
vitest: string;
|
|
52
56
|
};
|
|
53
|
-
|
|
57
|
+
peerDependencies: {
|
|
54
58
|
"@typescript-eslint/eslint-plugin": string;
|
|
55
59
|
"@typescript-eslint/parser": string;
|
|
56
60
|
"@typescript-eslint/utils": string;
|
|
@@ -88,15 +92,19 @@ declare const plugin: {
|
|
|
88
92
|
};
|
|
89
93
|
devDependencies: {
|
|
90
94
|
"@types/node": string;
|
|
95
|
+
"@typescript-eslint/eslint-plugin": string;
|
|
96
|
+
"@typescript-eslint/parser": string;
|
|
91
97
|
"@typescript-eslint/rule-tester": string;
|
|
98
|
+
"@typescript-eslint/utils": string;
|
|
92
99
|
esbuild: string;
|
|
100
|
+
eslint: string;
|
|
93
101
|
globals: string;
|
|
94
102
|
prettier: string;
|
|
95
103
|
typescript: string;
|
|
96
104
|
"typescript-eslint": string;
|
|
97
105
|
vitest: string;
|
|
98
106
|
};
|
|
99
|
-
|
|
107
|
+
peerDependencies: {
|
|
100
108
|
"@typescript-eslint/eslint-plugin": string;
|
|
101
109
|
"@typescript-eslint/parser": string;
|
|
102
110
|
"@typescript-eslint/utils": string;
|
|
@@ -108,10 +116,12 @@ declare const plugin: {
|
|
|
108
116
|
"enforce-index-usage": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noIndexPresent" | "notExportedInIndex", [], import("./utils.js").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
109
117
|
name: string;
|
|
110
118
|
};
|
|
111
|
-
"enforce-import-from-index": import("@typescript-eslint/utils/ts-eslint").RuleModule<"importDoesNotTargetIndex", [
|
|
119
|
+
"enforce-import-from-index": import("@typescript-eslint/utils/ts-eslint").RuleModule<"importDoesNotTargetIndex", [{
|
|
120
|
+
exemptSameDirectoryImports: boolean;
|
|
121
|
+
}], import("./utils.js").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
112
122
|
name: string;
|
|
113
123
|
};
|
|
114
124
|
};
|
|
115
125
|
};
|
|
116
|
-
export default
|
|
126
|
+
export default enforceIndexUsage;
|
|
117
127
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWtB,CAAA;AAYD,eAAe,iBAAiB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { enforceIndexExportRule, enforceIndexImportRule } from "./rules/index.js";
|
|
2
2
|
import name from "../package.json" with { type: "json" };
|
|
3
3
|
import version from "../package.json" with { type: "json" };
|
|
4
|
-
const
|
|
4
|
+
const enforceIndexUsage = {
|
|
5
5
|
configs: {
|
|
6
6
|
get recommended() {
|
|
7
7
|
return recommended;
|
|
@@ -15,12 +15,12 @@ const plugin = {
|
|
|
15
15
|
};
|
|
16
16
|
const recommended = {
|
|
17
17
|
plugins: {
|
|
18
|
-
"eslint-plugin-index-file":
|
|
18
|
+
"eslint-plugin-index-file": enforceIndexUsage
|
|
19
19
|
},
|
|
20
20
|
rules: {
|
|
21
21
|
"eslint-plugin-index-file/enforce-index-usage": "error",
|
|
22
22
|
"eslint-plugin-index-file/enforce-import-from-index": "error"
|
|
23
23
|
}
|
|
24
24
|
};
|
|
25
|
-
export default
|
|
25
|
+
export default enforceIndexUsage;
|
|
26
26
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,sBAAsB,EAAE,sBAAsB,EAAC,MAAM,kBAAkB,CAAA;AAC/E,OAAO,IAAI,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACzD,OAAO,OAAO,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5D,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,sBAAsB,EAAE,sBAAsB,EAAC,MAAM,kBAAkB,CAAA;AAC/E,OAAO,IAAI,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACzD,OAAO,OAAO,MAAM,iBAAiB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5D,MAAM,iBAAiB,GAAG;IACtB,OAAO,EAAE;QACL,IAAI,WAAW;YACX,OAAO,WAAW,CAAA;QACtB,CAAC;KACJ;IACD,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;IACvB,KAAK,EAAE;QACH,qBAAqB,EAAE,sBAAsB;QAC7C,2BAA2B,EAAE,sBAAsB;KACtD;CACJ,CAAA;AAED,MAAM,WAAW,GAAG;IAChB,OAAO,EAAE;QACL,0BAA0B,EAAE,iBAAiB;KAChD;IACD,KAAK,EAAE;QACH,8CAA8C,EAAE,OAAO;QACvD,oDAAoD,EAAE,OAAO;KAChE;CACJ,CAAA;AAED,eAAe,iBAAiB,CAAC"}
|
|
@@ -1,4 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
type Options = [
|
|
2
|
+
{
|
|
3
|
+
exemptSameDirectoryImports: boolean;
|
|
4
|
+
}
|
|
5
|
+
];
|
|
6
|
+
export declare const enforceIndexImportRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"importDoesNotTargetIndex", Options, import("../utils.js").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
2
7
|
name: string;
|
|
3
8
|
};
|
|
9
|
+
export {};
|
|
4
10
|
//# sourceMappingURL=enforce-index-import.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enforce-index-import.d.ts","sourceRoot":"","sources":["../../src/rules/enforce-index-import.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"enforce-index-import.d.ts","sourceRoot":"","sources":["../../src/rules/enforce-index-import.ts"],"names":[],"mappings":"AAOA,KAAK,OAAO,GAAG;IACX;QACI,0BAA0B,EAAE,OAAO,CAAA;KACtC;CACJ,CAAA;AAkCD,eAAO,MAAM,sBAAsB;;CA8EjC,CAAA"}
|
|
@@ -31,8 +31,12 @@ function getImportType(importStr, compilerOpts) {
|
|
|
31
31
|
}
|
|
32
32
|
}
|
|
33
33
|
export const enforceIndexImportRule = createRule({
|
|
34
|
-
create(context) {
|
|
34
|
+
create(context, options) {
|
|
35
35
|
const services = getParserServices(context);
|
|
36
|
+
const testSameDir = (importStr) => {
|
|
37
|
+
const splitImport = importStr.split('/');
|
|
38
|
+
return splitImport[0] === '.' && splitImport.length === 2;
|
|
39
|
+
};
|
|
36
40
|
return {
|
|
37
41
|
ImportDeclaration(node) {
|
|
38
42
|
const importStr = node.source.value;
|
|
@@ -41,6 +45,9 @@ export const enforceIndexImportRule = createRule({
|
|
|
41
45
|
let resolvedPath;
|
|
42
46
|
switch (importType) {
|
|
43
47
|
case "relative":
|
|
48
|
+
const isSameDir = testSameDir(importStr);
|
|
49
|
+
if (options[0].exemptSameDirectoryImports && isSameDir)
|
|
50
|
+
return;
|
|
44
51
|
const filePathStr = path.resolve(context.physicalFilename);
|
|
45
52
|
const filePath = path.parse(filePathStr);
|
|
46
53
|
resolvedPath = path.resolve(filePath.dir, importStr);
|
|
@@ -85,9 +92,23 @@ export const enforceIndexImportRule = createRule({
|
|
|
85
92
|
importDoesNotTargetIndex: "Import statement should target the index of the source, not the source itself."
|
|
86
93
|
},
|
|
87
94
|
type: "problem",
|
|
88
|
-
schema: [
|
|
95
|
+
schema: [
|
|
96
|
+
{
|
|
97
|
+
type: 'object',
|
|
98
|
+
properties: {
|
|
99
|
+
exemptSameDirectoryImports: {
|
|
100
|
+
type: 'boolean'
|
|
101
|
+
}
|
|
102
|
+
},
|
|
103
|
+
additionalProperties: false,
|
|
104
|
+
},
|
|
105
|
+
]
|
|
89
106
|
},
|
|
90
107
|
name: "enforce-import-from-index",
|
|
91
|
-
defaultOptions: [
|
|
108
|
+
defaultOptions: [
|
|
109
|
+
{
|
|
110
|
+
exemptSameDirectoryImports: true
|
|
111
|
+
}
|
|
112
|
+
]
|
|
92
113
|
});
|
|
93
114
|
//# sourceMappingURL=enforce-index-import.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enforce-index-import.js","sourceRoot":"","sources":["../../src/rules/enforce-index-import.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAA;AAEzE,OAAO,EAAE,MAAM,IAAI,CAAA;
|
|
1
|
+
{"version":3,"file":"enforce-index-import.js","sourceRoot":"","sources":["../../src/rules/enforce-index-import.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAA;AAEzE,OAAO,EAAE,MAAM,IAAI,CAAA;AAUnB,SAAS,YAAY,CAAC,SAAiB,EAAE,eAAyB;IAC9D,KAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QAChC,IAAG,CAAC,KAAK;YAAE,MAAM,KAAK,CAAC,2BAA2B,CAAC,CAAA;QACnD,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QAC9C,MAAM,UAAU,GAAG,IAAI,YAAY,EAAE,CAAA;QACrC,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;QAEtC,IAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,IAAI,CAAA;IAC3C,CAAC;IAED,OAAO,KAAK,CAAA;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,SAAiB,EAAE,YAA6B;IACnE,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,CAAA;IAC7D,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,CAAA;IAClD,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;IAE5C,QAAO,IAAI,EAAE,CAAC;QACV,KAAK,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC;YAChC,OAAO,UAAU,CAAA;QACrB,KAAK,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;YAC9B,OAAO,QAAQ,CAAA;QACnB,KAAK,CAAC,CAAC,eAAe,IAAI,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC;YAC9D,OAAO,SAAS,CAAA;QACpB;YACI,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACrD,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAsB;IAClE,MAAM,CAAC,OAAO,EAAE,OAAO;QACnB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;QAE3C,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAW,EAAE;YAC/C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxC,OAAO,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,CAAA;QAC7D,CAAC,CAAA;QAED,OAAO;YACH,iBAAiB,CAAC,IAAI;gBAClB,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;gBACnC,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAA;gBAC1D,MAAM,UAAU,GAAG,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;gBAEzD,IAAI,YAAY,CAAC;gBACjB,QAAQ,UAAU,EAAE,CAAC;oBACjB,KAAK,UAAU;wBACX,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;wBACxC,IAAG,OAAO,CAAC,CAAC,CAAC,CAAC,0BAA0B,IAAI,SAAS;4BAAE,OAAO;wBAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;wBAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;wBACxC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;wBACpD,MAAM;oBACV,KAAK,SAAS;wBACV,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;wBACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;wBAC/B,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAA;wBAClC,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ;4BAAE,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAA;wBAC7E,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;wBAClE,IAAI,CAAC,KAAK;4BAAE,MAAM,KAAK,CAAC,iCAAiC,CAAC,CAAA;wBAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;wBACvD,IAAI,CAAC,SAAS;4BAAE,MAAM,KAAK,CAAC,oBAAoB,CAAC,CAAA;wBACjD,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;wBAC9D,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;wBACxB,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,WAAW,CAAC,CAAA;wBAC3D,MAAM;oBACV,KAAK,QAAQ;wBACT,OAAO;gBACf,CAAC;gBAED,YAAY,GAAG,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;gBACtF,IAAG,CAAC,YAAY;oBAAE,OAAM;gBACxB,IAAG,CAAC,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE;oBAAE,OAAO,CAAC,MAAM,CAAC;wBACzD,SAAS,EAAE,0BAA0B;wBACrC,IAAI;qBACP,CAAC,CAAA;YACN,CAAC;SACJ,CAAA;IACL,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,8EAA8E;YAC3F,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;SAC9B;QACD,QAAQ,EAAE;YACN,wBAAwB,EAAE,gFAAgF;SAC7G;QACD,IAAI,EAAE,SAAS;QACf,MAAM,EAAE;YACJ;gBACI,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,0BAA0B,EAAE;wBACxB,IAAI,EAAE,SAAS;qBAClB;iBACJ;gBACD,oBAAoB,EAAE,KAAK;aAC9B;SACJ;KACJ;IACD,IAAI,EAAE,2BAA2B;IACjC,cAAc,EAAE;QACZ;YACI,0BAA0B,EAAE,IAAI;SACnC;KACJ;CACJ,CAAC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progressive-victory/eslint-plugin-index-file",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Plugin that enforces the use of index files with eslint.",
|
|
5
5
|
"homepage": "https://github.com/Progressive-Victory/eslint-index-file-plugin#readme",
|
|
6
6
|
"bugs": {
|