feature #111 Add support for loader-utils@^3.0.0 and schema-utils@^4.0.0, close #102 (Kocal)

This PR was squashed before being merged into the main branch.

Discussion
----------

Add support for `loader-utils@^3.0.0` and `schema-utils@^4.0.0`, close #102

Commits
-------

08fb52c Add support for `loader-utils@^3.0.0` and `schema-utils@^4.0.0`, close #102

Author: Kocal

CHANGELOG.md

@@ -11,6 +11,7 @@
 
 * Thus having no effects on the `dist/` files, TypeScript `module` is now set to `ESNext`, `moduleResolution` to `NodeNext`, and `target` to `ES2021` by @Kocal in https://github.com/symfony/stimulus-bridge/pull/99
 * Upgrade minimum supported `acorn` version to 8.2.0 by @Kocal in https://github.com/symfony/stimulus-bridge/pull/110
+* Add support for `loader-utils@^3.0.0` and `schema-utils@^4.0.0` by @Kocal in https://github.com/symfony/stimulus-bridge/pull/111
 
 ### Internal
 

biome.json

@@ -2,7 +2,14 @@
     "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
     "files": {
         "include": ["*.js", "src/**/*.[jt]s", "test/**/*.[jt]s"],
-        "ignore": ["**/package.json", "**/node_modules", "dist/**", "test/dist/**", "test/fixtures/**/dist/**"]
+        "ignore": [
+            "**/package.json",
+            "**/node_modules",
+            "dist/**",
+            "test/dist/**",
+            "test/fixtures/**/dist/**",
+            "test/parseQuery.ts"
+        ]
     },
     "formatter": {
         "lineWidth": 120,

dist/webpack/lazy-controller-loader.js

@@ -5297,12 +5297,17 @@ const schema = {
 		export: { type: "string" }
 	}
 };
