@mareuter/eslint-config 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mareuter/eslint-config
 
+## 0.1.2
+
+### Patch Changes
+
+- Updates to README
+- Updates to package.json
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -10,16 +10,36 @@ pnpm add -DE @mareuter/eslint-config
 
 **Note**: To use this package you must install the peer dependencies. There are multiple configurations in this package.
 
-For the ``base`` configuration:
+For the `base` configuration:
+
 ```
 pnpm add -DE eslint typescript-eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-only-warn @eslint/js
 ```
 
-For the ``turbo`` configuration, install the ``base`` packages and then:
+For the `turbo` configuration, install the `base` packages and then:
+
 ```
 pnpm add -DE eslint-plugin-turbo
 ```
 
-For the ``react`` configuration, install the ``base`` packages and then:
+For the `react` configuration, install the `base` packages and then:
+
 ```
 pnpm add -DE eslint-plugin-react eslint-plugin-react-hooks globals
+```
+
+## Usage
+
+Here is a minimal configuration file that extends the provided base configuration:
+
+### eslint.config.ts
+
+```
+/** @type {import("eslint").Linter.Config} */
+
+import { config } from '@mareuter/eslint-config/base'
+
+export default config
+```
+
+The module provides `turbo` and `react` configurations too.

package/eslint.config.js

@@ -0,0 +1,5 @@
+/** @type {import("eslint").Linter.Config} */
+
+import { config } from '@mareuter/eslint-config/base'
+
+export default config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mareuter/eslint-config",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "exports": {
     "./base": "./base.js",
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "eslint": "^10.2.1"
+    "eslint": "^10.6.0"
   },
   "peerDependencies": {
     "@eslint/js": "^10.0.1",

package/react.js

@@ -1,7 +1,7 @@
-import pluginReact from "eslint-plugin-react"
-import pluginReactHooks from "eslint-plugin-react-hooks"
-import globals from "globals"
-import { config as baseConfig } from "./base"
+import pluginReact from 'eslint-plugin-react'
+import pluginReactHooks from 'eslint-plugin-react-hooks'
+import globals from 'globals'
+import { config as baseConfig } from './base'
 
 /**
  * A custom ESLint configuration for libraries that use React.
@@ -21,13 +21,13 @@ export const config = [
   },
   {
     plugins: {
-      "react-hooks": pluginReactHooks,
+      'react-hooks': pluginReactHooks,
     },
-    settings: { react: { version: "detect" } },
+    settings: { react: { version: 'detect' } },
     rules: {
       ...pluginReactHooks.configs.recommended.rules,
       // React scope no longer necessary with new JSX transform.
-      "react/react-in-jsx-scope": "off",
+      'react/react-in-jsx-scope': 'off',
     },
   },
 ]

package/turbo.js

@@ -15,4 +15,4 @@ export const config = [
       'turbo/no-undeclared-env-vars': 'warn',
     },
   },
-]
+]