@lipemat/eslint-config 3.0.2 → 3.1.2

package/helpers/config.js

@@ -0,0 +1,50 @@
+const {getExtensionsConfig} = require( '@lipemat/js-boilerplate/helpers/config' );
+const {getPackageConfig} = require( '@lipemat/js-boilerplate/helpers/package-config' );
+const path = require( 'path' );
+
+
+/**
+ * Get a config from our /index.js merged with any
+ * matching configuration from the project directory.
+ *
+ * For instance if we have a file named config/eslint.config.js in our project
+ * we will merge the contents with our config/eslint.config.js in favor of whatever
+ * is specified with the project's file.
+ *
+ * If the `module.exports` are a function, the existing configuration will be passed
+ * as the only argument. Otherwise, standard `module.exports` are also supported.
+ *
+ * @see @lipemat/js-boilerplate/helpers/config
+ *
+ * @example ```ts
+ * // standard
+ * module.export = {
+ *     externals: {extra: 'Extra'}
+ * }
+ * // function
+ * module.exports = function( config ) {
+ *     return {
+ *         externals: {...config.externals, extra: 'Extra'}
+ *     }
+ * }
+ * ```
+ *
+ * @return {Object}
+ */
+function getConfig( mergedConfig ) {
+	mergedConfig = {...mergedConfig, ...getExtensionsConfig( 'eslint.config', mergedConfig )};
+	try {
+		const localConfig = require( path.resolve( getPackageConfig().packageDirectory + '/config', 'eslint.config' ) );
+		if ( 'function' === typeof localConfig ) {
+			mergedConfig = {...mergedConfig, ...localConfig( mergedConfig )};
+		} else {
+			mergedConfig = {...mergedConfig, ...localConfig};
+		}
+	} catch ( e ) {
+	}
+	return mergedConfig;
+}
+
+module.exports = {
+	getConfig,
+}

package/index.js

@@ -1,4 +1,10 @@
-module.exports = {
+const {getConfig} = require( './helpers/config' );
+
+/**
+ * Default config if no extensions override it.
+ *
+ */
+let mergedConfig  =  {
 	"env": {
 		"browser": true
 	},
@@ -90,9 +96,21 @@ module.exports = {
 		'template-curly-spacing': [ 1, 'never' ],
 		'yoda': [ 2, 'always', {'onlyEquality': true} ],
 	},
+	'root': true,
 	'settings': {
 		'react': {
 			'version': '18.0',
 		},
 	},
 };
+
+/**
+ * Merge in any extensions' config.
+ */
+try {
+	mergedConfig = getConfig( mergedConfig );
+} catch( e ) {
+	// JS Boilerplate is not installed.
+}
+
+module.exports = mergedConfig;

package/package.json

@@ -1,25 +1,41 @@
 {
   "name": "@lipemat/eslint-config",
-  "version": "3.0.2",
+  "version": "3.1.2",
+  "license": "MIT",
   "description": "Eslint configuration for all @lipemat packages",
   "engines": {
-    "node": ">=13.0.0"
+    "node": ">=16.14.2"
   },
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "helpers/"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/lipemat/eslint-config.git"
   },
-  "author": "lipemat <mat@matlipe.com>",
-  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/lipemat/eslint-config/issues"
+  },
+  "homepage": "https://github.com/lipemat/eslint-config#readme",
+  "scripts": {
+    "test": "lipemat-js-boilerplate test"
+  },
   "dependencies": {
     "@wordpress/eslint-plugin": "^12.2.0",
-    "eslint": "^8.8.0"
+    "eslint": "^8"
+  },
+  "devDependencies": {
+    "@lipemat/js-boilerplate": "^10.3.1",
+    "@lipemat/js-boilerplate-svelte": "^0.0.4",
+    "@types/jest": "^29.5.3",
+    "@types/node": "^16",
+    "jest": "^29",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "@lipemat/js-boilerplate": "^10.3.1"
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "packageManager": "yarn@3.6.1"
 }