+function getLoaderOptions(loaderContext) {
+	if (Object.prototype.hasOwnProperty.call(loaderContext, "getOptions")) return loaderContext.getOptions();
+	if (Object.prototype.hasOwnProperty.call(loader_utils, "getOptions")) return loader_utils.getOptions(loaderContext);
+	throw new Error("Unable to get loader options, please upgrade to \"webpack@^5\" or downgrade to \"loader-utils@^2\".");
+}
 function lazy_controller_loader_default(source, sourceMap) {
 	const { options, errors } = get_stimulus_comment_options_default(source);
 	for (const error of errors) this.emitError(new Error(`Invalid comment found:\n\n    "/* ${error.comment.value.trim()} */".\n\nCheck your syntax.`));
 	const stimulusFetch = typeof options.stimulusFetch !== "undefined" ? options.stimulusFetch : "eager";
 	if (!["eager", "lazy"].includes(stimulusFetch)) this.emitError(new Error(`Invalid value "${stimulusFetch}" found for "stimulusFetch". Allowed values are "lazy" or "eager"`));
-	const loaderOptions = loader_utils.getOptions(this);
+	const loaderOptions = getLoaderOptions(this);
 	schema_utils.validate(schema, loaderOptions, {
 		name: "@symfony/stimulus-bridge/lazy-controller-loader",
 		baseDataPath: "options"

package.json

@@ -23,8 +23,8 @@
         "@hotwired/stimulus-webpack-helpers": "^1.0.1",
         "@types/webpack-env": "^1.16.4",
         "acorn": "^8.2.0",
-        "loader-utils": "^2.0.0",
-        "schema-utils": "^3.0.0"
+        "loader-utils": "^2.0.0 || ^3.0.0",
+        "schema-utils": "^3.0.0 || ^4.0.0"
     },
     "devDependencies": {
         "@babel/core": "^7.22.0",

pnpm-lock.yaml

@@ -24,6 +24,20 @@ const schema = {
     },
 };
 
+function getLoaderOptions(loaderContext: any) {
+    // Webpack 5, when using loader-utils ^3.0.0
+    if (Object.prototype.hasOwnProperty.call(loaderContext, 'getOptions')) {
+        return loaderContext.getOptions();
+    }
+
+    // loader-utils ^2.0.0
+    if (Object.prototype.hasOwnProperty.call(loaderUtils, 'getOptions')) {
+        return loaderUtils.getOptions(loaderContext);
+    }
+
+    throw new Error('Unable to get loader options, please upgrade to "webpack@^5" or downgrade to "loader-utils@^2".');
+}
+
 /**
  * Loader that can make a Stimulus controller lazy.
  *
@@ -56,7 +70,7 @@ export default function (source: string, sourceMap: string) {
         );
     }
 
-    const loaderOptions = loaderUtils.getOptions(this);
+    const loaderOptions = getLoaderOptions(this);
 
     schemaUtils.validate(schema, loaderOptions, {
         name: '@symfony/stimulus-bridge/lazy-controller-loader',

src/webpack/lazy-controller-loader.ts

@@ -0,0 +1,67 @@
+// biome-ignore file: d
+// This file is copied from https://github.com/symfony/stimulus-bridge/blob/main/src/webpack/lazy-controller-loader.ts
+// to keep "emulated" call to loader working when using loader-utils@^3.0.0.
+
+import JSON5 from 'json5';
+
+const specialValues = {
+    null: null,
+    true: true,
+    false: false,
+};
+
+export function parseQuery(query) {
+    if (query.substr(0, 1) !== '?') {
+        throw new Error("A valid query string passed to parseQuery should begin with '?'");
+    }
+
+    query = query.substr(1);
+
+    if (!query) {
+        return {};
+    }
+
+    if (query.substr(0, 1) === '{' && query.substr(-1) === '}') {
+        return JSON5.parse(query);
+    }
+
+    const queryArgs = query.split(/[,&]/g);
+    const result = {};
+
+    queryArgs.forEach((arg) => {
+        const idx = arg.indexOf('=');
+
+        if (idx >= 0) {
+            let name = arg.substr(0, idx);
+            let value = decodeURIComponent(arg.substr(idx + 1));
+
+            // eslint-disable-next-line no-prototype-builtins
+            if (specialValues.hasOwnProperty(value)) {
+                value = specialValues[value];
+            }
+
+            if (name.substr(-2) === '[]') {
+                name = decodeURIComponent(name.substr(0, name.length - 2));
+
+                if (!Array.isArray(result[name])) {
+                    result[name] = [];
+                }
+
+                result[name].push(value);
+            } else {
+                name = decodeURIComponent(name);
+                result[name] = value;
+            }
+        } else {
+            if (arg.substr(0, 1) === '-') {
+                result[decodeURIComponent(arg.substr(1))] = false;
+            } else if (arg.substr(0, 1) === '+') {
+                result[decodeURIComponent(arg.substr(1))] = true;
+            } else {
+                result[decodeURIComponent(arg)] = true;
+            }
+        }
+    });
+
+    return result;
+}

test/parseQuery.ts

@@ -7,7 +7,11 @@
  * file that was distributed with this source code.
  */
 
+import * as loaderUtils from 'loader-utils';
 import lazyControllerLoader from '../../src/webpack/lazy-controller-loader';
+import { parseQuery } from '../parseQuery';
+
+const isLoaderUtilsV3 = !Object.prototype.hasOwnProperty.call(loaderUtils, 'getOptions');
 
 function callLoader(src: string, startingSourceMap = '', query = '') {
     const loaderThis = {
@@ -24,6 +28,22 @@ function callLoader(src: string, startingSourceMap = '', query = '') {
         },
     };
 
+    // Re-used from https://github.com/webpack/loader-utils/blob/09128d7a9ae08da110180c31fbec11e195a75220/lib/getOptions.js
+    if (isLoaderUtilsV3) {
+        loaderThis.getOptions = () => {
+            if (typeof query === 'string' && query !== '') {
+                return parseQuery(query);
+            }
+
+            if (!query || typeof query !== 'object') {
+                // Not object-like queries are not supported.
+                return {};
+            }
+
+            return query;
+        };
+    }
+
     lazyControllerLoader.call(loaderThis, src, startingSourceMap);
 
     return {