Update readme

Author: anubra266

README.md

@@ -1,3 +1,4 @@
+<!-- This file is built by build-readme.js. Do not edit it directly; edit README.md.template instead. -->
 <br>
 <div align="center">
 
@@ -79,6 +80,22 @@ Or enable all rules in extends:
 
 ## Rules
 
+Rules with options are indicated with ⚙️. Rules which are fixable are indicated with 🔧.
+
+Where rules are included in the configs `recommended`, or `all` it is indicated below.
+
+* [`@pandacss/file-not-included`](docs/rules/file-not-included.md) `all`, `recommended`
+* [`@pandacss/no-config-function-in-source`](docs/rules/no-config-function-in-source.md) 🔧 `all`, `recommended`
+* [`@pandacss/no-debug`](docs/rules/no-debug.md) 🔧 `all`, `recommended`
+* [`@pandacss/no-dynamic-styling`](docs/rules/no-dynamic-styling.md) `all`, `recommended`
+* [`@pandacss/no-escape-hatch`](docs/rules/no-escape-hatch.md) 🔧 `all`
+* [`@pandacss/no-hardcoded-color`](docs/rules/no-hardcoded-color.md) `all`
+* [`@pandacss/no-invalid-token-paths`](docs/rules/no-invalid-token-paths.md) `all`, `recommended`
+* [`@pandacss/no-property-renaming`](docs/rules/no-property-renaming.md) `all`, `recommended`
+* [`@pandacss/no-shorthand-prop`](docs/rules/no-shorthand-prop.md) 🔧 `all`
+* [`@pandacss/no-unsafe-token-fn-usage`](docs/rules/no-unsafe-token-fn-usage.md) 🔧 `all`
+* [`@pandacss/prefer-atomic-properties`](docs/rules/prefer-atomic-properties.md) `all`
+
 ## Settings
 
 ### `configPath`

README.md.template

@@ -0,0 +1,105 @@
+<br>
+<div align="center">
+
+<p align="center">
+    <a href="https://panda-css.com">
+        <picture>
+            <img alt="Panda CSS" src="https://github.com/chakra-ui/panda/raw/main/.github/assets/banner.png" width="100%">
+        </picture>
+    </a>
+</p>
+<p align="center">ESLint plugin for Panda CSS</p>
+
+<p align="center">
+    <a aria-label="Github Actions" href="https://github.com/chakra-ui/eslint-plugin-panda/actions/workflows/quality.yml">
+        <picture>
+            <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/actions/workflow/status/chakra-ui/eslint-plugin-panda/quality.yml?branch=main&label=%20&message=twitter&color=212022&logo=githubactions&style=for-the-badge">
+            <source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/github/actions/workflow/status/chakra-ui/eslint-plugin-panda/quality.yml?branch=main&label=%20&message=twitter&color=f6f7f8&logo=githubactions&style=for-the-badge&logoColor=%23000">
+            <img alt="Github release actions" src="https://img.shields.io/github/actions/workflow/status/chakra-ui/eslint-plugin-panda/quality.yml?branch=main&label=%20&message=twitter&color=f6f7f8&logo=githubactions&style=for-the-badge&logoColor=%23000">
+        </picture>
+    </a>
+</p>
+
+</div>
+
+## Documentation
+
+Visit the Panda CSS [eslint docs](https://panda-css.com/docs/references/eslint) to view the full documentation for this
+plugin.
+
+## Getting Started
+
+### Installation
+
+```bash
+pnpm add -D @pandacss/eslint-plugin
+```
+
+### Usage
+
+Add `@pandacss/eslint-plugin` to the plugins section of your `.eslintrc` configuration file. You can omit the
+`/eslint-plugin` suffx:
+
+```json
+{
+  "plugins": ["@pandacss"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "@pandacss/no-debug": "error"
+  }
+}
+```
+
+You can also enable the `recommended` rules in extends:
+
+```diff
+{
+-   "plugins": ["@pandacss"]
++   "extends": ["plugin:@pandacss/recommended"]
+}
+```
+
+Or enable all rules in extends:
+
+```diff
+{
+-   "plugins": ["@pandacss"]
++   "extends": ["plugin:@pandacss/all"]
+}
+```
+
+> [!WARNING]  
+> This is not recommended. You should only enable the rules you need.
+
+## Rules
+
+Rules with options are indicated with ⚙️. Rules which are fixable are indicated with 🔧.
+
+Where rules are included in the configs `recommended`, or `all` it is indicated below.
+
+<!-- rules -->
+
+## Settings
+
+### `configPath`
+
+You can tell `eslint` to use a custom panda config file by setting the `configPath` option in your `.eslintrc.js` file.
+
+By default we find the nearest panda config to the linted file.
+
+```js filename=".eslintrc.(c)js"
+const path = require('path')
+
+module.exports = {
+  plugins: ['@pandacss'],
+  settings: {
+    '@pandacss/configPath': path.join('PATH-TO/panda.config.js'),
+  },
+}
+```

package.json

@@ -7,7 +7,7 @@
     "dev": "pnpm -r --parallel dev",
     "build": "pnpm -r --parallel build",
     "test": "vitest run",
-    "docs": "rm -rf docs/rules && DOCGEN=1 vitest run",
+    "docs": "rm -rf docs/rules && DOCGEN=1 vitest run && node tools/build-readme.js",
     "lint": "eslint . --ext .ts",
     "lint:eslint-docs": "npm run update:eslint-docs -- --check",
     "update:eslint-docs": "eslint-doc-generator plugin && pnpm run prettier-fix",

tools/build-readme.js

@@ -0,0 +1,60 @@
+'use strict'
+
+const fs = require('fs')
+const template = fs.readFileSync('README.md.template', { encoding: 'UTF8' })
+const rulesWithConfig = require('eslint-docgen').rulesWithConfig
+const pluginName = '@pandacss'
+const docPath = 'docs/rules/{name}.md'
+
+function getRules(deprecated) {
+  return Array.from(rulesWithConfig.keys())
+    .map((rule) => {
+      const fullRule = pluginName + '/' + rule
+      const ruleData = rulesWithConfig.get(rule)
+      const docs = ruleData.meta.docs
+      if (!!docs.deprecated === deprecated) {
+        return (
+          '* [`' +
+          fullRule +
+          '`](' +
+          docPath.replace('{name}', rule) +
+          ')' +
+          (ruleData.meta.schema.length ? ' ⚙️' : '') +
+          (ruleData.meta.fixable ? ' 🔧' : '') +
+          (docs.replacedBy
+            ? ' (use [`' +
+              pluginName +
+              '/' +
+              docs.replacedBy +
+              '`](' +
+              docPath.replace('{name}', docs.replacedBy) +
+              '))'
+            : '') +
+          (ruleData.configMap.size
+            ? ' ' +
+              Array.from(ruleData.configMap.keys())
+                .map((name) => {
+                  const options = ruleData.configMap.get(name)
+                  return '`' + name + (options && Object.keys(options[0]).length ? '†' : '') + '`'
+                })
+                .join(', ')
+            : '')
+        )
+      }
+      return null
+    })
+    .filter((rule) => rule)
+    .join('\n')
+}
+
+fs.writeFile(
+  'README.md',
+  '<!-- This file is built by build-readme.js. Do not edit it directly; edit README.md.template instead. -->\n' +
+    template.replace('<!-- rules -->', getRules(false)).replace('<!-- deprecated -->', getRules(true)),
+  (err) => {
+    if (err) {
+      throw err
+    }
+  },
+)
+