eslint-plugin-react-rsc 0.0.0 → 2.9.1-next.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rel1cx
+
+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,15 +1,45 @@
 # eslint-plugin-react-rsc
 
-To install dependencies:
+## Install
 
-```bash
-bun install
+```sh
+# npm
+npm install --save-dev eslint-plugin-react-rsc
 ```
 
-To run:
+## Setup
 
-```bash
-bun run index.ts
+```js
+// eslint.config.js
+
+// @ts-check
+import js from "@eslint/js";
+import react from "eslint-plugin-react-x";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+export default defineConfig(
+  {
+    files: ["**/*.{ts,tsx}"],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      react.configs.recommended,
+    ],
+    rules: {
+      // Put rules you want to override here
+      "react-rsc/function-definition": "error",
+    },
+  },
+);
 ```
 
-This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## Rules
+
+<Callout type="info">
+  RSC rules target [React Server Components](https://react.dev/reference/rsc/server-components), [React Server Functions](https://react.dev/reference/rsc/server-functions) and RSC [Directives](https://react.dev/reference/rsc/directives).
+</Callout>
+
+- [`function-definition`](https://eslint-react.xyz/docs/rules/rsc-function-definition) - Validate and transform React Client/Server Function definitions. (🔧 Fixable, 🧪 Experimental)
+
+<https://eslint-react.xyz/docs/rules/overview#rsc-rules>

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import * as _eslint_react_shared0 from "@eslint-react/shared";
+
+//#region src/index.d.ts
+declare const _default: {
+  configs: {
+    /**
+     * Disable experimental rules that might be subject to change in the future
+     */
+    "disable-experimental": {
+      plugins: {};
+      name?: string;
+      rules?: Record<string, _eslint_react_shared0.RuleConfig>;
+      settings?: _eslint_react_shared0.SettingsConfig;
+    };
+    /**
+     * Enforce rules that are recommended by ESLint React for general purpose React + React DOM projects
+     */
+    recommended: {
+      plugins: {};
+      name?: string;
+      rules?: Record<string, _eslint_react_shared0.RuleConfig>;
+      settings?: _eslint_react_shared0.SettingsConfig;
+    };
+    /**
+     * Same as the `recommended` preset but disables rules that can be enforced by TypeScript
+     */
+    "recommended-typescript": {
+      plugins: {};
+      name?: string;
+      rules?: Record<string, _eslint_react_shared0.RuleConfig>;
+      settings?: _eslint_react_shared0.SettingsConfig;
+    };
+    /**
+     * More strict version of the `recommended` preset
+     */
+    strict: {
+      plugins: {};
+      name?: string;
+      rules?: Record<string, _eslint_react_shared0.RuleConfig>;
+      settings?: _eslint_react_shared0.SettingsConfig;
+    };
+    /**
+     * Same as the `strict` preset but disables rules that can be enforced by TypeScript
+     */
+    "strict-typescript": {
+      plugins: {};
+      name?: string;
+      rules?: Record<string, _eslint_react_shared0.RuleConfig>;
+      settings?: _eslint_react_shared0.SettingsConfig;
+    };
+  };
+  meta: {
+    name: string;
+    version: string;
+  };
+  rules: Record<string, _eslint_react_shared0.CompatibleRule>;
+};
+//#endregion
+export { _default as default };

package/dist/index.js

@@ -0,0 +1,211 @@
+import { DEFAULT_ESLINT_REACT_SETTINGS, WEBSITE_URL, getConfigAdapters } from "@eslint-react/shared";
+import * as ast from "@eslint-react/ast";
+import { findVariable, getVariableDefinitionNode } from "@eslint-react/var";
+import { AST_NODE_TYPES } from "@typescript-eslint/types";
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+//#region src/configs/disable-experimental.ts
+var disable_experimental_exports = /* @__PURE__ */ __exportAll({
+	name: () => name$5,
+	rules: () => rules$4
+});
+const name$5 = "react-rsc/disable-experimental";
+const rules$4 = { "react-rsc/function-definition": "off" };
+
+//#endregion
+//#region package.json
+var name$4 = "eslint-plugin-react-rsc";
+var version = "2.9.1-next.0";
+
+//#endregion
+//#region src/utils/create-rule.ts
+function getDocsUrl(ruleName) {
+	return `${WEBSITE_URL}/docs/rules/${ruleName}`;
+}
+const createRule = ESLintUtils.RuleCreator(getDocsUrl);
+
+//#endregion
+//#region src/rules/function-definition.ts
+const RULE_NAME = "function-definition";
+var function_definition_default = createRule({
+	meta: {
+		type: "problem",
+		docs: { description: "Validate and transform React Client/Server Function definitions." },
+		fixable: "code",
+		messages: { default: "Server functions must be async." },
+		schema: []
+	},
+	name: RULE_NAME,
+	create,
+	defaultOptions: []
+});
+function create(context) {
+	if (!context.sourceCode.text.includes("use server")) return {};
+	const hasFileLevelUseServerDirective = ast.getFileDirectives(context.sourceCode.ast).some((d) => d.value === "use server");
+	/**
+	* Check if `node` is an async function, and report if not
+	* @param node The function node to check
+	* @returns Whether a report was made
+	*/
+	function getAsyncFix(node) {
+		if (node.type === AST_NODE_TYPES.FunctionDeclaration || node.type === AST_NODE_TYPES.FunctionExpression) {
+			const fnToken = context.sourceCode.getFirstToken(node);
+			if (fnToken != null) return (fixer) => fixer.insertTextBefore(fnToken, "async ");
+			return null;
+		}
+		if (node.type === AST_NODE_TYPES.ArrowFunctionExpression) return (fixer) => fixer.insertTextBefore(node, "async ");
+		return null;
+	}
+	function reportNonAsyncFunction(node) {
+		if (!ast.isFunction(node)) return false;
+		if (!node.async) {
+			context.report({
+				messageId: "default",
+				node,
+				fix: getAsyncFix(node)
+			});
+			return true;
+		}
+		return false;
+	}
+	/**
+	* Check non-exported local functions for 'use server' directives, and report if they are not async
+	* @param node The function node to check
+	*/
+	function checkLocalServerFunction(node) {
+		if (ast.getFunctionDirectives(node).some((d) => d.value === "use server")) reportNonAsyncFunction(node);
+	}
+	/**
+	* Find function declarations from exports and check them
+	* @param id The identifier of the exported function
+	* @param node The export declaration node
+	*/
+	function findAndCheckExportedFunctionDeclarations(id, node) {
+		const variableNode = getVariableDefinitionNode(findVariable(id.name, context.sourceCode.getScope(node)), 0);
+		if (variableNode == null) return;
+		reportNonAsyncFunction(variableNode);
+	}
+	return {
+		ArrowFunctionExpression(node) {
+			checkLocalServerFunction(node);
+		},
+		ExportDefaultDeclaration(node) {
+			if (!hasFileLevelUseServerDirective) return;
+			const decl = node.declaration;
+			if (reportNonAsyncFunction(decl)) return;
+			if (ast.isIdentifier(decl)) findAndCheckExportedFunctionDeclarations(decl, node);
+		},
+		ExportNamedDeclaration(node) {
+			if (!hasFileLevelUseServerDirective) return;
+			if (node.declaration != null) {
+				const decl = node.declaration;
+				if (reportNonAsyncFunction(decl)) return;
+				if (decl.type === AST_NODE_TYPES.VariableDeclaration) for (const declarator of decl.declarations) reportNonAsyncFunction(declarator.init);
+				return;
+			}
+			if (node.source == null && node.specifiers.length > 0) for (const spec of node.specifiers) findAndCheckExportedFunctionDeclarations(spec.local, node);
+		},
+		FunctionDeclaration(node) {
+			checkLocalServerFunction(node);
+		},
+		FunctionExpression(node) {
+			checkLocalServerFunction(node);
+		}
+	};
+}
+
+//#endregion
+//#region src/plugin.ts
+const plugin = {
+	meta: {
+		name: name$4,
+		version
+	},
+	rules: { "function-definition": function_definition_default }
+};
+
+//#endregion
+//#region src/configs/recommended.ts
+var recommended_exports = /* @__PURE__ */ __exportAll({
+	name: () => name$3,
+	plugins: () => plugins$3,
+	rules: () => rules$3,
+	settings: () => settings$3
+});
+const name$3 = "react-rsc/recommended";
+const rules$3 = { "react-rsc/function-definition": "error" };
+const plugins$3 = { "react-rsc": plugin };
+const settings$3 = { "react-rsc": DEFAULT_ESLINT_REACT_SETTINGS };
+
+//#endregion
+//#region src/configs/recommended-typescript.ts
+var recommended_typescript_exports = /* @__PURE__ */ __exportAll({
+	name: () => name$2,
+	plugins: () => plugins$2,
+	rules: () => rules$2,
+	settings: () => settings$2
+});
+const name$2 = "react-rsc/recommended-typescript";
+const rules$2 = { ...rules$3 };
+const plugins$2 = { ...plugins$3 };
+const settings$2 = { ...settings$3 };
+
+//#endregion
+//#region src/configs/strict.ts
+var strict_exports = /* @__PURE__ */ __exportAll({
+	name: () => name$1,
+	plugins: () => plugins$1,
+	rules: () => rules$1,
+	settings: () => settings$1
+});
+const name$1 = "react-rsc/strict";
+const rules$1 = { ...rules$3 };
+const plugins$1 = { ...plugins$3 };
+const settings$1 = { ...settings$3 };
+
+//#endregion
+//#region src/configs/strict-typescript.ts
+var strict_typescript_exports = /* @__PURE__ */ __exportAll({
+	name: () => name,
+	plugins: () => plugins,
+	rules: () => rules,
+	settings: () => settings
+});
+const name = "react-rsc/strict-typescript";
+const rules = { ...rules$1 };
+const plugins = { ...plugins$1 };
+const settings = { ...settings$1 };
+
+//#endregion
+//#region src/index.ts
+const { toFlatConfig } = getConfigAdapters("react-rsc", plugin);
+var src_default = {
+	...plugin,
+	configs: {
+		["disable-experimental"]: toFlatConfig(disable_experimental_exports),
+		["recommended"]: toFlatConfig(recommended_exports),
+		["recommended-typescript"]: toFlatConfig(recommended_typescript_exports),
+		["strict"]: toFlatConfig(strict_exports),
+		["strict-typescript"]: toFlatConfig(strict_typescript_exports)
+	}
+};
+
+//#endregion
+export { src_default as default };

package/package.json

@@ -1,12 +1,68 @@
 {
   "name": "eslint-plugin-react-rsc",
-  "version": "0.0.0",
-  "module": "index.ts",
+  "version": "2.9.1-next.0",
+  "description": "ESLint React's ESLint plugin for RSC related rules.",
+  "keywords": [
+    "react",
+    "eslint",
+    "eslint-react",
+    "eslint-plugin",
+    "eslint-plugin-react-rsc"
+  ],
+  "homepage": "https://github.com/Rel1cx/eslint-react",
+  "bugs": {
+    "url": "https://github.com/Rel1cx/eslint-react/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rel1cx/eslint-react.git",
+    "directory": "packages/plugins/eslint-plugin-react-rsc"
+  },
+  "license": "MIT",
+  "author": "Rel1cx",
+  "sideEffects": false,
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "./package.json"
+  ],
+  "dependencies": {
+    "@typescript-eslint/types": "^8.54.0",
+    "@typescript-eslint/utils": "^8.54.0",
+    "ts-pattern": "^5.9.0",
+    "@eslint-react/ast": "2.9.1-next.0",
+    "@eslint-react/shared": "2.9.1-next.0",
+    "@eslint-react/var": "2.9.1-next.0"
+  },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/react": "^19.2.10",
+    "@types/react-dom": "^19.2.3",
+    "tsdown": "^0.20.1",
+    "@local/configs": "0.0.0"
   },
   "peerDependencies": {
-    "typescript": "^5"
+    "eslint": "^8.57.0 || ^9.0.0",
+    "typescript": ">=4.8.4 <6.0.0"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint:publish": "publint",
+    "lint:ts": "tsc --noEmit"
   }
 }

