@progressive-victory/eslint-plugin-index-file 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+declare const plugin: {
+    configs: {
+        readonly recommended: {
+            plugins: {
+                "eslint-index-file-plugin": /*elided*/ any;
+            };
+            enforceIndexUsageRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"notExportedInIndex" | "noIndexPresent", [], import("./utils").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+                name: string;
+            };
+        };
+    };
+    meta: {
+        name: string;
+        version: string;
+    };
+    enforceIndexUsageRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"notExportedInIndex" | "noIndexPresent", [], import("./utils").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+        name: string;
+    };
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;CAQX,CAAA;AASD,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+import { enforceIndexUsageRule } from "./rules";
+const { name, version } = 
+// eslint-diable-next-line @typescript-eslint/no-require-imports
+require("../package.json");
+const plugin = {
+    configs: {
+        get recommended() {
+            return recommended;
+        }
+    },
+    meta: { name, version },
+    enforceIndexUsageRule
+};
+const recommended = {
+    plugins: {
+        "eslint-index-file-plugin": plugin
+    },
+    enforceIndexUsageRule
+};
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAC,MAAM,SAAS,CAAA;AAE7C,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC;AACjB,gEAAgE;AAChE,OAAO,CAAC,iBAAiB,CAAqC,CAAA;AAElE,MAAM,MAAM,GAAG;IACX,OAAO,EAAE;QACL,IAAI,WAAW;YACX,OAAO,WAAW,CAAA;QACtB,CAAC;KACJ;IACD,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;IACvB,qBAAqB;CACxB,CAAA;AAED,MAAM,WAAW,GAAG;IAChB,OAAO,EAAE;QACL,0BAA0B,EAAE,MAAM;KACrC;IACD,qBAAqB;CACxB,CAAA;AAED,eAAe,MAAM,CAAC"}

package/dist/rules/enforce-index-usage.d.ts

@@ -0,0 +1,4 @@
+export declare const enforceIndexUsageRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"notExportedInIndex" | "noIndexPresent", [], import("../utils.js").IndexFileDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+    name: string;
+};
+//# sourceMappingURL=enforce-index-usage.d.ts.map

package/dist/rules/enforce-index-usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-index-usage.d.ts","sourceRoot":"","sources":["../../src/rules/enforce-index-usage.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,qBAAqB;;CAwChC,CAAA"}

package/dist/rules/enforce-index-usage.js

@@ -0,0 +1,46 @@
+//import {ESLintUtils} from "@typescript-eslint/utils"
+import { createRule } from "../utils.js";
+import path from "node:path";
+import fs from "fs";
+export const enforceIndexUsageRule = createRule({
+    create(context) {
+        //const services = ESLintUtils.getParserServices(context);
+        return {
+            ExportNamedDeclaration(node) {
+                console.log("doing shit");
+                const cwd = context.cwd;
+                const cwdFiles = fs.readdirSync(cwd);
+                const index = cwdFiles.find(x => x === "index.ts");
+                if (!index)
+                    context.report({
+                        messageId: 'noIndexPresent',
+                        node
+                    });
+                const fileNameArr = context.filename.split('.');
+                const fileName = fileNameArr[fileNameArr.length - 1];
+                const indexContent = fs.readFileSync(path.join(cwd, "index.ts")).toString();
+                if (!indexContent.includes(`export * from './${fileName}.js`))
+                    context.report({
+                        messageId: "notExportedInIndex",
+                        node
+                    });
+            }
+        };
+    },
+    meta: {
+        docs: {
+            description: "Enforces the usage of index files within code.",
+            recommended: true,
+            requiresTypeChecking: false
+        },
+        messages: {
+            notExportedInIndex: "Export statement not accompanied by index file entry.",
+            noIndexPresent: "Could not find index file in working directory."
+        },
+        type: "problem",
+        schema: []
+    },
+    name: "enforce-index-usage",
+    defaultOptions: []
+});
+//# sourceMappingURL=enforce-index-usage.js.map

package/dist/rules/enforce-index-usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-index-usage.js","sourceRoot":"","sources":["../../src/rules/enforce-index-usage.ts"],"names":[],"mappings":"AAAA,sDAAsD;AAEtD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;IAC5C,MAAM,CAAC,OAAO;QACV,0DAA0D;QAE1D,OAAO;YACH,sBAAsB,CAAC,IAAI;gBACvB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;gBACzB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;gBACvB,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;gBACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,CAAA;gBAClD,IAAG,CAAC,KAAK;oBAAE,OAAO,CAAC,MAAM,CAAC;wBAClB,SAAS,EAAE,gBAAgB;wBAC3B,IAAI;qBACP,CAAC,CAAA;gBAEN,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBAC/C,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;gBACpD,MAAM,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAC3E,IAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,QAAQ,KAAK,CAAC;oBAAE,OAAO,CAAC,MAAM,CAAC;wBACzE,SAAS,EAAE,oBAAoB;wBAC/B,IAAI;qBACP,CAAC,CAAA;YACN,CAAC;SACJ,CAAA;IACL,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,WAAW,EAAE,gDAAgD;YAC7D,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;SAC9B;QACD,QAAQ,EAAE;YACN,kBAAkB,EAAE,uDAAuD;YAC3E,cAAc,EAAE,iDAAiD;SACpE;QACD,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,EAAE;KACb;IACD,IAAI,EAAE,qBAAqB;IAC3B,cAAc,EAAE,EAAE;CACrB,CAAC,CAAA"}

