@progressive-victory/eslint-plugin-index-file 0.0.3 → 0.0.5

package/dist/index.js

@@ -0,0 +1,170 @@
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+
+// package.json
+var require_package = __commonJS({
+  "package.json"(exports, module) {
+    module.exports = {
+      name: "@progressive-victory/eslint-plugin-index-file",
+      version: "0.0.4",
+      description: "Plugin that enforces the use of index files with eslint.",
+      homepage: "https://github.com/Progressive-Victory/eslint-index-file-plugin#readme",
+      private: false,
+      bugs: {
+        url: "https://github.com/Progressive-Victory/eslint-index-file-plugin/issues"
+      },
+      repository: {
+        type: "git",
+        url: "git+https://github.com/Progressive-Victory/eslint-index-file-plugin.git"
+      },
+      license: "ISC",
+      author: "sH3llH0und",
+      type: "module",
+      packageManager: "pnpm@10.30.2",
+      main: "dist/index.js",
+      exports: {
+        "./*.js": {
+          types: "./*.d.ts",
+          require: "./*.js",
+          import: "./*.js"
+        }
+      },
+      scripts: {
+        build: "node esbuild.config.js",
+        test: "pnpm build && pnpm vitest --silent=false"
+      },
+      devDependencies: {
+        "@types/node": "^25.9.1",
+        "@typescript-eslint/rule-tester": "^8.60.1",
+        esbuild: "^0.28.0",
+        globals: "^17.6.0",
+        prettier: "^3.8.3",
+        typescript: "^6.0.3",
+        "typescript-eslint": "^8.60.1",
+        vitest: "^4.1.8"
+      },
+      dependencies: {
+        "@typescript-eslint/eslint-plugin": "^8.60.1",
+        "@typescript-eslint/parser": "^8.60.1",
+        "@typescript-eslint/utils": "^8.60.1",
+        eslint: "^10.4.1"
+      }
+    };
+  }
+});
+
+// src/utils.ts
+import { ESLintUtils } from "@typescript-eslint/utils";
+var createRule = ESLintUtils.RuleCreator(
+  (name2) => `https://github.com/import-js/eslint-plugin-import/wiki/${name2}`
+);
+
+// src/rules/enforce-index-usage.ts
+import path from "node:path";
+import fs from "fs";
+var enforceIndexUsageRule = createRule({
+  create(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: []
+});
+
+// src/rules/enforce-index-usage.test.ts
+import path2 from "path";
+import tseslint from "typescript-eslint";
+import { RuleTester } from "@typescript-eslint/rule-tester";
+import * as vitest from "vitest";
+RuleTester.afterAll = vitest.afterAll;
+RuleTester.it = vitest.it;
+RuleTester.itOnly = vitest.it.only;
+RuleTester.describe = vitest.describe;
+var ruleTester = new RuleTester({
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: {
+      projectService: {
+        allowDefaultProject: ["*.js"],
+        defaultProject: "tsconfig.json"
+      },
+      tsconfigRootDir: path2.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: []
+        }
+      ]
+    }
+  ]
+});
+
+// src/index.ts
+var { name, version } = (
+  // eslint-diable-next-line @typescript-eslint/no-require-imports
+  require_package()
+);
+var plugin = {
+  configs: {
+    get recommended() {
+      return recommended;
+    }
+  },
+  meta: { name, version },
+  enforceIndexUsageRule
+};
+var recommended = {
+  plugins: {
+    "eslint-index-file-plugin": plugin
+  },
+  enforceIndexUsageRule
+};
+var index_default = plugin;
+export {
+  index_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../package.json", "../src/utils.ts", "../src/rules/enforce-index-usage.ts", "../src/rules/enforce-index-usage.test.ts", "../src/index.ts"],
+  "sourcesContent": ["{\n  \"name\": \"@progressive-victory/eslint-plugin-index-file\",\n  \"version\": \"0.0.4\",\n  \"description\": \"Plugin that enforces the use of index files with eslint.\",\n  \"homepage\": \"https://github.com/Progressive-Victory/eslint-index-file-plugin#readme\",\n  \"private\": false,\n  \"bugs\": {\n    \"url\": \"https://github.com/Progressive-Victory/eslint-index-file-plugin/issues\"\n  },\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"git+https://github.com/Progressive-Victory/eslint-index-file-plugin.git\"\n  },\n  \"license\": \"ISC\",\n  \"author\": \"sH3llH0und\",\n  \"type\": \"module\",\n  \"packageManager\": \"pnpm@10.30.2\",\n  \"main\": \"dist/index.js\",\n  \"exports\": {\n    \"./*.js\": {\n      \"types\": \"./*.d.ts\",\n      \"require\": \"./*.js\",\n      \"import\": \"./*.js\"\n    }\n  },\n  \"scripts\": {\n    \"build\": \"node esbuild.config.js\",\n    \"test\": \"pnpm build && pnpm vitest --silent=false\"\n  },\n  \"devDependencies\": {\n    \"@types/node\": \"^25.9.1\",\n    \"@typescript-eslint/rule-tester\": \"^8.60.1\",\n    \"esbuild\": \"^0.28.0\",\n    \"globals\": \"^17.6.0\",\n    \"prettier\": \"^3.8.3\",\n    \"typescript\": \"^6.0.3\",\n    \"typescript-eslint\": \"^8.60.1\",\n    \"vitest\": \"^4.1.8\"\n  },\n  \"dependencies\": {\n    \"@typescript-eslint/eslint-plugin\": \"^8.60.1\",\n    \"@typescript-eslint/parser\": \"^8.60.1\",\n    \"@typescript-eslint/utils\": \"^8.60.1\",\n    \"eslint\": \"^10.4.1\"\n  }\n}\n", "import {ESLintUtils} from \"@typescript-eslint/utils\"\r\n\r\nexport interface IndexFileDocs {\r\n    description: string;\r\n    recommended?: boolean;\r\n    requiresTypeChecking?: boolean;\r\n}\r\n\r\nexport const createRule = ESLintUtils.RuleCreator<IndexFileDocs>(\r\n    (name) => `https://github.com/import-js/eslint-plugin-import/wiki/${name}`\r\n)", "//import {ESLintUtils} from \"@typescript-eslint/utils\"\r\n\r\nimport { createRule } from \"../utils.js\"\r\nimport path from \"node:path\"\r\nimport fs from \"fs\"\r\n\r\nexport const enforceIndexUsageRule = createRule({\r\n    create(context) {\r\n        //const services = ESLintUtils.getParserServices(context);\r\n\r\n        return {\r\n            ExportNamedDeclaration(node) {\r\n                console.log(\"doing shit\")\r\n                const cwd = context.cwd\r\n                const cwdFiles = fs.readdirSync(cwd)\r\n                const index = cwdFiles.find(x => x === \"index.ts\")\r\n                if(!index) context.report({\r\n                        messageId: 'noIndexPresent',\r\n                        node\r\n                    })\r\n\r\n                const fileNameArr = context.filename.split('.')\r\n                const fileName = fileNameArr[fileNameArr.length - 1]\r\n                const indexContent = fs.readFileSync(path.join(cwd, \"index.ts\")).toString()\r\n                if(!indexContent.includes(`export * from './${fileName}.js`)) context.report({\r\n                    messageId: \"notExportedInIndex\",\r\n                    node\r\n                })\r\n            }\r\n        }\r\n    },\r\n    meta: {\r\n        docs: {\r\n            description: \"Enforces the usage of index files within code.\",\r\n            recommended: true,\r\n            requiresTypeChecking: false\r\n        },\r\n        messages: {\r\n            notExportedInIndex: \"Export statement not accompanied by index file entry.\",\r\n            noIndexPresent: \"Could not find index file in working directory.\"\r\n        },\r\n        type: \"problem\",\r\n        schema: []\r\n    },\r\n    name: \"enforce-index-usage\",\r\n    defaultOptions: []\r\n})", "import path from \"path\"\r\nimport tseslint from \"typescript-eslint\";\r\nimport { RuleTester } from \"@typescript-eslint/rule-tester\"\r\nimport * as vitest from \"vitest\"\r\n\r\nimport { enforceIndexUsageRule } from \"./enforce-index-usage\"\r\n\r\nRuleTester.afterAll = vitest.afterAll\r\nRuleTester.it = vitest.it\r\nRuleTester.itOnly = vitest.it.only\r\nRuleTester.describe = vitest.describe\r\n\r\nconst ruleTester = new RuleTester({\r\n    languageOptions: {\r\n        parser: tseslint.parser,\r\n        parserOptions: {\r\n            projectService: {\r\n                allowDefaultProject: [\"*.js\"],\r\n                defaultProject: \"tsconfig.json\"\r\n            },\r\n            tsconfigRootDir: path.join(import.meta.dirname, \"../..\")\r\n        }\r\n    }\r\n})\r\n\r\nruleTester.run(\"enforce-index-usage\", enforceIndexUsageRule, {\r\n    valid: [\r\n        {\r\n            code: `export const foo = bar`\r\n        }\r\n    ],\r\n    invalid: [\r\n        {\r\n            code: `export const bar = foo`,\r\n            errors: [\r\n                {\r\n                    messageId: \"notExportedInIndex\",\r\n                    suggestions: [\r\n                    ]\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n})", "import {enforceIndexUsageRule} from \"./rules\"\r\n\r\nconst {name, version} =\r\n    // eslint-diable-next-line @typescript-eslint/no-require-imports\r\n    require(\"../package.json\") as typeof import(\"../package.json\")\r\n\r\nconst plugin = {\r\n    configs: {\r\n        get recommended() {\r\n            return recommended\r\n        }\r\n    },\r\n    meta: { name, version },\r\n    enforceIndexUsageRule\r\n}\r\n\r\nconst recommended = {\r\n    plugins: {\r\n        \"eslint-index-file-plugin\": plugin\r\n    },\r\n    enforceIndexUsageRule\r\n}\r\n\r\nexport default plugin;"],
+  "mappings": ";;;;;;AAAA;AAAA;AAAA;AAAA,MACE,MAAQ;AAAA,MACR,SAAW;AAAA,MACX,aAAe;AAAA,MACf,UAAY;AAAA,MACZ,SAAW;AAAA,MACX,MAAQ;AAAA,QACN,KAAO;AAAA,MACT;AAAA,MACA,YAAc;AAAA,QACZ,MAAQ;AAAA,QACR,KAAO;AAAA,MACT;AAAA,MACA,SAAW;AAAA,MACX,QAAU;AAAA,MACV,MAAQ;AAAA,MACR,gBAAkB;AAAA,MAClB,MAAQ;AAAA,MACR,SAAW;AAAA,QACT,UAAU;AAAA,UACR,OAAS;AAAA,UACT,SAAW;AAAA,UACX,QAAU;AAAA,QACZ;AAAA,MACF;AAAA,MACA,SAAW;AAAA,QACT,OAAS;AAAA,QACT,MAAQ;AAAA,MACV;AAAA,MACA,iBAAmB;AAAA,QACjB,eAAe;AAAA,QACf,kCAAkC;AAAA,QAClC,SAAW;AAAA,QACX,SAAW;AAAA,QACX,UAAY;AAAA,QACZ,YAAc;AAAA,QACd,qBAAqB;AAAA,QACrB,QAAU;AAAA,MACZ;AAAA,MACA,cAAgB;AAAA,QACd,oCAAoC;AAAA,QACpC,6BAA6B;AAAA,QAC7B,4BAA4B;AAAA,QAC5B,QAAU;AAAA,MACZ;AAAA,IACF;AAAA;AAAA;;;AC7CA,SAAQ,mBAAkB;AAQnB,IAAM,aAAa,YAAY;AAAA,EAClC,CAACA,UAAS,0DAA0DA,KAAI;AAC5E;;;ACPA,OAAO,UAAU;AACjB,OAAO,QAAQ;AAER,IAAM,wBAAwB,WAAW;AAAA,EAC5C,OAAO,SAAS;AAGZ,WAAO;AAAA,MACH,uBAAuB,MAAM;AACzB,gBAAQ,IAAI,YAAY;AACxB,cAAM,MAAM,QAAQ;AACpB,cAAM,WAAW,GAAG,YAAY,GAAG;AACnC,cAAM,QAAQ,SAAS,KAAK,OAAK,MAAM,UAAU;AACjD,YAAG,CAAC,MAAO,SAAQ,OAAO;AAAA,UAClB,WAAW;AAAA,UACX;AAAA,QACJ,CAAC;AAEL,cAAM,cAAc,QAAQ,SAAS,MAAM,GAAG;AAC9C,cAAM,WAAW,YAAY,YAAY,SAAS,CAAC;AACnD,cAAM,eAAe,GAAG,aAAa,KAAK,KAAK,KAAK,UAAU,CAAC,EAAE,SAAS;AAC1E,YAAG,CAAC,aAAa,SAAS,oBAAoB,QAAQ,KAAK,EAAG,SAAQ,OAAO;AAAA,UACzE,WAAW;AAAA,UACX;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ;AAAA,EACJ;AAAA,EACA,MAAM;AAAA,IACF,MAAM;AAAA,MACF,aAAa;AAAA,MACb,aAAa;AAAA,MACb,sBAAsB;AAAA,IAC1B;AAAA,IACA,UAAU;AAAA,MACN,oBAAoB;AAAA,MACpB,gBAAgB;AAAA,IACpB;AAAA,IACA,MAAM;AAAA,IACN,QAAQ,CAAC;AAAA,EACb;AAAA,EACA,MAAM;AAAA,EACN,gBAAgB,CAAC;AACrB,CAAC;;;AC9CD,OAAOC,WAAU;AACjB,OAAO,cAAc;AACrB,SAAS,kBAAkB;AAC3B,YAAY,YAAY;AAIxB,WAAW,WAAkB;AAC7B,WAAW,KAAY;AACvB,WAAW,SAAgB,UAAG;AAC9B,WAAW,WAAkB;AAE7B,IAAM,aAAa,IAAI,WAAW;AAAA,EAC9B,iBAAiB;AAAA,IACb,QAAQ,SAAS;AAAA,IACjB,eAAe;AAAA,MACX,gBAAgB;AAAA,QACZ,qBAAqB,CAAC,MAAM;AAAA,QAC5B,gBAAgB;AAAA,MACpB;AAAA,MACA,iBAAiBC,MAAK,KAAK,YAAY,SAAS,OAAO;AAAA,IAC3D;AAAA,EACJ;AACJ,CAAC;AAED,WAAW,IAAI,uBAAuB,uBAAuB;AAAA,EACzD,OAAO;AAAA,IACH;AAAA,MACI,MAAM;AAAA,IACV;AAAA,EACJ;AAAA,EACA,SAAS;AAAA,IACL;AAAA,MACI,MAAM;AAAA,MACN,QAAQ;AAAA,QACJ;AAAA,UACI,WAAW;AAAA,UACX,aAAa,CACb;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ,CAAC;;;ACzCD,IAAM,EAAC,MAAM,QAAO;AAAA;AAAA,EAEhB;AAAA;AAEJ,IAAM,SAAS;AAAA,EACX,SAAS;AAAA,IACL,IAAI,cAAc;AACd,aAAO;AAAA,IACX;AAAA,EACJ;AAAA,EACA,MAAM,EAAE,MAAM,QAAQ;AAAA,EACtB;AACJ;AAEA,IAAM,cAAc;AAAA,EAChB,SAAS;AAAA,IACL,4BAA4B;AAAA,EAChC;AAAA,EACA;AACJ;AAEA,IAAO,gBAAQ;",
+  "names": ["name", "path", "path"]
+}

package/package.json

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

package/.github/workflows/build.yaml

@@ -1,18 +0,0 @@
-name: Build
-on: [push]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    environment: Preview
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v3
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Build project
-        run: pnpm build

package/esbuild.config.js

@@ -1,20 +0,0 @@
-import esbuild from 'esbuild';
-import path, { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-await esbuild.build({
-	platform: 'node',
-	target: 'esnext',
-	format: 'esm',
-	entryPoints: ['./src/index.ts'],
-	outfile: './dist/index.js',
-	sourcemap: true,
-	minify: false,
-	bundle: true,
-	legalComments: 'external',
-	packages: 'external',
-	alias: { '~': path.resolve(__dirname, 'src') },
-});

package/src/index.ts

@@ -1,24 +0,0 @@
-import {enforceIndexUsageRule} from "./rules"
-
-const {name, version} =
-    // eslint-diable-next-line @typescript-eslint/no-require-imports
-    require("../package.json") as typeof import("../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;

package/src/rules/enforce-index-usage.test.ts

@@ -1,44 +0,0 @@
-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: [
-                    ]
-                }
-            ]
-        }
-    ]
-})

package/src/rules/enforce-index-usage.ts

@@ -1,47 +0,0 @@
-//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: []
-})

package/src/rules/index.ts

@@ -1,2 +0,0 @@
-export * from './enforce-index-usage.js'
-export * from './enforce-index-usage.test.js'

package/src/utils.ts

@@ -1,11 +0,0 @@
-import {ESLintUtils} from "@typescript-eslint/utils"
-
-export interface IndexFileDocs {
-    description: string;
-    recommended?: boolean;
-    requiresTypeChecking?: boolean;
-}
-
-export const createRule = ESLintUtils.RuleCreator<IndexFileDocs>(
-    (name) => `https://github.com/import-js/eslint-plugin-import/wiki/${name}`
-)

package/tsconfig.json

@@ -1,47 +0,0 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    "rootDir": ".",
-    	"outDir": "./dist",
-		"paths": {
-			"~/*": ["./src/*"]
-		},
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "moduleResolution": "bundler",
-    "module": "esnext",
-    "target": "esnext",
-    // For nodejs:
-    "lib": ["esnext"],
-    "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    "noImplicitReturns": true,
-    "noImplicitOverride": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "verbatimModuleSyntax": false,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-  },
-  "exclude": ["node_modules", "dist"]
-}