Merge pull request #96 from Mitsunee/add-flat-config-docs

Add basic Flat Config setup to README

Author: joshwilsonvu

.eslintignore

@@ -1,3 +1,4 @@
-dist
+./dist
+./configs
 node_modules
-jest.config.js
+./jest.config.js

.eslintrc.json

@@ -57,6 +57,7 @@
       "plugins": ["solid"],
       "extends": "plugin:solid/recommended",
       "rules": {
+        "@typescript-eslint/no-unused-vars": 0,
         "@typescript-eslint/ban-ts-comment": 0,
         "@typescript-eslint/no-empty-function": 0
       }

README.md

@@ -16,6 +16,17 @@ migrate some React patterns to Solid code.
 It's approaching a `1.0.0` release, and it's well tested and should be helpful in Solid projects
 today.
 
+<!-- AUTO-GENERATED-CONTENT:START (TOC) -->
+- [Installation](#installation)
+- [Configuration](#configuration)
+  - [TypeScript](#typescript)
+  - [Manual Configuration](#manual-configuration)
+  - [Flat Configuration](#flat-configuration)
+- [Rules](#rules)
+- [Troubleshooting](#troubleshooting)
+- [Versioning](#versioning)
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## Installation
 
 Install `eslint` and `eslint-plugin-solid` locally.
@@ -100,6 +111,54 @@ options you can set.
 }
 ```
 
+### Flat Configuration
+
+ESLint's new configuration system, [Flat
+Configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new#using-configurations-included-in-plugins),
+is available starting in ESLint [v8.23.0](https://github.com/eslint/eslint/releases/tag/v8.23.0). To
+use it, create an `eslint.config.js` file at the root of your project, instead of `.eslintrc.*`
+and/or `.eslintignore`.
+
+```js
+import js from "@eslint/js";
+import solid from "eslint-plugin-solid/configs/recommended";
+
+export default [
+  js.configs.recommended, // replaces eslint:recommended
+  solid,
+];
+```
+
+For TypeScript:
+
+```js
+import js from "@eslint/js";
+import solid from 'eslint-plugin-solid/configs/typescript';
+import * as tsParser from "@typescript-eslint/parser",
+
+export default [
+  js.configs.recommended,
+  {
+    files: ["**/*.{ts,tsx}"],
+    ...solid,
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: 'tsconfig.json',
+      },
+    },
+  },
+]
+```
+
+These configurations do not configure global variables in ESLint. You can do this yourself manually
+or with a package like [globals](https://www.npmjs.com/package/globals) by creating a configuration
+with a `languageOptions.globals` object. We recommend setting up global variables for Browser APIs
+as well as at least ES2015.
+
+Note for the ESLint VSCode Extension: Enable the "Use Flat Config" setting for your workspace to
+enable Flat Config support.
+
 ## Rules
 
 ✔: Enabled in the `recommended` configuration.
@@ -134,7 +193,7 @@ options you can set.
 ## Troubleshooting
 
 The rules in this plugin provide sensible guidelines as well as possible, but there may be times
-where the you better than the rule and want to ignore a warning. Just [add a
+where you know better than the rule and want to ignore a warning. To do that, [add a
 comment](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-rules) like the
 following:
 
@@ -143,10 +202,13 @@ following:
 const [editedValue, setEditedValue] = createSignal(props.value);
 ```
 
-_However_, there may also be times where a rule correctly warns about a subtle problem,
+_Please note_: there may also be times where a rule correctly warns about a subtle problem,
 even if it looks like a false positive at first. With `solid/reactivity`, please look at the
 [reactivity docs](./docs/reactivity.md#troubleshooting) before deciding to disable the rule.
 
+When in doubt, feel free to [file an
+issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/new/choose).
+
 ## Versioning
 
 Pre-1.0.0, the rules and the `recommended` and `typescript` configuations will be

configs/recommended.d.ts

@@ -0,0 +1,4 @@
+declare module "eslint-plugin-solid/configs/recommended" {
+  const config: typeof import("../src/configs/recommended");
+  export = config;
+}

configs/recommended.js

@@ -0,0 +1 @@
+module.exports = require("../dist/configs/recommended");

configs/typescript.d.ts

@@ -0,0 +1,4 @@
+declare module "eslint-plugin-solid/configs/typescript" {
+  const config: typeof import("../src/configs/typescript");
+  export = config;
+}

configs/typescript.js

@@ -0,0 +1 @@
+module.exports = require("../dist/configs/typescript");

package.json

@@ -46,10 +46,11 @@
   "devDependencies": {
     "@babel/core": "^7.21.3",
     "@babel/eslint-parser": "^7.21.3",
+    "@eslint/js": "^8.44.0",
     "@rollup/plugin-commonjs": "^22.0.2",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^14.1.0",
-    "@types/eslint": "^8.21.2",
+    "@types/eslint": "^8.40.2",
     "@types/fs-extra": "^9.0.13",
     "@types/is-html": "^2.0.0",
     "@types/jest": "^27.5.2",
@@ -58,7 +59,7 @@
     "@types/prettier": "^2.7.2",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "@typescript-eslint/parser": "^5.55.0",
-    "eslint": "^8.36.0",
+    "eslint": "^8.43.0",
     "eslint-plugin-eslint-plugin": "^5.0.8",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-solid": "link:",
@@ -74,7 +75,7 @@
     "markdown-magic": "^2.6.1",
     "prettier": "^2.8.4",
     "rollup": "^2.79.1",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.2"
   },