package/dist/rules/enforce-index-usage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=enforce-index-usage.test.d.ts.map

package/dist/rules/enforce-index-usage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-index-usage.test.d.ts","sourceRoot":"","sources":["../../src/rules/enforce-index-usage.test.ts"],"names":[],"mappings":""}

package/dist/rules/enforce-index-usage.test.js

@@ -0,0 +1,40 @@
+import path from "path";
+import tseslint from "typescript-eslint";
+import { RuleTester } from "@typescript-eslint/rule-tester";
+import * as vitest from "vitest";
+import { enforceIndexUsageRule } from "./enforce-index-usage";
+RuleTester.afterAll = vitest.afterAll;
+RuleTester.it = vitest.it;
+RuleTester.itOnly = vitest.it.only;
+RuleTester.describe = vitest.describe;
+const ruleTester = new RuleTester({
+    languageOptions: {
+        parser: tseslint.parser,
+        parserOptions: {
+            projectService: {
+                allowDefaultProject: ["*.js"],
+                defaultProject: "tsconfig.json"
+            },
+            tsconfigRootDir: path.join(import.meta.dirname, "../..")
+        }
+    }
+});
+ruleTester.run("enforce-index-usage", enforceIndexUsageRule, {
+    valid: [
+        {
+            code: `export const foo = bar`
+        }
+    ],
+    invalid: [
+        {
+            code: `export const bar = foo`,
+            errors: [
+                {
+                    messageId: "notExportedInIndex",
+                    suggestions: []
+                }
+            ]
+        }
+    ]
+});
+//# sourceMappingURL=enforce-index-usage.test.js.map

package/dist/rules/enforce-index-usage.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-index-usage.test.js","sourceRoot":"","sources":["../../src/rules/enforce-index-usage.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAA;AAC3D,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAE7D,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;AACrC,UAAU,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAA;AACzB,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,IAAI,CAAA;AAClC,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;AAErC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC;IAC9B,eAAe,EAAE;QACb,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,aAAa,EAAE;YACX,cAAc,EAAE;gBACZ,mBAAmB,EAAE,CAAC,MAAM,CAAC;gBAC7B,cAAc,EAAE,eAAe;aAClC;YACD,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;SAC3D;KACJ;CACJ,CAAC,CAAA;AAEF,UAAU,CAAC,GAAG,CAAC,qBAAqB,EAAE,qBAAqB,EAAE;IACzD,KAAK,EAAE;QACH;YACI,IAAI,EAAE,wBAAwB;SACjC;KACJ;IACD,OAAO,EAAE;QACL;YACI,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE;gBACJ;oBACI,SAAS,EAAE,oBAAoB;oBAC/B,WAAW,EAAE,EACZ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAC,CAAA"}

package/dist/rules/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enforce-index-usage.js';
+export * from './enforce-index-usage.test.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/rules/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA"}

package/dist/rules/index.js

@@ -0,0 +1,3 @@
+export * from './enforce-index-usage.js';
+export * from './enforce-index-usage.test.js';
+//# sourceMappingURL=index.js.map

package/dist/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,+BAA+B,CAAA"}

package/dist/utils.d.ts

@@ -0,0 +1,10 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export interface IndexFileDocs {
+    description: string;
+    recommended?: boolean;
+    requiresTypeChecking?: boolean;
+}
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, IndexFileDocs>>) => ESLintUtils.RuleModule<MessageIds, Options, IndexFileDocs, ESLintUtils.RuleListener> & {
+    name: string;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAA;AAEpD,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,eAAO,MAAM,UAAU;;CAEtB,CAAA"}

package/dist/utils.js

@@ -0,0 +1,3 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export const createRule = ESLintUtils.RuleCreator((name) => `https://github.com/import-js/eslint-plugin-import/wiki/${name}`);
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAA;AAQpD,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CAC7C,CAAC,IAAI,EAAE,EAAE,CAAC,0DAA0D,IAAI,EAAE,CAC7E,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progressive-victory/eslint-plugin-index-file",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Plugin that enforces the use of index files with eslint.",
   "homepage": "https://github.com/Progressive-Victory/eslint-index-file-plugin#readme",
   "private": false,