package/bun.lock

@@ -1,26 +0,0 @@
-{
-  "lockfileVersion": 1,
-  "configVersion": 1,
-  "workspaces": {
-    "": {
-      "name": "eslint-plugin-react-rsc",
-      "devDependencies": {
-        "@types/bun": "latest",
-      },
-      "peerDependencies": {
-        "typescript": "^5",
-      },
-    },
-  },
-  "packages": {
-    "@types/bun": ["@types/bun@1.3.8", "", { "dependencies": { "bun-types": "1.3.8" } }, "sha512-3LvWJ2q5GerAXYxO2mffLTqOzEu5qnhEAlh48Vnu8WQfnmSwbgagjGZV6BoHKJztENYEDn6QmVd949W4uESRJA=="],
-
-    "@types/node": ["@types/node@25.2.0", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-DZ8VwRFUNzuqJ5khrvwMXHmvPe+zGayJhr2CDNiKB1WBE1ST8Djl00D0IC4vvNmHMdj6DlbYRIaFE7WHjlDl5w=="],
-
-    "bun-types": ["bun-types@1.3.8", "", { "dependencies": { "@types/node": "*" } }, "sha512-fL99nxdOWvV4LqjmC+8Q9kW3M4QTtTR1eePs94v5ctGqU8OeceWrSUaRw3JYb7tU3FkMIAjkueehrHPPPGKi5Q=="],
-
-    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
-
-    "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
-  }
-}

package/index.ts

@@ -1 +0,0 @@
-console.log("Hello via Bun!");

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}