From dd9d8d73db807dde1be25e88a9b25fd24dd010cb Mon Sep 17 00:00:00 2001
From: James Garbutt <43081j@users.noreply.github.com>
Date: Wed, 15 May 2024 22:29:29 +0100
Subject: [PATCH] feat: support flat configs (#16)

---
 README.md                         |  4 ++--
 eslint.config.js                  |  1 +
 src/configs/legacy-recommended.ts |  8 ++++++++
 src/configs/recommended.ts        | 15 +++++++++++----
 src/main.ts                       | 15 ++++++++++-----
 src/test/configs_test.ts          | 19 +++++++++++++++++++
 6 files changed, 51 insertions(+), 11 deletions(-)
 create mode 100644 src/configs/legacy-recommended.ts
 create mode 100644 src/test/configs_test.ts

diff --git a/README.md b/README.md
index 4b9ea2e..ea7a474 100644
--- a/README.md
+++ b/README.md
@@ -29,11 +29,11 @@ Or if you're using (flat) config files, add to your `eslint.config.js`:
 import {configs} from 'eslint-plugin-depend';
 
 export default [
-  configs.recommended,
+  configs['flat/recommended'],
 
   // or if you want to specify `files`, or other options
   {
-    ...configs.recommended,
+    ...configs['flat/recommended'],
     files: ['test/**/*.js']
   }
 ];
diff --git a/eslint.config.js b/eslint.config.js
index 8546382..c720441 100644
--- a/eslint.config.js
+++ b/eslint.config.js
@@ -13,6 +13,7 @@ module.exports = [
     rules: {
       'comma-dangle': ['error', 'never'],
       'indent': 'off',
+      'quote-props': 'off',
       'max-len': ['error', {
         ignoreTemplateLiterals: true,
         ignoreStrings: true
diff --git a/src/configs/legacy-recommended.ts b/src/configs/legacy-recommended.ts
new file mode 100644
index 0000000..76a4c48
--- /dev/null
+++ b/src/configs/legacy-recommended.ts
@@ -0,0 +1,8 @@
+import type {ESLint} from 'eslint';
+
+export const config: ESLint.ConfigData = {
+  plugins: ['depend'],
+  rules: {
+    'depend/ban-dependencies': 'error'
+  }
+};
diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts
index 4e12105..8475860 100644
--- a/src/configs/recommended.ts
+++ b/src/configs/recommended.ts
@@ -1,4 +1,11 @@
-export const recommended = {
-  plugins: ['depend'],
-  rules: {}
-};
+import type {ESLint, Linter} from 'eslint';
+
+export const configFactory = (plugin: ESLint.Plugin): Linter.FlatConfig => ({
+  plugins: {
+    depend: plugin
+  },
+
+  rules: {
+    'depend/ban-dependencies': 'error'
+  }
+});
diff --git a/src/main.ts b/src/main.ts
index 2aa2ac1..3465fb3 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,10 +1,15 @@
-import {recommended} from './configs/recommended.js';
+import type {Rule, ESLint} from 'eslint';
+import {configFactory as configRecommended} from './configs/recommended.js';
+import {config as configLegacyRecommended} from './configs/legacy-recommended.js';
 import {rule as banDependencies} from './rules/ban-dependencies.js';
 
-export const configs = {
-  recommended
+export const rules: Record<string, Rule.RuleModule> = {
+  'ban-dependencies': banDependencies
 };
 
-export const rules = {
-  'ban-dependencies': banDependencies
+const plugin: ESLint.Plugin = {rules};
+
+export const configs = {
+  recommended: configLegacyRecommended,
+  'flat/recommended': configRecommended(plugin)
 };
diff --git a/src/test/configs_test.ts b/src/test/configs_test.ts
new file mode 100644
index 0000000..489a529
--- /dev/null
+++ b/src/test/configs_test.ts
@@ -0,0 +1,19 @@
+import type {ESLint, Linter} from 'eslint';
+import * as assert from 'node:assert/strict';
+import {test} from 'node:test';
+import {configs} from '../main.js';
+
+type ConfigLike = Linter.FlatConfig | ESLint.ConfigData;
+
+const isFlatConfig = (config: ConfigLike): config is Linter.FlatConfig =>
+  !Array.isArray(config.plugins);
+
+test('configs', async (t) => {
+  await t.test('should define configs correctly', () => {
+    assert.ok(configs['recommended']);
+    assert.ok(configs['flat/recommended']);
+
+    assert.ok(isFlatConfig(configs['flat/recommended']));
+    assert.equal(isFlatConfig(configs['recommended']), false);
+  });
+});