eslint-config-terrax 0.3.0-next.1bdeff6 → 0.3.0

package/README.md

@@ -1,13 +1,14 @@
+<div align="center">
+
 # Terrax ESLint Config
 
-<div align="center">
- <br />
- <p>
-  <a href="https://www.npmjs.com/package/eslint-config-terrax"><img src="https://img.shields.io/npm/v/eslint-config-terrax.svg?maxAge=3600&logo=npm&style=for-the-badge" alt="npm version" /></a>
-  <a href="https://www.npmjs.com/package/eslint-config-terrax"><img src="https://img.shields.io/npm/dt/eslint-config-terrax.svg?maxAge=3600&logo=npm&style=for-the-badge" alt="npm downloads" /></a>
- </p>
+[![npm version](https://img.shields.io/npm/v/eslint-config-terrax.svg?maxAge=3600&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/eslint-config-terrax)
+[![npm downloads](https://img.shields.io/npm/dt/eslint-config-terrax.svg?maxAge=3600&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/eslint-config-terrax)
+
 </div>
 
+_This config was inspired by [eslint-config-neon](https://github.com/iCrawl/eslint-config-neon) and [eslint-config-tesseract](https://github.com/MenuDocs/eslint-config-tesseract)._
+
 ## Installation
 
 terrax comes as a complete package, none of the configs require any additional dependecies.
@@ -18,30 +19,83 @@ yarn add eslint eslint-config-terrax
 pnpm add eslint eslint-config-terrax
 ```
 
-> [!IMPORTANT]
-> **Flat Config only**
->
-> It is important to note that this package only exports [ESLint Flat Config][]! This means that you _have_ to use `eslint.config.js`, `eslint.config.mjs`, or `eslint.config.cjs` to use this package. See the ESLint documentation on flat config for more information.
+## Usage
+
+This package includes the following configurations:
+
+-   [`eslint-config-terrax/common`](./src/common.ts) – The terrax code style guide.
+-   [`eslint-config-terrax/browser`](./src/browser.ts) – for usage with DOM and other browser APIs.
+-   [`eslint-config-terrax/jsx`](./src/jsx.ts) – for usage with [JSX](https://reactjs.org/docs/introducing-jsx.html) (with or without [React](https://reactjs.org/)).
+-   [`eslint-config-terrax/jsx-a11y`](./src/jsx-a11y.ts) – for usage with [JSX](https://facebook.github.io/react/) (with or without [React](https://reactjs.org/)) and want to include [accessibility checks](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y).
+-   [`eslint-config-terrax/next`](./src/next.ts) – for usage with [Next.js](https://nextjs.org/).
+-   [`eslint-config-terrax/react`](./src/react.ts) – for usage with [React](https://reactjs.org/).
+-   [`eslint-config-terrax/typescript`](./src/typescript.ts) – for usage with [TypeScript](http://typescriptlang.org/).
+
+### Notes
+
+#### Flat Config only
+
+It is important to note that this package only exports [ESLint Flat Config][]! This means that you _have_ to use `eslint.config.js`, `eslint.config.mjs`, or `eslint.config.cjs` to use this package. See the ESLint documentation on flat config for more information.
+
+#### Merging Configs
 
-## Configuration
+In the examples below you will see `lodash.merge` being used. This is of vital importance as objects often have to be deeply merged when using ESLint Flat Config. If you don't merge the objects, you will overwrite the previous object with the new one, and your config will be invalid.
+
+### Configuration
+
+#### Node.js
 
 ```js
-import { common, stylistic, typescript, prettier } from 'eslint-config-terrax';
-
-export default [
-    {
-        ignore: ['**/dist/*']
-    },
-    ...common,
-    ...typescript,
-    ...stylistic,
-    {
-        languageOptions: {
-            project: './tsconfig.json'
-        }
-    },
-    ...prettier
+import { common, typescript } from 'eslint-config-terrax';
+import merge from 'lodash.merge';
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+    ...[...common, ...typescript].map((config) =>
+        merge(config, {
+            files: ['src/**/*.ts'],
+            languageOptions: {
+                parserOptions: {
+                    project: 'tsconfig.eslint.json'
+                }
+            }
+        })
+    )
 ];
+
+export default config;
+```
+
+#### Next.js
+
+```js
+import { browser, common, next, react, typescript } from 'eslint-config-terrax';
+import merge from 'lodash.merge';
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
+ */
+const config = [
+    ...[...common, ...browser, ...typescript, ...react, ...next].map((config) =>
+        merge(config, {
+            files: ['src/**/*.ts'],
+            settings: {
+                react: {
+                    version: 'detect'
+                }
+            },
+            languageOptions: {
+                parserOptions: {
+                    project: 'tsconfig.json'
+                }
+            }
+        })
+    )
+];
+
+export default config;
 ```
 
 [ESLint Flat Config]: https://eslint.org/blog/2022/08/new-config-system-part-2/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-terrax",
-  "version": "0.3.0-next.1bdeff6",
+  "version": "0.3.0",
   "description": "The ESLint shareable config",
   "type": "module",
   "main": "./dist/cjs/common.cjs",
@@ -104,7 +104,6 @@
   "bugs": {
     "url": "https://github.com/rygent/eslint-config-terrax/issues"
   },
-  "funding": "https://github.com/rygent/eslint-config-terrax?sponsor",
   "dependencies": {
     "@eslint/compat": "^1.2.2",
     "@eslint/js": "^9.14.0",