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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progressive-victory/eslint-plugin-index-file",
-  "version": "0.0.3",
+  "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,

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"]
-}