@leonsilicon/eslint-plugin-filename-export 2.0.0

package/README.md

@@ -0,0 +1,67 @@
+[<img src="https://img.shields.io/npm/v/eslint-plugin-filename-export?label=%20&style=for-the-badge&logo=pnpm&logoColor=white">](https://www.npmjs.com/package/eslint-plugin-filename-export)
+<img src="https://img.shields.io/npm/dt/eslint-plugin-filename-export?style=for-the-badge&logo=npm&logoColor=white" >
+[<img src="https://img.shields.io/bundlephobia/minzip/eslint-plugin-filename-export?style=for-the-badge&logo=esbuild&logoColor=white">](https://bundlephobia.com/package/eslint-plugin-filename-export)
+
+# eslint-plugin-filename-export
+
+This plugin enforces that the filename matches to a named export or default export when a name is provided. This can be set to being case sensitive or case insensitive.
+
+## Installation
+
+Install with your package manager of choice:
+
+```bash
+pnpm i -D eslint-plugin-filename-export
+```
+
+Add to your ESLint config:
+
+```json
+{
+  "plugins": ["eslint-plugin-filename-export"],
+  "rules": {
+    "filename-export/match-named-export": "error",
+    "filename-export/match-default-export": "error"
+  }
+}
+```
+
+## Rules
+
+- `filename-export/match-named-export` - Enforces that the filename matches to a named export.
+- `filename-export/match-default-export` - Enforces that filenames match the name of the default export.
+
+These rules ignore index files, test/spec files, and files that have no relevant exports by default. Additionally, files with a default export will be ignored by the `match-named-export` rule.
+
+If you want to add additional filename exemptions, use the ESLint's builting filename overrides.
+
+## Options
+
+Both of these rules have the following available options:
+
+- `casing`:
+
+  - `strict`: Filenames much match in case to the exports
+  - `loose`: Filenames do not need to match case (`default`)
+
+- `stripextra`:
+  - `true`: Filenames will be stripped of any non-alphanumeric characters (to allow filenames like `great_function.ts` to match `greatfunction`)
+  - `false`: Filenames will not be stripped of any extra characters (`default`)
+
+These can be passed as a second item in an array to the rule as follows
+
+```json
+"filename-export/match-named-export": [
+  "error",
+  {
+    "casing": "strict",
+    "sripextra": true
+  }
+]
+```
+
+## Roadmap
+
+This plugin is mainly being produced for personal use. If you are interested in using it, but need additional features, please open an issue and I will consider adding them.
+
+Pull requests will also be evaluated and merged as appropriate.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { Options } from './types';
+declare const _default: {
+    rules: {
+        'match-named-export': ESLintUtils.RuleModule<"noMatchingExport", Options, unknown, ESLintUtils.RuleListener>;
+        'match-default-export': ESLintUtils.RuleModule<"defaultExportDoesNotMatch", Options, unknown, ESLintUtils.RuleListener>;
+    };
+};
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EAEZ,MAAM,0BAA0B,CAAC;AAIlC,OAAO,EAAsC,OAAO,EAAE,MAAM,SAAS,CAAC;;;;;;;AAyCtE,kBA6IE"}

package/dist/index.js

@@ -0,0 +1,200 @@
+"use strict";
+const utils_1 = require("@typescript-eslint/utils");
+const node_path_1 = require("node:path");
+const createRule = utils_1.ESLintUtils.RuleCreator(() => 'https://github.com/ekwoka/eslint-plugin-filename-export');
+/** Metro / React Native platform suffixes (e.g. `Foo.web.tsx` → `Foo`). */
+const PLATFORM_SUBEXTENSION = /\.(web|native|ios|android|windows|macos)$/;
+const filenameBaseName = (filename) => {
+    let name = (0, node_path_1.basename)(filename, (0, node_path_1.extname)(filename));
+    while (PLATFORM_SUBEXTENSION.test(name)) {
+        name = name.replace(PLATFORM_SUBEXTENSION, '');
+    }
+    return name;
+};
+/** Dot-separated filename parts after stripping the language extension (e.g. `static.db.d`). */
+const filenameSegments = (filename) => filenameBaseName(filename).split('.').filter(Boolean);
+/**
+ * Export names that may match a dotted filename such as `static.db.d.ts`:
+ * full basename, each segment (`db`), and progressive camelCase (`staticDb`, `staticDbD`, …).
+ */
+const filenameExportNameCandidates = (filename) => {
+    const base = filenameBaseName(filename);
+    const segments = filenameSegments(filename);
+    const candidates = new Set([base, ...segments]);
+    if (segments.length > 0) {
+        let camel = segments[0];
+        candidates.add(camel);
+        for (let i = 1; i < segments.length; i++) {
+            const segment = segments[i];
+            camel += segment.charAt(0).toUpperCase() + segment.slice(1);
+            candidates.add(camel);
+        }
+    }
+    return [...candidates];
+};
+const getName = (exported) => {
+    if ('name' in exported)
+        return exported.name;
+    if ('id' in exported && exported.id)
+        if ('name' in exported.id)
+            return exported.id.name;
+        else if ('value' in exported.id)
+            return exported.id.value;
+    return null;
+};
+const getExportedNames = (exported) => {
+    if (exported.declaration)
+        return getNamesFromDeclarations(exported.declaration);
+    if (exported.specifiers)
+        return getNamesFromSpecifiers(exported.specifiers);
+    return [];
+};
+const getNamesFromDeclarations = (declaration) => {
+    var _a;
+    if ('declarations' in declaration && declaration.declarations)
+        return declaration.declarations.map((declaration) => { var _a; return (_a = getName(declaration)) !== null && _a !== void 0 ? _a : ''; });
+    return [(_a = getName(declaration)) !== null && _a !== void 0 ? _a : ''];
+};
+const getNamesFromSpecifiers = (specifiers) => specifiers.map((specifier) => {
+    if ('name' in specifier.exported)
+        return specifier.exported.name;
+    return specifier.exported.value;
+});
+const transformName = (name, transformers) => transformers.reduce((acc, fn) => fn(acc), name);
+const compareExportToFilename = (exportName, filename, transformers) => {
+    const transformedExport = transformName(exportName, transformers);
+    return filenameExportNameCandidates(filename).some((candidate) => transformName(candidate, transformers) === transformedExport);
+};
+const makeTransformers = (options) => {
+    const transformers = [];
+    if (options.stripextra)
+        transformers.push((name) => name.replace(/[^a-zA-Z0-9]/g, ''));
+    if (options.casing !== 'strict')
+        transformers.push((name) => name.toLowerCase());
+    return transformers;
+};
+module.exports = {
+    rules: {
+        'match-named-export': createRule({
+            name: 'match-named-export',
+            defaultOptions: [
+                {
+                    stripextra: false,
+                    casing: 'loose',
+                },
+            ],
+            meta: {
+                docs: {
+                    description: 'Enforce filename matches named export',
+                },
+                messages: {
+                    noMatchingExport: 'Filename does not match any named exports',
+                },
+                type: 'suggestion',
+                schema: [
+                    {
+                        type: 'object',
+                        properties: {
+                            stripextra: {
+                                type: 'boolean',
+                            },
+                            casing: {
+                                enum: ['strict', 'loose'],
+                                type: 'string',
+                            },
+                        },
+                    },
+                ],
+            },
+            create(context) {
+                var _a;
+                const transformers = makeTransformers((_a = context.options[0]) !== null && _a !== void 0 ? _a : {});
+                return {
+                    Program(node) {
+                        const filename = context.getFilename();
+                        const filenameSansExt = filenameBaseName(filename);
+                        if (['index', 'types'].includes(filenameSansExt) ||
+                            /\.(test|spec|stories)$/.test(filenameSansExt))
+                            return;
+                        if (node.body.find((item) => item.type === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration))
+                            return;
+                        const namedExports = node.body.filter((item) => item.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration);
+                        if (!namedExports.length)
+                            return;
+                        const exportedNames = namedExports.flatMap((exp) => getExportedNames(exp));
+                        // Only enforce filename ↔ export name when the file has a single named export.
+                        if (exportedNames.length !== 1)
+                            return;
+                        const matchingExport = exportedNames.some((name) => compareExportToFilename(name, filename, transformers));
+                        if (!matchingExport)
+                            context.report({
+                                messageId: 'noMatchingExport',
+                                node,
+                            });
+                    },
+                };
+            },
+        }),
+        'match-default-export': createRule({
+            name: 'match-default-export',
+            defaultOptions: [
+                {
+                    stripextra: false,
+                    casing: 'loose',
+                },
+            ],
+            meta: {
+                docs: {
+                    description: 'Enforce filename matches named export',
+                },
+                messages: {
+                    defaultExportDoesNotMatch: 'Filename does not match the default export',
+                },
+                type: 'suggestion',
+                schema: [
+                    {
+                        type: 'object',
+                        properties: {
+                            stripextra: {
+                                type: 'boolean',
+                            },
+                            casing: {
+                                enum: ['strict', 'loose'],
+                                type: 'string',
+                            },
+                        },
+                    },
+                ],
+            },
+            create(context) {
+                var _a;
+                const transformers = makeTransformers((_a = context.options[0]) !== null && _a !== void 0 ? _a : {});
+                return {
+                    Program(node) {
+                        const filename = context.getFilename();
+                        const filenameSansExt = filenameBaseName(filename);
+                        if (['index', 'types'].includes(filenameSansExt) ||
+                            /\.(test|spec|stories)$/.test(filenameSansExt))
+                            return;
+                        const defaultExport = node.body.find((item) => item.type === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration);
+                        if (!defaultExport)
+                            return;
+                        const declaration = defaultExport.declaration;
+                        if (!('name' in declaration || 'id' in declaration))
+                            return;
+                        const defaultName = getName(declaration);
+                        if (!defaultName)
+                            return;
+                        const isMatching = compareExportToFilename(defaultName, filename, transformers);
+                        if (!isMatching)
+                            context.report({
+                                messageId: 'defaultExportDoesNotMatch',
+                                node,
+                            });
+                    },
+                };
+            },
+        }),
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":";AAAA,oDAIkC;AAElC,yCAA8C;AAI9C,MAAM,UAAU,GAAG,mBAAW,CAAC,WAAW,CACxC,GAAG,EAAE,CAAC,yDAAyD,CAChE,CAAC;AAEF,2EAA2E;AAC3E,MAAM,qBAAqB,GAAG,2CAA2C,CAAC;AAE1E,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC5C,IAAI,IAAI,GAAG,IAAA,oBAAQ,EAAC,QAAQ,EAAE,IAAA,mBAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;IACjD,OAAO,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,gGAAgG;AAChG,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE,CAC5C,gBAAgB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,4BAA4B,GAAG,CAAC,QAAgB,EAAE,EAAE;IACxD,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC;IACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxB,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC5B,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC5D,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC;AACzB,CAAC,CAAC;AAiJF,MAAM,OAAO,GAAG,CACd,QAAkE,EACnD,EAAE;IACjB,IAAI,MAAM,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC,IAAI,CAAC;IAC7C,IAAI,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,EAAE;QACjC,IAAI,MAAM,IAAI,QAAQ,CAAC,EAAE;YAAE,OAAO,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC;aAC9C,IAAI,OAAO,IAAI,QAAQ,CAAC,EAAE;YAAE,OAAO,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC;IAC5D,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAyC,EAAE,EAAE;IACrE,IAAI,QAAQ,CAAC,WAAW;QACtB,OAAO,wBAAwB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACxD,IAAI,QAAQ,CAAC,UAAU;QAAE,OAAO,sBAAsB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5E,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,WAA6C,EACnC,EAAE;;IACZ,IAAI,cAAc,IAAI,WAAW,IAAI,WAAW,CAAC,YAAY;QAC3D,OAAO,WAAW,CAAC,YAAY,CAAC,GAAG,CACjC,CAAC,WAAW,EAAE,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,WAAW,CAAC,mCAAI,EAAE,CAAA,EAAA,CAC5C,CAAC;IACJ,OAAO,CAAC,MAAA,OAAO,CAAC,WAAW,CAAC,mCAAI,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC7B,UAAsC,EAC5B,EAAE,CACZ,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;IAC3B,IAAI,MAAM,IAAI,SAAS,CAAC,QAAQ;QAAE,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjE,OAAO,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;AAClC,CAAC,CAAC,CAAC;AAEL,MAAM,aAAa,GAAG,CACpB,IAAY,EACZ,YAA0C,EAC1C,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AAErD,MAAM,uBAAuB,GAAG,CAC9B,UAAkB,EAClB,QAAgB,EAChB,YAA0C,EAC1C,EAAE;IACF,MAAM,iBAAiB,GAAG,aAAa,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAClE,OAAO,4BAA4B,CAAC,QAAQ,CAAC,CAAC,IAAI,CAChD,CAAC,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC,KAAK,iBAAiB,CAC5E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,OAAmB,EAAE,EAAE;IAC/C,MAAM,YAAY,GAAiC,EAAE,CAAC;IACtD,IAAI,OAAO,CAAC,UAAU;QACpB,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ;QAC7B,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAClD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAzMF,iBAAS;IACP,KAAK,EAAE;QACL,oBAAoB,EAAE,UAAU,CAA2B;YACzD,IAAI,EAAE,oBAAoB;YAC1B,cAAc,EAAE;gBACd;oBACE,UAAU,EAAE,KAAK;oBACjB,MAAM,EAAE,OAAO;iBAChB;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,WAAW,EAAE,uCAAuC;iBACrD;gBACD,QAAQ,EAAE;oBACR,gBAAgB,EAAE,2CAA2C;iBAC9D;gBACD,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,UAAU,EAAE;gCACV,IAAI,EAAE,SAAS;6BAChB;4BACD,MAAM,EAAE;gCACN,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;gCACzB,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;iBACF;aACF;YACD,MAAM,CAAC,OAAO;;gBACZ,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC;gBAChE,OAAO;oBACL,OAAO,CAAC,IAAI;wBACV,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;wBACvC,MAAM,eAAe,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;wBACnD,IACE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;4BAC5C,wBAAwB,CAAC,IAAI,CAAC,eAAe,CAAC;4BAE9C,OAAO;wBACT,IACE,IAAI,CAAC,IAAI,CAAC,IAAI,CACZ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,wBAAwB,CAChE;4BAED,OAAO;wBACT,MAAM,YAAY,GAChB,IAAI,CAAC,IAAI,CAAC,MAAM,CACd,CAAC,IAAI,EAA2C,EAAE,CAChD,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,sBAAsB,CACtD,CAAC;wBACJ,IAAI,CAAC,YAAY,CAAC,MAAM;4BAAE,OAAO;wBACjC,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACjD,gBAAgB,CAAC,GAAG,CAAC,CACtB,CAAC;wBACF,+EAA+E;wBAC/E,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;4BAAE,OAAO;wBACvC,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACjD,uBAAuB,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,CACtD,CAAC;wBACF,IAAI,CAAC,cAAc;4BACjB,OAAO,CAAC,MAAM,CAAC;gCACb,SAAS,EAAE,kBAAkB;gCAC7B,IAAI;6BACL,CAAC,CAAC;oBACP,CAAC;iBACF,CAAC;YACJ,CAAC;SACF,CAAC;QACF,sBAAsB,EAAE,UAAU,CAA6B;YAC7D,IAAI,EAAE,sBAAsB;YAC5B,cAAc,EAAE;gBACd;oBACE,UAAU,EAAE,KAAK;oBACjB,MAAM,EAAE,OAAO;iBAChB;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,WAAW,EAAE,uCAAuC;iBACrD;gBACD,QAAQ,EAAE;oBACR,yBAAyB,EACvB,4CAA4C;iBAC/C;gBACD,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,UAAU,EAAE;gCACV,IAAI,EAAE,SAAS;6BAChB;4BACD,MAAM,EAAE;gCACN,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;gCACzB,IAAI,EAAE,QAAQ;6BACf;yBACF;qBACF;iBACF;aACF;YACD,MAAM,CAAC,OAAO;;gBACZ,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAA,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC;gBAChE,OAAO;oBACL,OAAO,CAAC,IAAI;wBACV,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;wBACvC,MAAM,eAAe,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;wBACnD,IACE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;4BAC5C,wBAAwB,CAAC,IAAI,CAAC,eAAe,CAAC;4BAE9C,OAAO;wBAET,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAClC,CAAC,IAAI,EAA6C,EAAE,CAClD,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,wBAAwB,CACxD,CAAC;wBACF,IAAI,CAAC,aAAa;4BAAE,OAAO;wBAC3B,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;wBAC9C,IAAI,CAAC,CAAC,MAAM,IAAI,WAAW,IAAI,IAAI,IAAI,WAAW,CAAC;4BAAE,OAAO;wBAC5D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;wBACzC,IAAI,CAAC,WAAW;4BAAE,OAAO;wBACzB,MAAM,UAAU,GAAG,uBAAuB,CACxC,WAAW,EACX,QAAQ,EACR,YAAY,CACb,CAAC;wBACF,IAAI,CAAC,UAAU;4BACb,OAAO,CAAC,MAAM,CAAC;gCACb,SAAS,EAAE,2BAA2B;gCACtC,IAAI;6BACL,CAAC,CAAC;oBACP,CAAC;iBACF,CAAC;YACJ,CAAC;SACF,CAAC;KACH;CACF,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+export type NamedMessageIds = 'noMatchingExport';
+export type DefaultMessageIds = 'defaultExportDoesNotMatch';
+export type Options = [
+    {
+        stripextra?: boolean;
+        casing?: 'strict' | 'loose';
+    }
+];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"src/","sources":["types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAC;AACjD,MAAM,MAAM,iBAAiB,GAAG,2BAA2B,CAAC;AAC5D,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,MAAM,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;KAC7B;CACF,CAAC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"src/","sources":["types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@leonsilicon/eslint-plugin-filename-export",
+  "version": "2.0.0",
+  "description": "ESLint plugin that ensures non-index filenames match to at least one named export.",
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc",
+    "coverage": "vitest run --coverage",
+    "lint": "eslint --fix ./src; prettier --write ./src --loglevel error",
+    "lint:check": "eslint --max-warnings 10 ./src && prettier --check ./src",
+    "prebuild": "rm -rf dist",
+    "prepare": "husky install",
+    "size": "node scripts/esbuild.js",
+    "test": "vitest",
+    "test:run": "vitest --run",
+    "test:verbose": "vitest --reporter=verbose"
+  },
+  "keywords": [
+    "ESLint",
+    "esm",
+    "export",
+    "filename"
+  ],
+  "author": {
+    "name": "Eric Kwoka",
+    "email": "ninjatheory@gmail.com",
+    "url": "https://thekwoka.net/"
+  },
+  "license": "MIT",
+  "repository": "github:ekwoka/eslint-plugin-filename-export",
+  "bugs": {
+    "url": "https://github.com/ekwoka/eslint-plugin-filename-export/issues"
+  },
+  "homepage": "https://github.com/ekwoka/eslint-plugin-filename-export",
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.38.0"
+  },
+  "peerDependencies": {
+    "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "4.3.0",
+    "@types/node": "20.19.39",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
+    "@typescript-eslint/rule-tester": "8.59.1",
+    "@vitest/coverage-c8": "0.33.0",
+    "esbuild": "0.28.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-filename-export": "1.0.4",
+    "husky": "8.0.3",
+    "lint-staged": "14.0.1",
+    "prettier": "3.8.3",
+    "typescript": "5.9.3",
+    "vite": "4.5.14",
+    "vite-tsconfig-paths": "4.3.2",
+    "vitest": "0.34.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "bracketSameLine": true,
+    "plugins": [
+      "@trivago/prettier-plugin-sort-imports"
+    ],
+    "importOrder": [
+      "node:.*",
+      "@/lib(.*)$",
+      "@/utils(.*)$",
+      "^[./]"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true
+  },
+  "lint-staged": {
+    "*.{js,ts,mjs}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.json": [
+      "prettier --write"
+    ]
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ]
+  },
+  "packageManager": "pnpm@11.5.3"
+}

package/src/index.ts

@@ -0,0 +1,251 @@
+import {
+  AST_NODE_TYPES,
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
+
+import { basename, extname } from 'node:path';
+
+import { DefaultMessageIds, NamedMessageIds, Options } from './types';
+
+const createRule = ESLintUtils.RuleCreator(
+  () => 'https://github.com/ekwoka/eslint-plugin-filename-export',
+);
+
+/** Metro / React Native platform suffixes (e.g. `Foo.web.tsx` → `Foo`). */
+const PLATFORM_SUBEXTENSION = /\.(web|native|ios|android|windows|macos)$/;
+
+const filenameBaseName = (filename: string) => {
+  let name = basename(filename, extname(filename));
+  while (PLATFORM_SUBEXTENSION.test(name)) {
+    name = name.replace(PLATFORM_SUBEXTENSION, '');
+  }
+  return name;
+};
+
+/** Dot-separated filename parts after stripping the language extension (e.g. `static.db.d`). */
+const filenameSegments = (filename: string) =>
+  filenameBaseName(filename).split('.').filter(Boolean);
+
+/**
+ * Export names that may match a dotted filename such as `static.db.d.ts`:
+ * full basename, each segment (`db`), and progressive camelCase (`staticDb`, `staticDbD`, …).
+ */
+const filenameExportNameCandidates = (filename: string) => {
+  const base = filenameBaseName(filename);
+  const segments = filenameSegments(filename);
+  const candidates = new Set<string>([base, ...segments]);
+  if (segments.length > 0) {
+    let camel = segments[0];
+    candidates.add(camel);
+    for (let i = 1; i < segments.length; i++) {
+      const segment = segments[i];
+      camel += segment.charAt(0).toUpperCase() + segment.slice(1);
+      candidates.add(camel);
+    }
+  }
+  return [...candidates];
+};
+
+export = {
+  rules: {
+    'match-named-export': createRule<Options, NamedMessageIds>({
+      name: 'match-named-export',
+      defaultOptions: [
+        {
+          stripextra: false,
+          casing: 'loose',
+        },
+      ],
+      meta: {
+        docs: {
+          description: 'Enforce filename matches named export',
+        },
+        messages: {
+          noMatchingExport: 'Filename does not match any named exports',
+        },
+        type: 'suggestion',
+        schema: [
+          {
+            type: 'object',
+            properties: {
+              stripextra: {
+                type: 'boolean',
+              },
+              casing: {
+                enum: ['strict', 'loose'],
+                type: 'string',
+              },
+            },
+          },
+        ],
+      },
+      create(context) {
+        const transformers = makeTransformers(context.options[0] ?? {});
+        return {
+          Program(node) {
+            const filename = context.getFilename();
+            const filenameSansExt = filenameBaseName(filename);
+            if (
+              ['index', 'types'].includes(filenameSansExt) ||
+              /\.(test|spec|stories)$/.test(filenameSansExt)
+            )
+              return;
+            if (
+              node.body.find(
+                (item) => item.type === AST_NODE_TYPES.ExportDefaultDeclaration,
+              )
+            )
+              return;
+            const namedExports =
+              node.body.filter<TSESTree.ExportNamedDeclaration>(
+                (item): item is TSESTree.ExportNamedDeclaration =>
+                  item.type === AST_NODE_TYPES.ExportNamedDeclaration,
+              );
+            if (!namedExports.length) return;
+            const exportedNames = namedExports.flatMap((exp) =>
+              getExportedNames(exp),
+            );
+            // Only enforce filename ↔ export name when the file has a single named export.
+            if (exportedNames.length !== 1) return;
+            const matchingExport = exportedNames.some((name) =>
+              compareExportToFilename(name, filename, transformers),
+            );
+            if (!matchingExport)
+              context.report({
+                messageId: 'noMatchingExport',
+                node,
+              });
+          },
+        };
+      },
+    }),
+    'match-default-export': createRule<Options, DefaultMessageIds>({
+      name: 'match-default-export',
+      defaultOptions: [
+        {
+          stripextra: false,
+          casing: 'loose',
+        },
+      ],
+      meta: {
+        docs: {
+          description: 'Enforce filename matches named export',
+        },
+        messages: {
+          defaultExportDoesNotMatch:
+            'Filename does not match the default export',
+        },
+        type: 'suggestion',
+        schema: [
+          {
+            type: 'object',
+            properties: {
+              stripextra: {
+                type: 'boolean',
+              },
+              casing: {
+                enum: ['strict', 'loose'],
+                type: 'string',
+              },
+            },
+          },
+        ],
+      },
+      create(context) {
+        const transformers = makeTransformers(context.options[0] ?? {});
+        return {
+          Program(node) {
+            const filename = context.getFilename();
+            const filenameSansExt = filenameBaseName(filename);
+            if (
+              ['index', 'types'].includes(filenameSansExt) ||
+              /\.(test|spec|stories)$/.test(filenameSansExt)
+            )
+              return;
+
+            const defaultExport = node.body.find(
+              (item): item is TSESTree.ExportDefaultDeclaration =>
+                item.type === AST_NODE_TYPES.ExportDefaultDeclaration,
+            );
+            if (!defaultExport) return;
+            const declaration = defaultExport.declaration;
+            if (!('name' in declaration || 'id' in declaration)) return;
+            const defaultName = getName(declaration);
+            if (!defaultName) return;
+            const isMatching = compareExportToFilename(
+              defaultName,
+              filename,
+              transformers,
+            );
+            if (!isMatching)
+              context.report({
+                messageId: 'defaultExportDoesNotMatch',
+                node,
+              });
+          },
+        };
+      },
+    }),
+  },
+};
+
+const getName = (
+  exported: TSESTree.ExportDeclaration | TSESTree.VariableDeclarator,
+): string | null => {
+  if ('name' in exported) return exported.name;
+  if ('id' in exported && exported.id)
+    if ('name' in exported.id) return exported.id.name;
+    else if ('value' in exported.id) return exported.id.value;
+  return null;
+};
+
+const getExportedNames = (exported: TSESTree.ExportNamedDeclaration) => {
+  if (exported.declaration)
+    return getNamesFromDeclarations(exported.declaration);
+  if (exported.specifiers) return getNamesFromSpecifiers(exported.specifiers);
+  return [];
+};
+
+const getNamesFromDeclarations = (
+  declaration: TSESTree.NamedExportDeclarations,
+): string[] => {
+  if ('declarations' in declaration && declaration.declarations)
+    return declaration.declarations.map(
+      (declaration) => getName(declaration) ?? '',
+    );
+  return [getName(declaration) ?? ''];
+};
+
+const getNamesFromSpecifiers = (
+  specifiers: TSESTree.ExportSpecifier[],
+): string[] =>
+  specifiers.map((specifier) => {
+    if ('name' in specifier.exported) return specifier.exported.name;
+    return specifier.exported.value;
+  });
+
+const transformName = (
+  name: string,
+  transformers: ((name: string) => string)[],
+) => transformers.reduce((acc, fn) => fn(acc), name);
+
+const compareExportToFilename = (
+  exportName: string,
+  filename: string,
+  transformers: ((name: string) => string)[],
+) => {
+  const transformedExport = transformName(exportName, transformers);
+  return filenameExportNameCandidates(filename).some(
+    (candidate) => transformName(candidate, transformers) === transformedExport,
+  );
+};
+
+const makeTransformers = (options: Options[0]) => {
+  const transformers: ((name: string) => string)[] = [];
+  if (options.stripextra)
+    transformers.push((name) => name.replace(/[^a-zA-Z0-9]/g, ''));
+  if (options.casing !== 'strict')
+    transformers.push((name) => name.toLowerCase());
+  return transformers;
+};

package/src/types.ts

@@ -0,0 +1,8 @@
+export type NamedMessageIds = 'noMatchingExport';
+export type DefaultMessageIds = 'defaultExportDoesNotMatch';
+export type Options = [
+  {
+    stripextra?: boolean;
+    casing?: 'strict' | 'loose';
+  },
+];