feat(eslint-config)!: add a config preset for validating dependencies…

… in package.json files (#813)

.changeset/eight-bulldogs-camp.md

@@ -0,0 +1,6 @@
+---
+"@bfra.me/eslint-config": minor
+---
+
+Add a config preset for validating dependencies in package.json files.
+

eslint.config.ts

@@ -3,6 +3,7 @@ import {defineConfig} from './packages/eslint-config/src'
 export const config = defineConfig({
   name: '@bfra.me/works',
   ignores: ['**/test/fixtures', '**/test/_fixtures'],
+  packageJson: true,
   typescript: {
     parserOptions: {
       project: [

packages/eslint-config/eslint.config.ts

@@ -1,13 +1,12 @@
 import config from '../../eslint.config'
 import {composeConfig} from './src/compose-config'
 
-export default composeConfig(
-  config,
-  {
+export default composeConfig(config)
+  .insertAfter('@bfra.me/ignores', {
     name: '@bfra.me/eslint-config/ignores',
-    ignores: ['.eslint-config-inspector/', 'lib', 'src/rules.d.ts'],
-  },
-  {
+    ignores: ['.eslint-config-inspector', 'lib', 'src/rules.d.ts'],
+  })
+  .append({
     name: '@bfra.me/eslint-config',
     files: ['src/**/*.ts'],
     rules: {
@@ -19,5 +18,4 @@ export default composeConfig(
         },
       ],
     },
-  },
-)
+  })

packages/eslint-config/package.json

@@ -81,6 +81,7 @@
     "eslint": "9.17.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-no-only-tests": "3.3.0",
+    "eslint-plugin-node-dependencies": "0.12.0",
     "eslint-plugin-prettier": "5.2.1",
     "eslint-typegen": "0.3.2",
     "tsup": "8.3.5",

packages/eslint-config/scripts/generate-types.ts

@@ -6,6 +6,7 @@ import {defineConfig} from '../src/define-config'
 
 const configs = await defineConfig(
   {
+    packageJson: true,
     plugins: {
       '': {
         rules: Object.fromEntries(builtinRules),

packages/eslint-config/src/configs/index.ts

@@ -9,6 +9,7 @@ export * from './jsdoc'
 export * from './jsonc'
 export * from './markdown'
 export * from './node'
+export * from './package-json'
 export * from './perfectionist'
 export * from './prettier'
 export * from './regexp'

packages/eslint-config/src/configs/package-json.ts

@@ -0,0 +1,43 @@
+import type {Config} from '../config'
+import type {Flatten, OptionsFiles} from '../options'
+import {anyParser} from '../parsers/any-parser'
+import {interopDefault} from '../plugins'
+import {requireOf} from '../require-of'
+import {fallback} from './fallback'
+import {jsonSchema} from './json-schema'
+
+export type PackageJsonOptions = Flatten<OptionsFiles>
+
+export const packageJsonFiles = ['package.json', 'package.json5', 'package.jsonc'].flatMap(file => [
+  file,
+  `**/${file}`,
+])
+
+export async function packageJson(options: PackageJsonOptions = {}): Promise<Config[]> {
+  const {files = packageJsonFiles} = options
+  return requireOf(
+    ['eslint-plugin-node-dependencies'],
+    async () => {
+      // @ts-expect-error: Missing type definitions
+      const pluginNodeDependencies = await interopDefault(import('eslint-plugin-node-dependencies'))
+      return [
+        ...pluginNodeDependencies.configs['flat/recommended'].map(
+          (config: Config, index: number) => ({
+            ...config,
+            name: config.plugins
+              ? `@bfra.me/package-json/plugins`
+              : `@bfra.me/${config.name || `package-json/unnamed${index}`}`,
+            files,
+          }),
+        ),
+        ...(await jsonSchema('package-json', files as string[])),
+      ]
+    },
+    async missingList =>
+      fallback(missingList, {
+        name: '@bfra.me/package-json/fallback',
+        files,
+        languageOptions: {parser: anyParser},
+      }),
+  )
+}

packages/eslint-config/src/define-config.ts

@@ -14,6 +14,7 @@ import {
   jsonc,
   markdown,
   node,
+  packageJson,
   perfectionist,
   prettier,
   regexp,
@@ -57,6 +58,7 @@ export async function defineConfig(
   const {
     gitignore: enableGitignore = true,
     jsx: enableJsx = true,
+    packageJson: enablePackageJson = false,
     perfectionist: enablePerfectionist = true,
     prettier: enablePrettier = isPackageExists('prettier'),
     regexp: enableRegexp = true,
@@ -96,6 +98,10 @@ export async function defineConfig(
     command(),
   )
 
+  if (enablePackageJson) {
+    configs.push(packageJson(resolveSubOptions(options, 'packageJson')))
+  }
+
   if (enablePrettier) {
     configs.push(
       prettier({

packages/eslint-config/src/options.ts

@@ -193,6 +193,13 @@ export type Options = Flatten<
      */
     markdown?: boolean | (OptionsOverrides & OptionsPrettier)
 
+    /**
+     * Enable support for package.json files.
+     *
+     * @default false
+     */
+    packageJson?: boolean | OptionsFiles
+
     /**
      * Options to override the behavior of Perfectionist sorting rules.
      */