@elnop/oxlint-config-zustand 0.0.0-stage → 0.1.0

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,19 @@
-# Temporary Holding Version
+# @elnop/oxlint-config-zustand
 
-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.
+Oxlint config for zustand stores. It extends [@elnop/oxlint-config-typescript](https://www.npmjs.com/package/@elnop/oxlint-config-typescript) and turns on [@elnop/eslint-plugin-store-layout](https://www.npmjs.com/package/@elnop/eslint-plugin-store-layout): `viewStore.ts` only exports `viewStore` and `viewActions`.
+
+In `*Store.ts` files, the base config's placement rule only refuses exported types, since a store exports the result of `create(...)`, and the file naming rule is off, since `store-layout` already checks the names.
+
+```sh
+npm install --save-dev oxlint @elnop/oxlint-config-zustand
+```
+
+```ts
+import { reactConfig } from '@elnop/oxlint-config-react';
+import { zustandConfig } from '@elnop/oxlint-config-zustand';
+import { defineConfig } from 'oxlint';
+
+export default defineConfig({
+  extends: [reactConfig, zustandConfig],
+});
+```

package/dist/ZustandConfig.d.ts

@@ -0,0 +1,91 @@
+export declare const zustandConfig: {
+    extends: {
+        plugins: ("import" | "oxc" | "typescript" | "unicorn")[];
+        jsPlugins: {
+            name: string;
+            specifier: string;
+        }[];
+        categories: {
+            correctness: "error";
+            suspicious: "error";
+        };
+        env: {
+            es2024: true;
+        };
+        rules: {
+            'import/no-cycle': "error";
+            'import/no-self-import': "error";
+            'import/no-duplicates': "error";
+            'typescript/no-floating-promises': "error";
+            'typescript/no-misused-promises': "error";
+            'typescript/await-thenable': "error";
+            'typescript/no-unnecessary-type-assertion': "error";
+            'typescript/consistent-type-imports': "error";
+            'typescript/no-explicit-any': "error";
+            'no-shadow': "off";
+            'unicorn/consistent-function-scoping': "off";
+            'typescript/consistent-return': "off";
+            'oxc/no-barrel-file': ["error", {
+                threshold: number;
+            }];
+            'unicorn/filename-case': ["error", {
+                cases: {
+                    camelCase: boolean;
+                    pascalCase: boolean;
+                };
+            }];
+            'no-comments/disallowComments': ["error", {
+                allow: ("/ <reference " | "/usr/bin/env " | "@ts-expect-error" | "@ts-ignore" | "@ts-nocheck" | "eslint-" | "oxlint-")[];
+            }];
+            'check-file/no-index': ["error", {
+                errorMessage: "Barrel files ({{ target }}) are not allowed: import each module by its own path";
+            }];
+            'check-file/filename-blocklist': ["error", {
+                '**/types.ts': "*Types.ts";
+            }];
+            'file-named-after-export/file-named-after-export': "error";
+        };
+        overrides: ({
+            files: string[];
+            rules: {
+                'export-placement/no-restricted-syntax': ["error", ...{
+                    selector: string;
+                    message: string;
+                }[]];
+                'typescript/no-floating-promises'?: undefined;
+                'file-named-after-export/file-named-after-export'?: undefined;
+            };
+        } | {
+            files: string[];
+            rules: {
+                'typescript/no-floating-promises': "off";
+                'export-placement/no-restricted-syntax'?: undefined;
+                'file-named-after-export/file-named-after-export'?: undefined;
+            };
+        } | {
+            files: string[];
+            rules: {
+                'typescript/no-floating-promises'?: undefined;
+                'export-placement/no-restricted-syntax': "off";
+                'file-named-after-export/file-named-after-export': "off";
+            };
+        })[];
+    }[];
+    jsPlugins: {
+        name: string;
+        specifier: string;
+    }[];
+    rules: {
+        'store-layout/store-layout': "error";
+    };
+    overrides: {
+        files: string[];
+        rules: {
+            'file-named-after-export/file-named-after-export': "off";
+            'export-placement/no-restricted-syntax': ["error", {
+                selector: "ExportNamedDeclaration > :matches(TSTypeAliasDeclaration, TSInterfaceDeclaration)";
+                message: "Exported types belong in an XTypes.ts file (types/ folder).";
+            }];
+        };
+    }[];
+};

package/dist/ZustandConfig.js

@@ -0,0 +1,21 @@
+import { typescriptConfig } from '@elnop/oxlint-config-typescript';
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from 'oxlint';
+const resolveFromHere = (specifier) => fileURLToPath(import.meta.resolve(specifier));
+export const zustandConfig = defineConfig({
+    extends: [typescriptConfig],
+    jsPlugins: [{ name: 'store-layout', specifier: resolveFromHere('@elnop/eslint-plugin-store-layout') }],
+    rules: { 'store-layout/store-layout': 'error' },
+    overrides: [
+        {
+            files: ['**/*Store.ts'],
+            rules: {
+                'file-named-after-export/file-named-after-export': 'off',
+                'export-placement/no-restricted-syntax': [
+                    'error',
+                    { selector: 'ExportNamedDeclaration > :matches(TSTypeAliasDeclaration, TSInterfaceDeclaration)', message: 'Exported types belong in an XTypes.ts file (types/ folder).' },
+                ],
+            },
+        },
+    ],
+});

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "@elnop/oxlint-config-zustand",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Oxlint config for zustand stores: xStore.ts only exports xStore and xActions.",
+  "keywords": [
+    "oxlint",
+    "oxlint-config",
+    "zustand",
+    "lint"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/configs/oxlint-config-zustand#readme",
+  "bugs": "https://github.com/Elnop/eslint-plugins/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elnop/eslint-plugins.git",
+    "directory": "packages/configs/oxlint-config-zustand"
+  },
+  "license": "MIT",
+  "author": "elnop",
+  "type": "module",
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "exports": "./dist/ZustandConfig.js",
+  "scripts": {
+    "test": "node --test '**/*.test.ts'"
+  },
+  "dependencies": {
+    "@elnop/eslint-plugin-store-layout": "^0.1.0",
+    "@elnop/oxlint-config-typescript": "^0.1.0"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.91.0"
+  },
+  "devDependencies": {
+    "@elnop/lint-utils": "^0.1.0",
+    "oxlint": "^1.91.0"
+  }
+}