@petbee/eslint-config 1.0.14 → 1.0.16

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["./index.js"]
+}

package/README.md

@@ -1,6 +1,6 @@
 # `@petbee/eslint-config`
 
-This package provides Petbee's `.eslintrc` as an extensible shared config.
+This package provides Petbee's ESLint configuration as an extensible shared config, supporting both ESLint v9.x (flat config) and older versions (.eslintrc).
 
 ## Installation
 
@@ -12,7 +12,42 @@ yarn add -D @petbee/eslint-config typescript prettier
 
 ## Usage
 
-After installing the module, just add it to your `extends` array inside your `.eslintrc`.
+### For ESLint v8.x and older (legacy config)
+
+```jsonc
+// .eslintrc
+{
+  "extends": ["@petbee/eslint-config"]
+}
+```
+
+### For ESLint v9.x (flat config)
+
+```javascript
+// eslint.config.js
+import petbeeConfig from '@petbee/eslint-config'
+
+export default [
+  ...petbeeConfig,
+  // Your custom configurations...
+]
+```
+
+### For projects using both ESLint versions
+
+If you need to support both ESLint versions in the same project, you can:
+
+```javascript
+// eslint.config.js
+import petbeeConfig from '@petbee/eslint-config'
+
+export default [
+  ...petbeeConfig,
+  // Your custom configurations...
+]
+```
+
+And maintain a .eslintrc file:
 
 ```jsonc
 // .eslintrc

package/eslint-config.d.ts

@@ -0,0 +1,10 @@
+declare module '@petbee/eslint-config' {
+  import type { FlatConfig } from 'eslint'
+
+  // For ESLint v9.x (flat config)
+  const flatConfig: FlatConfig.Config[]
+  export default flatConfig
+
+  // For older ESLint versions (.eslintrc)
+  export const legacyConfig: Record<string, unknown>
+}

package/eslint.config.mjs

@@ -12,6 +12,16 @@ import importsConfig from './rules/imports.js'
 import typescriptConfig from './rules/typescript.js'
 import testsConfig from './rules/tests.js'
 
+// Helper function to ensure configs are in the correct format for spreading
+const ensureArray = (config) => {
+  if (!config) return []
+  if (Array.isArray(config)) return config
+  // If it's an object with rules, convert to a config object
+  if (config.rules || config.extends || config.plugins) return [config]
+
+  return []
+}
+
 export default [
   js.configs.recommended,
   {
@@ -36,13 +46,13 @@ export default [
       __DEV__: true,
     },
   },
-  ...prettierConfig,
-  ...errorsConfig,
-  ...nodeConfig,
-  ...styleConfig,
-  ...variablesConfig,
-  ...bestPracticesConfig,
-  ...importsConfig,
-  ...typescriptConfig,
-  ...testsConfig,
+  ...ensureArray(prettierConfig),
+  ...ensureArray(errorsConfig),
+  ...ensureArray(nodeConfig),
+  ...ensureArray(styleConfig),
+  ...ensureArray(variablesConfig),
+  ...ensureArray(bestPracticesConfig),
+  ...ensureArray(importsConfig),
+  ...ensureArray(typescriptConfig),
+  ...ensureArray(testsConfig),
 ]

package/index.js

@@ -1,3 +1,4 @@
+// This is the legacy config for ESLint < 9.0
 module.exports = {
   parserOptions: {
     project: 'tsconfig.json',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@petbee/eslint-config",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Petbee's eslint config",
   "keywords": [
     "eslint",
@@ -13,17 +13,9 @@
     ".": {
       "require": "./index.js",
       "import": "./eslint.config.mjs"
-    }
+    },
+    "./legacy": "./index.js"
   },
-  "main": "index.js",
-  "types": "./eslint.config.d.ts",
-  "files": [
-    "index.js",
-    "eslint.config.d.ts",
-    "eslint.config.mjs",
-    "rules/",
-    "lib/"
-  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/petbee/typescript.git",
@@ -63,7 +55,6 @@
     "typescript": "^4.0.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@petbee/prettier-config": "^1.0.3",
     "@types/react": "18.2.37",
     "eslint": "8.53.0",
     "prettier": "3.0.3",
@@ -73,5 +64,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d91314aafe3e270498397c41fe3332a21cc2fc75"
+  "gitHead": "c93961f575f961f43e9995e3b9d6b8bbddb5e0a6"
 }

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@petbee/tsconfig/base.json"
+}