ci: add update:readme npm script, closes #509

Author: Rel1cx

package.json

@@ -52,6 +52,7 @@
     "prepare": "husky install && pnpm run build",
     "test": "vitest --run --logHeapUsage",
     "update:deps": "taze",
+    "update:readme": "bun run --bun ./scripts/update-readme.ts",
     "update:version": "bun run --bun ./scripts/update-version.ts && pnpm run format:package-json"
   },
   "devDependencies": {

packages/plugins/eslint-plugin/README.md

@@ -0,0 +1,127 @@
+<p align="center"><img src="./assets/logo.svg" alt="logo" width="150" /></p>
+
+<h1 align="center" alt="title">ESLint React</h1>
+
+[![Version](https://img.shields.io/npm/v/@eslint-react/eslint-plugin?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
+[![Size](https://img.shields.io/bundlephobia/minzip/@eslint-react/eslint-plugin?label=gzip&style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/package/@eslint-react/eslint-plugin)
+[![Downloads](https://img.shields.io/npm/dt/@eslint-react/eslint-plugin.svg?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@eslint-react/eslint-plugin)
+
+A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.
+
+## Roadmap
+
+- [Milestone 1.5 ↗](https://eslint-react.xyz/roadmap#milestone-15)
+- [Milestone 2.0 ↗](https://eslint-react.xyz/roadmap#milestone-20)
+- [Milestone 2.5 ↗](https://eslint-react.xyz/roadmap#milestone-25-draft)
+
+## Features
+
+- **Universal** rules for libraries and frameworks that use React as a UI runtime.
+- **Well designed** rule behaviors and sensible defaults.
+- **Maximum flexibility** through minimum configuration options.
+
+## Public packages
+
+### All-in-one packages
+
+- [`@eslint-react/eslint-plugin`](https://www.npmjs.com/package/@eslint-react/eslint-plugin) - The main ESLint plugin package including all rules and config presets in this repository.
+
+### Individual packages (will be available in 2.0)
+
+- `eslint-plugin-react-core` - Core rules (DOM Irrelevant, Render Target Agnostic, Formatting Independent).
+- `eslint-plugin-react-dom` - DOM specific rules for React DOM.
+- `eslint-plugin-react-hooks-extra` - Extra React Hooks rules.
+- `eslint-plugin-react-naming-convention` - Naming convention rules.
+
+## Supported ESLint versions
+
+- 8.57.0 or later
+
+## Supported React versions
+
+- 18.2.0 or later
+
+## Supported engines
+
+### Node.js
+
+- 18.18.0 or later
+
+### Bun
+
+- 1.0.15 or later
+
+### Install
+
+```sh
+# npm
+npm install --save-dev @eslint-react/eslint-plugin
+```
+
+### Setup
+
+Add the plugin to your `eslint.config.js`:
+
+```js
+// @ts-check
+
+import js from "@eslint/js";
+import react from "@eslint-react/eslint-plugin";
+
+export default [
+  js.configs.recommended,
+  {
+    files: ["**/*.{ts,tsx}"],
+    ...react.configs.recommended,
+  },
+];
+```
+
+[Full Installation Guide ↗](https://eslint-react.xyz/docs/installation)
+
+## Presets
+
+- **recommended**\
+  Enable rules that are recommended by ESLint React.
+- **recommended-type-checked**\
+  Enable rules that are recommended by ESLint React with additional rules that require type information.
+- **dom**\
+  Enable rules that are specific to React DOM.
+- **off-dom**\
+  Disable rules that are specific to React DOM.
+- **all**\
+  Enable all rules in this plugin except for debug rules.
+- **off**\
+  Disable all rules in this plugin except for debug rules.
+
+[Full Presets List↗](https://eslint-react.xyz/presets/overview)
+
+## Rules
+
+[Rules Overview ↗](https://eslint-react.xyz/rules/overview)
+
+## Contributing
+
+Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.
+
+Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
+
+Thank you to everyone contributing to ESLint React!
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Inspiration
+
+- [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
+- [eslint-plugin-functional](https://github.com/eslint-functional/eslint-plugin-functional)
+- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
+- [eslint-plugin-filenames-simple](https://github.com/epaew/eslint-plugin-filenames-simple)
+- [rome/tools](https://github.com/rome/tools)
+- [rust-clippy](https://github.com/rust-lang/rust-clippy)
+
+## Prior art
+
+- [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react)
+- [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)

scripts/lib/fs.ts

@@ -1,6 +1,7 @@
 import type { BunFile } from "bun";
-import { isString } from "effect/Predicate";
+import { Function as F, Predicate as Pred } from "effect";
 
-export function copyFile(src: BunFile | string, dest: string) {
-  return Bun.write(dest, isString(src) ? Bun.file(src) : src);
-}
+export const copyFile: {
+  (src: string | BunFile): (dest: string) => Promise<void>;
+  (src: string | BunFile, dest: string): BunFile;
+} = F.dual(2, (src: BunFile | string, dest: string) => Bun.write(dest, Pred.isString(src) ? Bun.file(src) : src));

scripts/update-readme.ts

@@ -0,0 +1,5 @@
+import { copyFile } from "./lib/fs";
+
+const source = "README.md";
+const dest = ["packages/plugins/eslint-plugin/README.md"];
+await Promise.all(dest.map((d) => copyFile(source, d)));