eslint-plugin-require-use-server 0.0.0-stage → 1.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: pnpm/action-setup@v6
+        with:
+          version: 12
+
+      - uses: actions/setup-node@v7
+        with:
+          node-version: '24.21.0'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build
+      - run: pnpm publish  # Or: npm stage publish

package/.nvmrc

@@ -0,0 +1 @@
+v24.21.0

package/.prettierrc

@@ -0,0 +1,19 @@
+{
+    "plugins": ["@trivago/prettier-plugin-sort-imports", "prettier-plugin-tailwindcss"],
+    "singleQuote": true,
+    "tabWidth": 4,
+    "useTabs": true,
+    "arrowParens": "avoid",
+    "jsxSingleQuote": false,
+    "experimentalTernaries": true,
+    "bracketSpacing": true,
+    "insertPragma": false,
+    "requirePragma": false,
+    "trailingComma": "all",
+    "semi": true,
+    "printWidth": 120,
+    "importOrder": ["^[./]"],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true,
+    "importOrderSortByLength": "asc"
+}

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# eslint-plugin-use-server-top-level
+
+Custom ESLint rule to ensure specified files start with `use server`.
+
+## Features
+- Checks if the first code line of matched files is `'use server'` or `"use server"`.
+- Skips leading comments and empty lines.
+- Path matching is configurable via the `pathPattern` option.
+
+## Requirements
+- ESLint 9 or 10 (flat config)
+- Node.js `^20.19.0 || ^22.13.0 || >=24`
+
+## Installation
+
+```bash
+npm install eslint-plugin-require-use-server --save-dev
+```
+
+## Usage
+
+1. Import the plugin in your ESLint config (e.g. `eslint.config.mjs`):
+
+```js
+import useServerPlugin from '@leo-tools/eslint-plugin-use-server-top-level';
+
+export default [
+  {
+    plugins: {
+      'use-server': useServerPlugin,
+    },
+    rules: {
+      // Configure the rule and specify the path pattern
+      'use-server/require-use-server': ['error', { pathPattern: 'src/services/actions/.*\\.ts$' }],
+    },
+  },
+];
+```
+
+2. Run ESLint on your target files:
+
+```bash
+eslint
+```
+
+## Options
+- `pathPattern` (string): Regex pattern to match file paths. Only matched files will be checked.
+
+## Example
+If a file at `src/services/actions/foo.ts` does not start with `use server`, ESLint will report an error:
+
+```
+Error: servers/actions/*.ts must start with 'use server'
+```
+
+## License
+MIT
 
-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.

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "eslint-plugin-require-use-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "",
+  "license": "ISC",
+  "author": "KLewin23",
+  "type": "commonjs",
+  "main": "index.js",
+  "repository": {
+    "url": "https://github.com/KLewin23/eslint-plugin-require-use-server"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^6.0.2",
+    "@types/eslint": "^9.6.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^10.12.0",
+    "prettier": "^3.9.10",
+    "typescript": "^7.0.2"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "commit": "cz"
+  }
 }

package/src/index.ts

@@ -0,0 +1,13 @@
+import requireUseServer from "./require-use-server";
+
+const plugin = {
+  meta: {
+    name: "require-use-server",
+    version: "1.0.0"
+  },
+  rules: {
+    "require-use-server": requireUseServer,
+  },
+};
+
+export default plugin

package/src/require-use-server.ts

@@ -0,0 +1,47 @@
+import { Rule } from 'eslint';
+
+const rule: Rule.RuleModule = {
+	meta: {
+		type: 'problem',
+		docs: {
+			description: "Require 'use server' at the top of the file",
+		},
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					pathPattern: { type: 'string' },
+				},
+				additionalProperties: false,
+			},
+		],
+		defaultOptions: [{ pathPattern: 'src/.*\\.ts$' }],
+		messages: {
+			missingUseServer: "{{filename}} must start with 'use server'",
+		},
+	},
+	create: context => {
+		const options = context.options[0] || {};
+		const pathPattern = options.pathPattern || 'src/.*\\.ts$';
+		const filename = context.filename;
+		if (!new RegExp(pathPattern).test(filename)) return {};
+
+		return {
+			Program(node) {
+				const sourceCode = context.sourceCode;
+				const lines = sourceCode.getText().split(/\r?\n/);
+				const firstLine = lines[0] ?? '';
+
+				if (!firstLine.startsWith("'use server'")) {
+					context.report({
+						node,
+						messageId: 'missingUseServer',
+						data: { filename },
+					});
+				}
+			},
+		};
+	},
+};
+
+export = rule;

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+        "target": "es2025",
+        "module": "nodenext",
+        "declaration": true,
+        "outDir": "./dist",
+        "rootDir": "./src",
+        "strict": true,
+        "moduleResolution": "node16",
+        "esModuleInterop": true
+    }
+}