minor #10 Add src/index.js tests using Webpack to resolve Stimulus for node (tgalopin)

This PR was merged into the main branch.

Discussion
----------

Add src/index.js tests using Webpack to resolve Stimulus for node

Commits
-------

b02695b Add src/index.js tests using Webpack to resolve Stimulus for node

Author: tgalopin

dist/webpack/create-controllers-module.js

@@ -9,7 +9,7 @@
 'use strict';
 
 module.exports = function createControllersVirtualModule(config) {
-  var file = 'module.exports = {';
+  var file = 'export default {';
 
   if ('undefined' === typeof config['controllers']) {
     throw new Error('Your Stimulus configuration file (assets/controllers.json) lacks a "controllers" key.');

package.json

@@ -10,7 +10,7 @@
     },
     "scripts": {
         "build": "babel src -d dist",
-        "test": "babel src -d dist && jest"
+        "test": "webpack --config test/webpack.config.js && jest"
     },
     "peerDependencies": {
         "stimulus": "^2.0"
@@ -24,9 +24,12 @@
         "@babel/core": "^7.12.3",
         "@babel/plugin-proposal-class-properties": "^7.12.1",
         "@babel/preset-env": "^7.12.7",
+        "@symfony/controllers": "file:test/fixtures/controllers",
         "@symfony/mock-module": "file:test/fixtures/module",
         "@symfony/stimulus-testing": "^1.0.0",
-        "stimulus": "^2.0"
+        "stimulus": "^2.0",
+        "webpack": "^5.11.1",
+        "webpack-cli": "^4.3.0"
     },
     "jest": {
         "testRegex": "test/.*\\.test.js",

src/index.js

@@ -15,7 +15,10 @@ import symfonyControllers from '@symfony/controllers';
 
 export function startStimulusApp(context) {
     const application = Application.start();
-    application.load(definitionsFromContext(context));
+
+    if (context) {
+        application.load(definitionsFromContext(context));
+    }
 
     for (let controllerName in symfonyControllers) {
         if (!symfonyControllers.hasOwnProperty(controllerName)) {

test/dist/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

test/fixtures/controllers/index.js

@@ -0,0 +1,3 @@
+export default {
+    '@symfony/mock-module/mock-controller': import('@symfony/mock-module/dist/controller.js'),
+};

test/fixtures/controllers/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@symfony/controllers",
+    "version": "1.0.0",
+    "main": "./index.js"
+}

test/fixtures/module/dist/controller.js

@@ -1,3 +1,16 @@
-module.exports = class {
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+import { Controller } from 'stimulus';
+
+export default class extends Controller {
     connect() {}
-};
+}

test/fixtures/module/dist/style.css

@@ -1,6 +1,5 @@
 {
     "name": "@symfony/mock-module",
-    "license": "MIT",
     "version": "1.0.0",
     "symfony": {
         "controllers": {

test/fixtures/module/package.json

@@ -0,0 +1,24 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const startStimulusApp = require('./dist/index').startStimulusApp;
+
+describe('startStimulusApp', () => {
+    it('must start the app', async () => {
+        const app = startStimulusApp();
+
+        // Wait for controllers to be loaded
+        await new Promise(setImmediate);
+
+        expect(app.router.modules.length).toBe(1);
+        expect(app.router.modules[0].definition.identifier).toBe('@symfony/mock-module/mock-controller');
+    });
+});

test/index.test.js

@@ -0,0 +1,29 @@
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+/**
+ * Webpack config used to build src/index.js with Stimulus embedded
+ * to allow testing in node.
+ */
+
+const path = require('path');
+
+module.exports = {
+    target: 'node',
+    mode: 'development',
+    devtool: 'source-map',
+    entry: './src/index.js',
+    output: {
+        filename: 'index.js',
+        path: path.resolve(__dirname, 'dist'),
+        libraryTarget: 'commonjs2'
+    },
+};