@elnop/eslint-plugin-file-named-after-export 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elnop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @elnop/eslint-plugin-file-named-after-export
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A file with a single named export is named after that export. `formatPrice.ts` exporting only `price` is reported: rename the file to `price.ts`, or the export to `formatPrice`.
+
+Files whose name ends with one of `exemptSuffixes` are skipped. The default is `['Types', 'Config', 'Content']`, for files that group several types or constants.
+
+Works with oxlint and ESLint.
+
+```sh
+npm install --save-dev @elnop/eslint-plugin-file-named-after-export
+```
+
+## oxlint
+
+```json
+{
+  "jsPlugins": ["@elnop/eslint-plugin-file-named-after-export"],
+  "rules": {
+    "file-named-after-export/file-named-after-export": ["error", { "exemptSuffixes": ["Types", "Config"] }]
+  }
+}
+```
+
+## ESLint
+
+```js
+import fileNamedAfterExport from '@elnop/eslint-plugin-file-named-after-export';
+
+export default [
+  {
+    plugins: { 'file-named-after-export': fileNamedAfterExport },
+    rules: { 'file-named-after-export/file-named-after-export': 'error' },
+  },
+];
+```

package/dist/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@oxlint/plugins").Plugin;
+export { _default as default };

package/dist/plugin.js

@@ -0,0 +1,68 @@
+import { definePlugin, defineRule } from "@oxlint/plugins";
+// ../../utils/lint-utils/dist/baseName.js
+function baseName(filename) {
+	return (filename.split("/").pop() ?? "").replace(/\.[^.]+$/, "");
+}
+// ../../utils/lint-utils/dist/exportsOf.js
+function declaredNames(declaration) {
+	if (declaration.type === "VariableDeclaration") return declaration.declarations.flatMap((declarator) => declarator.id.type === "Identifier" ? [declarator.id.name] : []);
+	return "id" in declaration && declaration.id && "name" in declaration.id ? [declaration.id.name] : [];
+}
+function exportsOf(program) {
+	return program.body.flatMap((node) => {
+		if (node.type !== "ExportNamedDeclaration") return [];
+		return (node.declaration ? declaredNames(node.declaration) : node.specifiers.map((specifier) => specifier.exported.type === "Identifier" ? specifier.exported.name : specifier.exported.value)).map((name) => ({
+			name,
+			node
+		}));
+	});
+}
+// fileNamedAfterExport.ts
+function stringsAt(options, key) {
+	if (typeof options !== "object" || options === null || !(key in options)) return [];
+	const value = Reflect.get(options, key);
+	return Array.isArray(value) ? value.filter((item) => typeof item === "string") : [];
+}
+const fileNamedAfterExport = defineRule({
+	meta: {
+		type: "suggestion",
+		docs: { description: "Name a file with a single export after that export." },
+		messages: { renameFile: "A file with a single export is named after it: rename {{file}} to {{name}}." },
+		defaultOptions: [{ exemptSuffixes: [
+			"Types",
+			"Config",
+			"Content"
+		] }],
+		schema: [{
+			type: "object",
+			properties: { exemptSuffixes: {
+				type: "array",
+				items: { type: "string" }
+			} },
+			additionalProperties: false
+		}]
+	},
+	create(context) {
+		return { Program(program) {
+			const exemptSuffixes = stringsAt(context.options[0], "exemptSuffixes");
+			const file = baseName(context.filename);
+			const entries = exportsOf(program);
+			const [only] = entries;
+			if (entries.length !== 1 || !only || exemptSuffixes.some((suffix) => file.endsWith(suffix)) || only.name === file) return;
+			context.report({
+				node: only.node,
+				messageId: "renameFile",
+				data: {
+					file,
+					name: only.name
+				}
+			});
+		} };
+	}
+});
+// plugin.ts
+var plugin_default = definePlugin({
+	meta: { name: "file-named-after-export" },
+	rules: { "file-named-after-export": fileNamedAfterExport }
+});
+export { plugin_default as default };

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "@elnop/eslint-plugin-file-named-after-export",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Lint rule for oxlint and ESLint: a file with a single export is named after it.",
+  "keywords": [
+    "oxlint",
+    "oxlint-plugin",
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "filename"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/plugins/eslint-plugin-file-named-after-export#readme",
+  "bugs": "https://github.com/Elnop/eslint-plugins/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elnop/eslint-plugins.git",
+    "directory": "packages/plugins/eslint-plugin-file-named-after-export"
+  },
+  "license": "MIT",
+  "author": "elnop",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": "./dist/plugin.js",
+  "scripts": {
+    "build": "tsdown",
+    "test": "node --test '**/*.test.ts'"
+  },
+  "dependencies": {
+    "@oxlint/plugins": "^1.91.0"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.91.0"
+  },
+  "devDependencies": {
+    "@elnop/lint-utils": "^0.1.0",
+    "oxlint": "^1.91.0"
+  }
+}