@jsenv/eslint-config-relax 1.7.6 → 1.7.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/eslint-config-relax",
-  "version": "1.7.6",
+  "version": "1.7.8",
   "description": "A pleaseant ESLint configuration for any project",
   "repository": {
     "type": "git",

package/src/eslint_config_relax.js

@@ -24,13 +24,49 @@ 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
+ * Creates a comprehensive ESLint flat configuration with relaxed rules and automatic detection
+ * of project settings. Supports React/Preact, Prettier integration, browser/Node.js environments,
+ * and smart defaults based on your package.json dependencies.
+ *
+ * @param {Object} parameters - Configuration options
+ * @param {string|URL} parameters.rootDirectoryUrl - Directory containing the eslint config file and likely your package.json
+ * @param {string|URL} [parameters.browserDirectoryUrl] - Directory containing files that will be executed by a web browser (formerly webDirectoryUrl)
+ * @param {boolean} [parameters.prettier] - Enable Prettier integration. Auto-detected from package.json if not specified
+ * @param {boolean} [parameters.prettierSortImport] - Enable prettier-plugin-organize-imports integration. Auto-detected if not specified
+ * @param {boolean} [parameters.jsxPragmaAuto=false] - Disable react/react-in-jsx-scope rule for automatic JSX pragma
+ * @param {boolean} [parameters.preact] - Enable Preact-specific settings. Auto-detected from package.json if not specified
+ * @param {string} [parameters.reactVersion="detect"] - React version for eslint-plugin-react. Defaults to auto-detection
+ * @param {string} [parameters.reactVersionForPreact="19.2.0"] - React version to use when preact is detected
+ * @param {string} [parameters.importResolutionLogLevel] - Log level for import resolution debugging
+ * @param {string[]} [parameters.importResolutionDevConditions=[]] - Additional package.json conditions for import resolution in development
+ * @param {string[]} [parameters.browserFiles=[]] - Additional glob patterns for files that should use browser environment. Extends default patterns
+ * @param {string[]} [parameters.browserAndNodeFiles=[]] - Glob patterns for files that run in both browser and Node.js environments
+ *
+ * @returns {Array<Object>} Array of ESLint flat config objects configured with:
+ *   - Relaxed rules optimized for development productivity
+ *   - Automatic browser/Node.js environment detection
+ *   - React/Preact JSX support with proper settings
+ *   - Import resolution with package.json conditions
+ *   - HTML file linting support
+ *   - Prettier integration when detected
+ *   - Smart ignores for common directories
+ *
+ * @example
+ * // Basic usage with auto-detection
+ * import { eslintConfigRelax } from "@jsenv/eslint-config-relax";
+ * export default eslintConfigRelax({
+ *   rootDirectoryUrl: import.meta.url
+ * });
+ *
+ * @example
+ * // With custom browser directory and explicit settings
+ * export default eslintConfigRelax({
+ *   rootDirectoryUrl: import.meta.url,
+ *   browserDirectoryUrl: new URL("./src/client/", import.meta.url),
+ *   prettier: true,
+ *   preact: true,
+ *   browserFiles: ["src/frontend/**"]
+ * });
  */
 export const eslintConfigRelax = ({
   rootDirectoryUrl,
@@ -41,6 +77,7 @@ export const eslintConfigRelax = ({
   preact,
   reactVersion = "detect",
   reactVersionForPreact = "19.2.0",
+  importResolutionBrowserRootDirectoryUrl,
   importResolutionLogLevel,
   importResolutionDevConditions = [],
 
@@ -76,19 +113,29 @@ export const eslintConfigRelax = ({
   }
 
   const browserExtensions = [".js", ".jsx"];
-  browserFiles = [
+  const defaultBrowserFiles = [
     "**/*.html",
     ...patternForEachExtension("**/client/**/*[extension]", browserExtensions),
     ...patternForEachExtension("**/www/**/*[extension]", browserExtensions),
     ...patternForEachExtension("**/browser/**/*[extension]", browserExtensions),
-    ...(browserDirectoryUrl
-      ? patternForEachExtension(
-          `${urlToRelativeUrl(browserDirectoryUrl, rootDirectoryUrl)}/**/*[extension]`,
-          browserExtensions,
-        )
-      : []),
-    ...browserFiles,
   ];
+  if (browserDirectoryUrl) {
+    let browserDirectoryUrlString = String(browserDirectoryUrl);
+    if (!browserDirectoryUrlString.endsWith("/")) {
+      browserDirectoryUrlString += "/";
+    }
+    const relativeBrowserDir = urlToRelativeUrl(
+      browserDirectoryUrl,
+      rootDirectoryUrl,
+    );
+    defaultBrowserFiles.push(
+      ...patternForEachExtension(
+        `${relativeBrowserDir}**/*[extension]`,
+        browserExtensions,
+      ),
+    );
+  }
+  browserFiles = [...defaultBrowserFiles, ...browserFiles];
   browserAndNodeFiles = [...browserAndNodeFiles];
   const parserOptions = {
     ecmaVersion: 2022,
@@ -274,7 +321,10 @@ export const eslintConfigRelax = ({
       settings: {
         "import-x/resolver": {
           "@jsenv/eslint-import-resolver": {
-            rootDirectoryUrl: browserDirectoryUrl || rootDirectoryUrl,
+            rootDirectoryUrl:
+              importResolutionBrowserRootDirectoryUrl ||
+              browserDirectoryUrl ||
+              rootDirectoryUrl,
             packageConditions: [
               "browser",
               "development",