eslint-config-reverentgeek 6.2.0 → 6.3.1

package/README.md

@@ -17,68 +17,44 @@ This package is [ReverentGeek's](https://reverentgeek.com/about/) preferred conf
 ```js
 "use strict";
 
-/* eslint-disable-next-line n/no-unpublished-require */
-const rgConfig = require( "eslint-config-reverentgeek" );
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
+const rg = require( "eslint-config-reverentgeek" ); // eslint-disable-line n/no-extraneous-require
 
-module.exports = [
-	rgConfig.configs.common,
+module.exports = defineConfig( [
 	{
+		extends: [ rg.configs.node ],
 		rules: {
 		}
 	}
-];
+] );
 ```
 
+The _node_ config adds specific support for Node.js and CommonJS modules.
+
 ## Alternative Configs
 
 The _node-esm_ config adds specific support for Node.js and ES modules (`import`/`export`).
 
 ```js
-/* eslint-disable-next-line n/no-unpublished-import */
-import rg from "eslint-config-reverentgeek";
+import { defineConfig } from "eslint/config"; // eslint-disable-line n/no-unpublished-import
+import rg from "eslint-config-reverentgeek"; // eslint-disable-line n/no-unpublished-import
 
-export default [
-	rg.configs["node-esm"],
-	{
-		rules: {
-		}
+export default defineConfig( {
+	extends: [ rg.configs["node-esm"] ],
+	rules: {
 	}
-];
+} );
 ```
 
 The _blog_ config changes the code style to two-spaced indentions, which is better for copying code samples to blog posts.
 
 ```js
-"use strict";
-
-/* eslint-disable-next-line n/no-unpublished-require */
-const rgConfig = require( "eslint-config-reverentgeek" );
-
-module.exports = [
-	rgConfig.configs.browser,
-	rgConfig.configs.blog,
-	{
-		rules: {
-		}
-	}
-];
-```
-
-The _node_ config adds specific support for Node.js and CommonJS modules.
-
-```js
-"use strict";
-
-/* eslint-disable-next-line n/no-unpublished-require */
-const rgConfig = require( "eslint-config-reverentgeek" );
+import { defineConfig } from "eslint/config";
+import rg from "eslint-config-reverentgeek";
 
-module.exports = [
-	rgConfig.configs.node,
-	{
-		rules: {
-		}
-	}
-];
+export default defineConfig( {
+  extends: [ rg.configs.browser, rg.configs.blog ]
+} );
 ```
 
 The _react_ config adds specific support for React, browser, and ES modules (`import`/`export`).
@@ -88,39 +64,29 @@ npm install --save-dev eslint-plugin-react
 ```
 
 ```js
-/* eslint-disable-next-line n/no-unpublished-import */
+import { defineConfig } from "eslint/config";
 import rg from "eslint-config-reverentgeek";
-/* eslint-disable-next-line n/no-unpublished-import */
 import react from "eslint-plugin-react";
 
-export default [
-	rg.configs.browser,
-	rg.configs.react,
-	{
-		plugins: {
-			react,
-		},
-		rules: {
-		}
+export default defineConfig( {
+	extends: [ rg.configs.browser, rg.configs.react ],
+	plugins: {
+		react
+	},
+	rules: {
 	}
-];
+} );
 ```
 
 The _browser_ config sets the `browser` environment and adds ES module support.
 
 ```js
-"use strict";
-
-/* eslint-disable-next-line n/no-unpublished-require */
-const rgConfig = require( "eslint-config-reverentgeek" );
+import { defineConfig } from "eslint/config";
+import rg from "eslint-config-reverentgeek";
 
-module.exports = [
-	rgConfig.configs.browser,
-	{
-		rules: {
-		}
-	}
-];
+export default defineConfig( {
+	extends: [ rg.configs.browser ]
+} );
 ```
 
 ## Legacy .eslintrc.js support (eslint < v9.0)

package/eslint.config.js

@@ -1,4 +1,6 @@
 "use strict";
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
+
 const node = require( "./src/node" );
 
 const config = {
@@ -19,5 +21,5 @@ const testConfig = {
 	}
 };
 
-module.exports = [ node, config, testConfig ];
+module.exports = defineConfig( [ node, config, testConfig ] );
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-config-reverentgeek",
-	"version": "6.2.0",
+	"version": "6.3.1",
 	"description": "ESLint rules that ReverentGeek likes :)",
 	"main": "src/index.js",
 	"repository": {
@@ -19,12 +19,12 @@
 	"author": "David Neal <david@reverentgeek.com> (https://reverentgeek.com)",
 	"license": "MIT",
 	"dependencies": {
-		"@stylistic/eslint-plugin": "^5.4.0",
+		"@stylistic/eslint-plugin": "^5.5.0",
 		"eslint-plugin-n": "^17.23.1",
 		"globals": "^16.4.0"
 	},
 	"devDependencies": {
-		"eslint": "^9.36.0"
+		"eslint": "^9.38.0"
 	},
 	"engines": {
 		"node": ">=18.0.0"

package/src/blog.js

@@ -1,9 +1,10 @@
 "use strict";
 
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 const styles = require( "@stylistic/eslint-plugin" );
 
-module.exports = {
-	name: "reverentgeek-blog",
+module.exports = defineConfig( {
+	name: "blog",
 	plugins: {
 		"@stylistic": styles
 	},
@@ -11,5 +12,5 @@ module.exports = {
 		"no-console": [ "off" ],
 		"@stylistic/indent": [ "error", 2 ]
 	}
-};
+} );
 

package/src/browser.js

@@ -1,18 +1,14 @@
 "use strict";
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 const globals = require( "globals" );
 const common = require( "./common" );
-const { merge } = require( "./utils" );
 
-const config = {
-	name: "reverentgeek-browser",
+module.exports = defineConfig( {
+	name: "browser",
+	extends: [ common ],
 	languageOptions: {
 		ecmaVersion: "latest",
 		sourceType: "module",
 		globals: globals.browser
-	},
-	rules: {
 	}
-};
-
-module.exports = merge( common, config );
-
+} );

package/src/common.js

@@ -1,11 +1,13 @@
 "use strict";
 
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
+
 const eslint = require( "@eslint/js" );
 const styles = require( "@stylistic/eslint-plugin" );
-const { merge } = require( "./utils" );
 
-const config = {
-	name: "reverentgeek-common",
+module.exports = defineConfig( {
+	name: "common",
+	extends: [ eslint.configs.recommended, styles.configs.recommended ],
 	rules: {
 		"no-console": [ "off" ],
 		"no-var": [ "error" ],
@@ -26,6 +28,5 @@ const config = {
 		"@stylistic/space-in-parens": [ "error", "always" ],
 		"@stylistic/template-curly-spacing": [ "error", "always" ]
 	}
-};
+} );
 
-module.exports = merge( eslint.configs.recommended, styles.configs.recommended, config );

package/src/esm.js

@@ -1,10 +1,11 @@
 "use strict";
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 
-module.exports = {
-	name: "reverentgeek-esm",
+module.exports = defineConfig( {
+	name: "esm",
 	languageOptions: {
 		ecmaVersion: "latest",
 		sourceType: "module"
 	}
-};
+} );
 

package/src/node-esm.js

@@ -1,19 +1,17 @@
 "use strict";
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 const common = require( "./common" );
 const nodePlugin = require( "eslint-plugin-n" );
 const nodeRecommended = nodePlugin.configs["flat/recommended-module"];
-const { merge } = require( "./utils" );
 
-const config = {
-	name: "reverentgeek-node-esm",
+module.exports = defineConfig( {
+	name: "node-esm",
+	extends: [ common, nodeRecommended ],
 	languageOptions: {
 		sourceType: "module"
 	},
 	rules: {
 		"n/exports-style": [ "error" ]
 	}
-};
-const merged = merge( common, nodeRecommended, config );
-
-module.exports = merged;
+} );
 

package/src/node.js

@@ -1,12 +1,14 @@
 
 "use strict";
+
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 const common = require( "./common" );
 const nodePlugin = require( "eslint-plugin-n" );
 const nodeRecommended = nodePlugin.configs["flat/recommended-script"];
-const { merge } = require( "./utils" );
 
-const config = {
-	name: "reverentgeek-node-commonjs",
+module.exports = defineConfig( {
+	name: "node-commonjs",
+	extends: [ common, nodeRecommended ],
 	languageOptions: {
 		sourceType: "commonjs"
 	},
@@ -14,9 +16,4 @@ const config = {
 		strict: [ "error", "global" ],
 		"n/exports-style": [ "error" ]
 	}
-};
-
-const merged = merge( common, nodeRecommended, config );
-
-module.exports = merged;
-
+} );

package/src/react.js

@@ -1,7 +1,8 @@
 "use strict";
+const defineConfig = require( "eslint/config" ).defineConfig; // eslint-disable-line n/no-unpublished-require
 
-module.exports = {
-	name: "reverentgeek-react",
+module.exports = defineConfig( {
+	name: "react",
 	languageOptions: {
 		parserOptions: {
 			ecmaFeatures: {
@@ -9,5 +10,4 @@ module.exports = {
 			}
 		}
 	}
-};
-
+} );

package/test/blog.test.js

@@ -16,4 +16,4 @@ describe( "blog config", () => {
 	} );
 
 	testHasPlugins( blogConfig, [ "@stylistic" ] );
-} );
+} );

package/test/browser.test.js

@@ -17,4 +17,4 @@ describe( "browser config", () => {
 		assert.ok( Object.prototype.hasOwnProperty.call( browserConfig.languageOptions.globals, "document" ), "Should have document global" );
 		assert.ok( Object.prototype.hasOwnProperty.call( browserConfig.languageOptions.globals, "console" ), "Should have console global" );
 	} );
-} );
+} );

package/test/common.test.js

@@ -11,4 +11,4 @@ describe( "common config", () => {
 	testHasRules( commonConfig, [ "@stylistic/indent", "@stylistic/quotes", "@stylistic/semi", "@stylistic/brace-style" ] );
 
 	testHasPlugins( commonConfig, [ "@stylistic" ] );
-} );
+} );

package/test/esm.test.js

@@ -15,4 +15,4 @@ describe( "esm config", () => {
 		assert.ok( esmConfig.languageOptions, "Should have languageOptions" );
 		assert.strictEqual( esmConfig.languageOptions.ecmaVersion, "latest", "Should use latest ecmaVersion" );
 	} );
-} );
+} );

package/test/index.test.js

@@ -4,7 +4,7 @@ const { test, describe } = require( "node:test" );
 const assert = require( "node:assert" );
 const pkg = require( "../package.json" );
 const configModule = require( "../src/index.js" );
-const { expectedNames } = require( "./test-helpers.js" );
+const { expectedNames, getConfig } = require( "./test-helpers.js" );
 
 describe( "eslint-config-reverentgeek", () => {
 	test( "should export meta information", () => {
@@ -54,7 +54,7 @@ describe( "eslint-config-reverentgeek", () => {
 
 		test( "all configs should have correct names", () => {
 			for ( const [ configName, expectedName ] of Object.entries( expectedNames ) ) {
-				const config = configModule.configs[configName];
+				const config = getConfig( configName );
 				assert.ok( config.name, `${ configName } config should have a name property` );
 				assert.strictEqual( typeof config.name, "string", `${ configName } config name should be a string` );
 				assert.strictEqual( config.name, expectedName, `${ configName } config should have correct name` );
@@ -71,4 +71,4 @@ describe( "eslint-config-reverentgeek", () => {
 			}
 		} );
 	} );
-} );
+} );

package/test/node-esm.test.js

@@ -9,4 +9,4 @@ describe( "node-esm config", () => {
 	testBasicConfigStructure( "node-esm", nodeEsmConfig );
 
 	testLanguageOptions( nodeEsmConfig, "module" );
-} );
+} );

package/test/node.test.js

@@ -13,4 +13,4 @@ describe( "node config", () => {
 	testHasRules( nodeConfig, [ "strict", "n/exports-style" ] );
 
 	testHasPlugins( nodeConfig, [ "n" ] );
-} );
+} );

package/test/react.test.js

@@ -15,4 +15,4 @@ describe( "react config", () => {
 		assert.ok( reactConfig.languageOptions.parserOptions.ecmaFeatures, "Should have ecmaFeatures" );
 		assert.ok( reactConfig.languageOptions.parserOptions.ecmaFeatures.jsx, "Should support JSX" );
 	} );
-} );
+} );

package/test/test-helpers.js

@@ -6,13 +6,13 @@ const configModule = require( "../src/index.js" );
 
 // Expected names for all configs
 const expectedNames = {
-	common: "reverentgeek-common",
-	blog: "reverentgeek-blog",
-	browser: "reverentgeek-browser",
-	node: "reverentgeek-node-commonjs",
-	"node-esm": "reverentgeek-node-esm",
-	esm: "reverentgeek-esm",
-	react: "reverentgeek-react"
+	common: "common",
+	blog: "blog",
+	browser: "browser",
+	node: "node-commonjs",
+	"node-esm": "node-esm",
+	esm: "esm",
+	react: "react"
 };
 
 /**
@@ -89,9 +89,50 @@ function testLanguageOptions( config, expectedSourceType, hasGlobals = false ) {
 
 /**
  * Get a config from the main module
+ * Since configs are now arrays due to defineConfig, we need to handle them properly
  */
 function getConfig( configName ) {
-	return configModule.configs[configName];
+	const configArray = configModule.configs[configName];
+
+	// If it's an array (which it should be with defineConfig), we need to get the effective config
+	if ( Array.isArray( configArray ) ) {
+		// For testing purposes, we'll merge all configs in the array to get the effective configuration
+		// This simulates what ESLint would do when processing the config
+		const merged = {
+			name: null,
+			plugins: {},
+			rules: {},
+			languageOptions: {}
+		};
+
+		configArray.forEach( ( config ) => {
+			if ( config.name ) {
+				merged.name = config.name;
+			}
+			if ( config.plugins ) {
+				Object.assign( merged.plugins, config.plugins );
+			}
+			if ( config.rules ) {
+				Object.assign( merged.rules, config.rules );
+			}
+			if ( config.languageOptions ) {
+				Object.assign( merged.languageOptions, config.languageOptions );
+			}
+		} );
+
+		// Clean up empty objects
+		if ( Object.keys( merged.plugins ).length === 0 ) {
+			delete merged.plugins;
+		}
+		if ( Object.keys( merged.languageOptions ).length === 0 ) {
+			delete merged.languageOptions;
+		}
+
+		return merged;
+	}
+
+	// Fallback for non-array configs (shouldn't happen with defineConfig)
+	return configArray;
 }
 
 module.exports = {
@@ -102,4 +143,4 @@ module.exports = {
 	testHasPlugins,
 	testLanguageOptions,
 	getConfig
-};
+};