@elnop/eslint-plugin-store-layout 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,33 @@
-# Temporary Holding Version
+# @elnop/eslint-plugin-store-layout
 
-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 store file named `xStore` (any extension) exports `xStore` and, optionally, `xActions`, and nothing else. `viewStore.ts` may export `viewStore` and `viewActions`. Any other export is reported, and so is a missing `viewStore`.
+
+Written for zustand stores, but the rule only looks at file and export names.
+
+Works with oxlint and ESLint.
+
+```sh
+npm install --save-dev @elnop/eslint-plugin-store-layout
+```
+
+## oxlint
+
+```json
+{
+  "jsPlugins": ["@elnop/eslint-plugin-store-layout"],
+  "rules": { "store-layout/store-layout": "error" }
+}
+```
+
+## ESLint
+
+```js
+import storeLayout from '@elnop/eslint-plugin-store-layout';
+
+export default [
+  {
+    plugins: { 'store-layout': storeLayout },
+    rules: { 'store-layout/store-layout': '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";
+import { basename } from "node:path";
+// ../../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
+		}));
+	});
+}
+// storeLayout.ts
+const storeLayout = defineRule({
+	meta: {
+		type: "suggestion",
+		docs: { description: "A xStore.ts file exports only xStore and xActions." },
+		messages: {
+			foreignExport: "{{file}} only exports {{store}} and {{actions}}: move {{name}} out of it.",
+			missingStore: "{{file}} must export {{store}}."
+		},
+		schema: []
+	},
+	create(context) {
+		return { Program(program) {
+			const file = basename(context.filename);
+			const store = baseName(context.filename);
+			if (!store.endsWith("Store")) return;
+			const actions = store.replace(/Store$/, "Actions");
+			const entries = exportsOf(program);
+			for (const entry of entries) {
+				if (entry.name === store || entry.name === actions) continue;
+				context.report({
+					node: entry.node,
+					messageId: "foreignExport",
+					data: {
+						file,
+						store,
+						actions,
+						name: entry.name
+					}
+				});
+			}
+			if (!entries.some((entry) => entry.name === store)) context.report({
+				node: program,
+				messageId: "missingStore",
+				data: {
+					file,
+					store
+				}
+			});
+		} };
+	}
+});
+// plugin.ts
+var plugin_default = definePlugin({
+	meta: { name: "store-layout" },
+	rules: { "store-layout": storeLayout }
+});
+export { plugin_default as default };

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@elnop/eslint-plugin-store-layout",
-  "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: xStore.ts only exports xStore and xActions.",
+  "keywords": [
+    "oxlint",
+    "oxlint-plugin",
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "zustand",
+    "store"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/plugins/eslint-plugin-store-layout#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-store-layout"
+  },
+  "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"
+  }
+}