@jsenv/eslint-config-relax 1.1.1 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/eslint-config-relax",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "A pleaseant ESLint configuration for any project",
   "license": "MIT",
   "author": {
@@ -33,6 +33,7 @@
     "@babel/eslint-parser": "7.25.1",
     "globals": "15.9.0",
     "@jsenv/eslint-import-resolver": "8.2.0",
+    "@jsenv/urls": "2.5.2",
     "eslint-plugin-import-x": "3.1.0",
     "eslint-plugin-html": "8.1.1",
     "eslint-plugin-react": "7.35.0",

package/readme.md

@@ -1,3 +1,36 @@
 # eslint-config-relax
 
 [![npm package](https://img.shields.io/npm/v/@jsenv/eslint-config-relax.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/eslint-config-relax)
+
+Two things:
+
+1. ESLint should bother me only for important things
+2. Share ESLint configuration for different types of project
+
+## Usage
+
+```console
+npm i --save-dev @jsenv/eslint-config-relax
+```
+
+**eslint.config.js**
+
+```js
+import { eslintConfigRelax } from "@jsenv/eslint-config-relax";
+
+export default eslintConfigRelax({
+  rootDirectoryUrl: new URL("./", import.meta.url),
+  browserDirectoryUrl: new URL("./src/", import.meta.url), // optional
+});
+```
+
+## Best parts
+
+- No need to configure ESLint; it is hard to do correctly
+- Freedom in the code; rules coercing you to code in a certain way are disabled
+- Import resolution works; The whole node esm resolution algorith is implemented
+
+## To know
+
+- No support for TypeScript (it's planned)
+- Not compatible with ESLint < 8

package/src/eslint_config_relax.js

@@ -1,4 +1,5 @@
 import babelParser from "@babel/eslint-parser";
+import { urlToRelativeUrl } from "@jsenv/urls";
 import html from "eslint-plugin-html";
 import pluginImportX from "eslint-plugin-import-x";
 import reactPlugin from "eslint-plugin-react";
@@ -18,9 +19,18 @@ const patternForEachExtension = (pattern, extensions) => {
   );
 };
 
+/**
+ * Return an ESLint flat config
+ * @param {Object} parameters
+ * @param {string|url} parameters.rootDirectoryUrl
+ *        Directory containing the eslint config file and likely your package.json
+ * @param {string|url} [parameters.webDirectoryUrl]
+ *        Directory leading to files that will be executed by a web browser
+ * @return {Array} Array of ESLint config objects
+ */
 export const eslintConfigRelax = ({
   rootDirectoryUrl,
-  type = "browser",
+  browserDirectoryUrl,
   prettier,
   prettierSortImport,
   jsxPragmaAuto = false,
@@ -52,15 +62,17 @@ export const eslintConfigRelax = ({
     }
   }
 
-  const isBrowser = type === "browser";
   const browserExtensions = [".js", ".jsx"];
   browserFiles = [
     "**/*.html",
     ...patternForEachExtension("**/client/**/*[extension]", browserExtensions),
     ...patternForEachExtension("**/www/**/*[extension]", browserExtensions),
     ...patternForEachExtension("**/browser/**/*[extension]", browserExtensions),
-    ...(isBrowser
-      ? patternForEachExtension("src/**/*[extension]", browserExtensions)
+    ...(browserDirectoryUrl
+      ? patternForEachExtension(
+          `${urlToRelativeUrl(browserDirectoryUrl, rootDirectoryUrl)}/**/*[extension]`,
+          browserExtensions,
+        )
       : []),
     ...browserFiles,
   ];
@@ -191,11 +203,7 @@ export const eslintConfigRelax = ({
       settings: {
         "import-x/resolver": {
           "@jsenv/eslint-import-resolver": {
-            rootDirectoryUrl: String(
-              isBrowser
-                ? new URL("./src/", rootDirectoryUrl)
-                : rootDirectoryUrl,
-            ),
+            rootDirectoryUrl: browserDirectoryUrl || rootDirectoryUrl,
             packageConditions: ["browser", "import"],
             logLevel: importResolutionLogLevel,
           },

package/src/rules_relax.js

@@ -162,7 +162,8 @@ export const rulesRelax = {
   "no-multi-str": ["error"],
   "no-multiple-empty-lines": ["off", { max: 1 }],
   "no-native-reassign": ["error"],
-  "no-negated-condition": ["error"],
+  // theorically great but too often a pain, does not fix the relax mindset
+  "no-negated-condition": ["off"],
   // disabled because deprecated in favor of no-unsafe-negation
   // https://eslint.org/docs/rules/no-negated-in-lhs
   "no-negated-in-lhs": ["off"],