eslint-config-reverentgeek 5.5.3 → 6.0.0

package/README.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD010 -->
 # eslint-config-reverentgeek
 
 This package is [ReverentGeek's](https://twitter.com/reverentgeek) preferred configuration settings for [eslint](https://eslint.org/).
@@ -6,9 +7,9 @@ This package is [ReverentGeek's](https://twitter.com/reverentgeek) preferred con
 
 1. Install dependencies.
 
-```sh
-npm install --save-dev eslint eslint-config-reverentgeek
-```
+	```sh
+	npm install --save-dev eslint eslint-config-reverentgeek
+	```
 
 2. Create an `eslint.config.js` file.
 3. Add the following to the config file.
@@ -18,7 +19,7 @@ npm install --save-dev eslint eslint-config-reverentgeek
 
 const rgConfig = require( "eslint-config-reverentgeek" );
 module.exports = [
-	...rgConfig.configs.common,
+	rgConfig.configs.common,
 	{
 		rules: {
 		}
@@ -28,52 +29,48 @@ module.exports = [
 
 ## Alternative Configs
 
-The _blog_ config changes the code style to two-spaced indentions, which is better for copying code samples to blog posts.
+The _node-esm_ config adds specific support for Node.js and ES modules (`import`/`export`).
 
 ```js
-"use strict";
+import rg from "eslint-config-reverentgeek";
 
-const rgConfig = require( "eslint-config-reverentgeek" );
-module.exports = [
-	...rgConfig.configs.browser,
-	...rgConfig.configs.blog,
+export default [
+	rg.configs["node-esm"],
 	{
 		rules: {
+			"n/no-unpublished-import": [ "error", { allowModules: [ "eslint-config-reverentgeek" ] } ]
 		}
 	}
 ];
 ```
 
-The _node_ config adds specific support for Node.js and CommonJS modules.
+The _blog_ config changes the code style to two-spaced indentions, which is better for copying code samples to blog posts.
 
 ```js
 "use strict";
 
 const rgConfig = require( "eslint-config-reverentgeek" );
 module.exports = [
-	...rgConfig.configs.node,
+	rgConfig.configs.browser,
+	rgConfig.configs.blog,
 	{
 		rules: {
-			"n/no-unpublished-require": [ "error", {
-				allowModules: [ "eslint-config-reverentgeek" ]
-			} ]
 		}
 	}
 ];
 ```
 
-The _node-esm_ config adds specific support for Node.js and ES modules (`import`/`export`).
+The _node_ config adds specific support for Node.js and CommonJS modules.
 
 ```js
-import rg from "eslint-config-reverentgeek";
+"use strict";
 
-export default [
-	...rg.configs[ "node-esm" ],
+const rgConfig = require( "eslint-config-reverentgeek" );
+module.exports = [
+	rgConfig.configs.node,
 	{
 		rules: {
-			"n/no-unpublished-import": [ "error", {
-				allowModules: [ "eslint-config-reverentgeek" ]
-			} ]
+			"n/no-unpublished-require": [ "error", { allowModules: [ "eslint-config-reverentgeek" ] } ]
 		}
 	}
 ];
@@ -90,16 +87,14 @@ import rg from "eslint-config-reverentgeek";
 import react from "eslint-plugin-react";
 
 export default [
-	...rg.configs.browser,
-	...rg.configs.react,
+	rg.configs.browser,
+	rg.configs.react,
 	{
 		plugins: {
 			react,
 		},
 		rules: {
-			"n/no-unpublished-import": [ "error", {
-				allowModules: [ "eslint-config-reverentgeek" ]
-			} ]
+			"n/no-unpublished-import": [ "error", { allowModules: [ "eslint-config-reverentgeek" ] } ]
 		}
 	}
 ];
@@ -112,7 +107,7 @@ The _browser_ config sets the `browser` environment and adds ES module support.
 
 const rgConfig = require( "eslint-config-reverentgeek" );
 module.exports = [
-	...rgConfig.configs.browser,
+	rgConfig.configs.browser,
 	{
 		rules: {
 		}
@@ -124,16 +119,16 @@ module.exports = [
 
 1. Install dependencies.
 
-```sh
-npm install --save-dev eslint@8 eslint-config-reverentgeek@4
-```
+	```sh
+	npm install --save-dev eslint@8 eslint-config-reverentgeek@4
+	```
 
 2. Create an `.eslintrc.js` file.
 3. Add the following to the config file.
 
 ```js
 module.exports = {
-	extends: [ "reverentgeek" ]
+ extends: [ "reverentgeek" ]
 };
 ```
 
@@ -143,7 +138,7 @@ The _blog_ rule set changes to code style to two-spaced indentions, which is bet
 
 ```js
 module.exports = {
-	extends: [ "reverentgeek/blog" ]
+ extends: [ "reverentgeek/blog" ]
 };
 ```
 
@@ -153,7 +148,7 @@ The _node_ rule set adds specific support for Node.js and CommonJS modules.
 "use strict";
 
 module.exports = {
-	extends: [ "reverentgeek/node" ]
+ extends: [ "reverentgeek/node" ]
 };
 ```
 
@@ -163,7 +158,7 @@ The _node/module_ rule set adds specific support for Node.js and ES modules (`im
 "use strict";
 
 module.exports = {
-	extends: [ "reverentgeek/node/module" ]
+ extends: [ "reverentgeek/node/module" ]
 };
 ```
 
@@ -171,6 +166,6 @@ The _browser_ rule set the `browser` environment and adds ES module support.
 
 ```js
 module.exports = {
-	extends: [ "reverentgeek/browser" ]
+ extends: [ "reverentgeek/browser" ]
 };
 ```

package/blog.js

@@ -1,7 +1,7 @@
 "use strict";
 const styles = require( "@stylistic/eslint-plugin" );
 
-module.exports = [ {
+module.exports = {
 	plugins: {
 		"@stylistic": styles
 	},
@@ -9,4 +9,5 @@ module.exports = [ {
 		"no-console": [ "off" ],
 		"@stylistic/indent": [ "error", 2 ]
 	}
-} ];
+};
+

package/browser.js

@@ -1,16 +1,17 @@
 "use strict";
 const globals = require( "globals" );
 const common = require( "./common" );
+const { merge } = require( "./utils" );
 
-module.exports = [
-	...common,
-	{
-		languageOptions: {
-			ecmaVersion: "latest",
-			sourceType: "module",
-			globals: globals.browser
-		},
-		rules: {
-		}
+const config = {
+	languageOptions: {
+		ecmaVersion: "latest",
+		sourceType: "module",
+		globals: globals.browser
+	},
+	rules: {
 	}
-];
+};
+
+module.exports = merge( common, config );
+

package/common.js

@@ -2,29 +2,31 @@
 
 const eslint = require( "@eslint/js" );
 const styles = require( "@stylistic/eslint-plugin" );
+const { merge } = require( "./utils" );
 
-module.exports = [
-	eslint.configs.recommended,
-	{
-		plugins: {
-			"@stylistic": styles
-		},
-		rules: {
-			"no-console": [ "off" ],
-			"no-var": [ "error" ],
-			"@stylistic/array-bracket-spacing": [ "error", "always", { singleValue: true } ],
-			"@stylistic/comma-spacing": [ "error", { before: false, after: true } ],
-			"@stylistic/eol-last": [ "error", "always" ],
-			"@stylistic/indent": [ "error", "tab" ],
-			"@stylistic/linebreak-style": [ "error", "unix" ],
-			"@stylistic/no-multiple-empty-lines": [ "error", { max: 1 } ],
-			"@stylistic/no-trailing-spaces": [ "error", { skipBlankLines: false, ignoreComments: false } ],
-			"@stylistic/object-curly-spacing": [ "error", "always" ],
-			"@stylistic/quote-props": [ "error", "as-needed" ],
-			"@stylistic/quotes": [ "error", "double" ],
-			"@stylistic/semi": [ "error", "always" ],
-			"@stylistic/space-in-parens": [ "error", "always" ],
-			"@stylistic/template-curly-spacing": [ "error", "always" ]
-		}
+const config = {
+	name: "reverentgeek-common",
+	rules: {
+		"no-console": [ "off" ],
+		"no-var": [ "error" ],
+		"@stylistic/array-bracket-spacing": [ "error", "always", { singleValue: true } ],
+		"@stylistic/comma-dangle": [ "error", "never" ],
+		"@stylistic/comma-spacing": [ "error", { before: false, after: true } ],
+		"@stylistic/eol-last": [ "error", "always" ],
+		"@stylistic/indent": [ "error", "tab" ],
+		"@stylistic/linebreak-style": [ "error", "unix" ],
+		"@stylistic/no-multiple-empty-lines": [ "error", { max: 1 } ],
+		"@stylistic/no-tabs": [ "error", { allowIndentationTabs: true } ],
+		"@stylistic/no-trailing-spaces": [ "error", { skipBlankLines: false, ignoreComments: false } ],
+		"@stylistic/object-curly-spacing": [ "error", "always" ],
+		"@stylistic/quote-props": [ "error", "as-needed" ],
+		"@stylistic/quotes": [ "error", "double" ],
+		"@stylistic/semi": [ "error", "always" ],
+		"@stylistic/space-in-parens": [ "error", "always" ],
+		"@stylistic/template-curly-spacing": [ "error", "always" ]
 	}
-];
+};
+
+const merged = merge( eslint.configs.recommended, styles.configs.recommended, config );
+
+module.exports = merged;

package/eslint.config.js

@@ -1,16 +1,16 @@
 "use strict";
 const node = require( "./node" );
 
-module.exports = [
-	...node,
-	{
-		rules: {
-			"n/no-unpublished-require": [ "error", {
-				allowModules: [ "globals", "eslint-plugin-n", "@stylistic/eslint-plugin" ]
-			} ],
-			"n/no-extraneous-require": [ "error", {
-				allowModules: [ "@eslint/js" ]
-			} ]
-		}
+const config = {
+	rules: {
+		"n/no-unpublished-require": [ "error", {
+			allowModules: [ "globals", "eslint-plugin-n", "@stylistic/eslint-plugin" ]
+		} ],
+		"n/no-extraneous-require": [ "error", {
+			allowModules: [ "@eslint/js" ]
+		} ]
 	}
-];
+};
+
+module.exports = [ node, config ];
+

package/esm.js

@@ -1,10 +1,9 @@
 "use strict";
 
-module.exports = [
-	{
-		languageOptions: {
-			ecmaVersion: "latest",
-			sourceType: "module"
-		}
+module.exports = {
+	languageOptions: {
+		ecmaVersion: "latest",
+		sourceType: "module"
 	}
-];
+};
+

package/node-esm.js

@@ -2,16 +2,18 @@
 const common = require( "./common" );
 const nodePlugin = require( "eslint-plugin-n" );
 const nodeRecommended = nodePlugin.configs["flat/recommended-module"];
+const { merge } = require( "./utils" );
 
-module.exports = [
-	...common,
-	nodeRecommended,
-	{
-		languageOptions: {
-			sourceType: "module"
-		},
-		rules: {
-			"n/exports-style": [ "error" ]
-		}
+const config = {
+	name: "reverentgeek-node-esm",
+	languageOptions: {
+		sourceType: "module"
+	},
+	rules: {
+		"n/exports-style": [ "error" ]
 	}
-];
+};
+const merged = merge( common, nodeRecommended, config );
+
+module.exports = merged;
+

package/node.js

@@ -1,18 +1,22 @@
+
 "use strict";
 const common = require( "./common" );
 const nodePlugin = require( "eslint-plugin-n" );
-const nodeRecommended = nodePlugin.configs["flat/recommended"];
+const nodeRecommended = nodePlugin.configs["flat/recommended-script"];
+const { merge } = require( "./utils" );
 
-module.exports = [
-	...common,
-	nodeRecommended,
-	{
-		languageOptions: {
-			sourceType: "commonjs"
-		},
-		rules: {
-			strict: [ "error", "global" ],
-			"n/exports-style": [ "error" ]
-		}
+const config = {
+	name: "reverentgeek-node-commonjs",
+	languageOptions: {
+		sourceType: "commonjs"
+	},
+	rules: {
+		strict: [ "error", "global" ],
+		"n/exports-style": [ "error" ]
 	}
-];
+};
+
+const merged = merge( common, nodeRecommended, config );
+
+module.exports = merged;
+

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-config-reverentgeek",
-	"version": "5.5.3",
+	"version": "6.0.0",
 	"description": "ESLint rules that ReverentGeek likes :)",
 	"main": "index.js",
 	"repository": {
@@ -20,9 +20,10 @@
 	"dependencies": {
 		"@stylistic/eslint-plugin": "^5.2.1",
 		"eslint-plugin-n": "^17.7.0",
-		"globals": "^16.2.0"
+		"globals": "^16.2.0",
+		"mergician": "^2.0.2"
 	},
 	"devDependencies": {
 		"eslint": "^9.34.0"
 	}
-}
+}

package/react.js

@@ -1,12 +1,12 @@
 "use strict";
 
-module.exports = [ {
-	files: [ "**/*.{js,jsx,mjs,cjs,ts,tsx}" ],
+module.exports = {
 	languageOptions: {
 		parserOptions: {
 			ecmaFeatures: {
-				jsx: true,
-			},
-		},
+				jsx: true
+			}
+		}
 	}
-} ];
+};
+

package/utils.js

@@ -0,0 +1,18 @@
+"use strict";
+// merge-configs.js
+// Utility to merge ESLint config objects for name, plugins, languageOptions, and rules
+
+function merge( ...configs ) {
+	const languageOptions = {
+		sourceType: configs.map( cfg => cfg?.languageOptions?.sourceType ).filter( Boolean ).pop(),
+		globals: Object.assign( {}, ...configs.map( cfg => cfg?.languageOptions?.globals || {} ) )
+	};
+	return {
+		name: configs.map( cfg => cfg?.name ).filter( Boolean ).pop(),
+		plugins: Object.assign( {}, ...configs.map( cfg => cfg?.plugins || {} ) ),
+		languageOptions,
+		rules: Object.assign( {}, ...configs.map( cfg => cfg?.rules || {} ) )
+	};
+}
+
+module.exports = { merge };