Draft: v4

.eslint-doc-generatorrc.js

@@ -0,0 +1,25 @@
+/* eslint-disable unicorn/prevent-abbreviations */
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  // configEmoji: [['recommended', '✅']],
+  // ignoreConfig: ['all', 'flat/all', 'flat/recommended'],
+  ignoreDeprecatedRules: true,
+  // ruleDocNotices: [],
+  // ruleDocSectionExclude: [],
+  // ruleDocSectionInclude: [],
+  ruleDocTitleFormat: "desc",
+  ruleListColumns: [
+    "name",
+    "description",
+    "configsError",
+    "configsWarn",
+    "fixable",
+    "hasSuggestions",
+    "requiresTypeChecking",
+  ],
+  // ruleListSplit: [],
+  // urlConfigs: 'https://github.com/...#preset-configs-eslintconfigjs',
+};
+
+// eslint-disable-next-line no-undef
+module.exports = config;

.github/workflows/run-tests.yml

@@ -0,0 +1,29 @@
+on:
+  - push
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run the tests
+        run: |
+          node --version
+          pnpm --version
+          pnpm run lint
+          pnpm run test

.gitignore

@@ -1,3 +1,41 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
 node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
 .DS_Store
+*.pem
 .idea
+/lib
+*.tsbuildinfo

.nvmrc

@@ -1 +1 @@
-v18.12.0
+v20.10.0

.vscode/settings.json

@@ -1,4 +1,10 @@
 {
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
-}
+  "editor.formatOnSave": true,
+  "files.associations": {
+    "*.css": "tailwindcss"
+  }
+}

CONTRIBUTING.md

@@ -9,8 +9,7 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
 
 ## Development
 
-You can use [Corepack](https://nodejs.org/api/corepack.html) to ensure you're using the same package
-manager. Run `corepack enabled` before running `npm install`.
+Latest version of the plugin uses `pnpm` instead of `npm` as package manager.
 
 ## Pull Request Process
 

docs/rules/README.md

@@ -0,0 +1,11 @@
+# Be careful when you edit the docs
+
+## Each rule's documentation is partially generated
+
+Running `pnpm docs:init` will create new files if needed.
+
+Running `pnpm docs:update` will update the existing docs.
+
+## Generated sections
+
+The generated sections are surrounded by HTML comments mentioning "auto-generated".