@eclipse-scout/cli 22.0.41 → 23.1.1

package/bin/scout-scripts.js

@@ -1,13 +1,11 @@
-#!/usr/bin/env node
 /*
- * Copyright (c) 2010-2022 BSI Business Systems Integration AG.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
  *
- * Contributors:
- *     BSI Business Systems Integration AG - initial API and implementation
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 
 // Makes the script crash on unhandled rejections instead of silently
@@ -26,14 +24,26 @@ const argv = process.argv.slice(3);
 const parser = require('yargs-parser');
 const fs = require('fs');
 const path = require('path');
+const scoutBuildConstants = require('./../scripts/constants');
 const webpackConfigFileName = './webpack.config.js';
 const webpackCustomConfigFileName = './webpack.config.custom.js';
+const StatsExtractWebpackPlugin = require('../scripts/StatsExtractWebpackPlugin');
 const webpackYargsOptions = {
   boolean: ['progress', 'profile', 'clean'],
   array: ['resDirArray', 'themes']
 };
+const buildYargsOptions = {
+  array: ['run'],
+  default: {run: []}
+};
 const karmaYargsOptions = prepareWebpackYargsOptionsForKarma();
 
+let buildArgs = parser(argv, buildYargsOptions);
+if (buildArgs.run.length > 1) {
+  runBuilds(buildArgs);
+  return;
+}
+
 switch (script) {
   case 'test-server:start': {
     runKarma(null, false, parser(argv, karmaYargsOptions));
@@ -56,25 +66,30 @@ switch (script) {
     if (args.webpackArgs.progress === undefined) {
       args.webpackArgs.progress = false;
     }
+    if (args.webpackArgs.watch === undefined) {
+      args.webpackArgs.watch = false;
+    }
     runKarma(null, true, args);
     break;
   }
   case 'build:dev': {
     const args = parser(argv, webpackYargsOptions);
-    args.mode = 'development';
+    args.mode = scoutBuildConstants.mode.development;
     runWebpack(args);
     break;
   }
   case 'build:prod': {
     const args = parser(argv, webpackYargsOptions);
-    args.mode = 'production';
+    args.mode = scoutBuildConstants.mode.production;
     runWebpack(args);
     break;
   }
   case 'build:dev:watch': {
     const args = parser(argv, webpackYargsOptions);
-    args.mode = 'development';
-    runWebpackWatch(args);
+    args.mode = scoutBuildConstants.mode.development;
+    args.watch = true;
+    args.clean = true; // prevents errors because of old output folders in the development environment
+    runWebpack(args);
     break;
   }
   default:
@@ -82,6 +97,20 @@ switch (script) {
     break;
 }
 
+function runBuilds(args) {
+  const execSync = require('child_process').execSync;
+  let argStr = '';
+  for (let [key, value] of Object.entries(args)) {
+    if (key !== 'run' && key !== '_') {
+      argStr += `--${key} ${value} `;
+    }
+  }
+  for (let type of args.run) {
+    console.log(`Starting ${type} build` + (argStr ? ` with args ${argStr}` : ''));
+    execSync(`scout-scripts ${script} --run ${type} ${argStr}`, {stdio: 'inherit'});
+  }
+}
+
 function runKarma(configFileName, headless, args) {
   const cfg = require('karma').config;
   const cfgFile = configFileName || './karma.conf.js';
@@ -116,27 +145,77 @@ function runKarma(configFileName, headless, args) {
     });
   }
 
+  let exitCode = 100;
   const Server = require('karma').Server;
-  const serverInstance = new Server(karmaConfig, exitCode => {
+  const serverInstance = new Server(karmaConfig, karmaExitCode => {
     if (exitCode === 0) {
-      console.log('Karma has exited with 0');
+      console.log('Karma has exited with 0.');
+      process.exitCode = exitCode; // all fine: tests could be executed and no failures
+    } else if (exitCode === 10) {
+      console.log('Webpack build failed. See webpack output for details.');
+      process.exitCode = exitCode; // webpack error
+    } else if (exitCode === 4) {
+      console.log('There are test failures.');
+      process.exitCode = 0; // test could be executed but there are test failures: do not set exitCode to something other than 0 here because the build should continue even on failing tests.
     } else {
-      console.log(`There are test failures. Karma has exited with ${exitCode}`);
+      console.log(`Error in test execution. Exit code: ${exitCode}.`);
+      process.exitCode = exitCode; // tests could not be executed because of an error. Let the process fail.
+    }
+  });
+
+  serverInstance.on('run_complete', (browsers, results) => {
+    // compute exit code based on webpack stats and karma result.
+    // Karma exitCode alone is not detailed enough (all problems have exitCode=1).
+    let webpackStats = null;
+    let statsExtractPlugins = karmaConfig.webpack.plugins.filter(p => p instanceof StatsExtractWebpackPlugin);
+    if (statsExtractPlugins && statsExtractPlugins.length) {
+      webpackStats = statsExtractPlugins[0].stats;
     }
-    process.exit(0); // do not set exitCode of karma to the process here because the build should continue even on failing tests. therefore always use exitCode zero.
+    exitCode = computeExitCode(results, webpackStats);
   });
+
   console.log(`Starting Karma server using config file ${configFilePath}`);
   serverInstance.start();
 }
 
+/**
+ * Inspired by Karma.BrowserCollection.calculateExitCode().
+ *
+ * @param karmaResults The Karma results object
+ * @param webpackStats The Webpack build stats object
+ * @returns {number} The custom exit code
+ */
+function computeExitCode(karmaResults, webpackStats) {
+  if (webpackStats && webpackStats.hasErrors()) {
+    return 10; // webpack build failed
+  }
+  if (karmaResults.disconnected) {
+    return 2; // browser disconnected
+  }
+  if (karmaResults.error) {
+    return 3; // karma error
+  }
+  if (karmaResults.failed > 0) {
+    return 4; // tests could be executed but there are test failures (Karma uses exitCode=1 here which is not what we want)
+  }
+  return karmaResults.exitCode;
+}
+
 function runWebpack(args) {
   const configFilePath = readWebpackConfig();
+  if (!configFilePath) {
+    return;
+  }
   const {compiler, statsConfig} = createWebpackCompiler(configFilePath, args);
-  compiler.run((err, stats) => logWebpack(err, stats, statsConfig));
+  if (args.watch) {
+    compiler.watch({}, (err, stats) => logWebpack(err, stats, statsConfig));
+  } else {
+    compiler.run((err, stats) => logWebpack(err, stats, statsConfig));
+  }
 }
 
 function readWebpackConfig() {
-  let configFilePath = null;
+  let configFilePath;
   const devConfigFilePath = path.resolve(webpackCustomConfigFileName);
   if (fs.existsSync(devConfigFilePath)) {
     console.log(`Reading config from ${webpackCustomConfigFileName}`);
@@ -152,12 +231,6 @@ function readWebpackConfig() {
   return configFilePath;
 }
 
-function runWebpackWatch(args) {
-  const configFilePath = readWebpackConfig();
-  const {compiler, statsConfig} = createWebpackCompiler(configFilePath, args);
-  compiler.watch({}, (err, stats) => logWebpack(err, stats, statsConfig));
-}
-
 function createWebpackCompiler(configFilePath, args) {
   const webpack = require('webpack');
   const conf = require(configFilePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-scout/cli",
-  "version": "22.0.41",
+  "version": "23.1.1",
   "description": "CLI for Eclipse Scout",
   "author": "BSI Business Systems Integration AG",
   "homepage": "https://www.eclipse.org/scout",
@@ -8,11 +8,11 @@
     "type": "git",
     "url": "https://github.com/eclipse-scout/scout.rt.git"
   },
-  "license": "EPL-1.0",
+  "license": "EPL-2.0",
   "engines": {
-    "node": ">=16.13.0",
-    "npm": ">=8.1.0",
-    "pnpm": ">=6.22.2"
+    "node": ">=18.12.1",
+    "npm": ">=9.1.1",
+    "pnpm": ">=7.16.0"
   },
   "keywords": [
     "scout",
@@ -28,35 +28,37 @@
     "scripts"
   ],
   "dependencies": {
-    "@babel/cli": "7.16.0",
-    "@babel/core": "7.16.5",
-    "@babel/plugin-proposal-class-properties": "7.16.5",
-    "@babel/plugin-proposal-object-rest-spread": "7.16.5",
-    "@babel/plugin-transform-object-assign": "7.16.5",
-    "@babel/preset-env": "7.16.5",
-    "babel-loader": "8.2.3",
-    "copy-webpack-plugin": "10.2.0",
-    "style-loader": "3.3.1",
-    "css-loader": "6.5.1",
-    "jasmine-core": "3.10.1",
+    "esbuild": "0.15.16",
+    "@babel/core": "7.20.5",
+    "@babel/preset-env": "7.20.2",
+    "babel-loader": "9.1.0",
+    "typescript": "4.9.3",
+    "ts-loader": "9.4.1",
+    "source-map-loader": "4.0.1",
+    "copy-webpack-plugin": "11.0.0",
+    "css-loader": "6.7.2",
+    "jasmine-core": "4.5.0",
     "jasmine-jquery": "2.1.1",
     "jquery": "3.6.0",
-    "karma": "6.3.20",
-    "karma-chrome-launcher": "3.1.0",
-    "karma-jasmine": "4.0.1",
+    "karma": "6.4.1",
+    "karma-chrome-launcher": "3.1.1",
+    "karma-jasmine": "5.1.0",
     "karma-jasmine-ajax": "0.1.13",
     "@metahub/karma-jasmine-jquery": "4.0.1",
-    "@eclipse-scout/karma-jasmine-scout": "22.0.41",
-    "karma-jasmine-html-reporter": "1.7.0",
+    "@eclipse-scout/karma-jasmine-scout": "23.1.1",
+    "@eclipse-scout/tsconfig": "23.1.1",
+    "karma-jasmine-html-reporter": "2.0.0",
     "karma-junit-reporter": "2.0.1",
     "karma-webpack": "5.0.0",
-    "less": "4.1.2",
-    "less-loader": "10.2.0",
-    "mini-css-extract-plugin": "2.4.5",
-    "css-minimizer-webpack-plugin": "3.3.0",
-    "terser-webpack-plugin": "5.3.0",
-    "webpack": "5.65.0",
-    "yargs-parser": "21.0.0"
+    "less": "4.1.3",
+    "less-loader": "11.1.0",
+    "mini-css-extract-plugin": "2.7.1",
+    "css-minimizer-webpack-plugin": "4.2.2",
+    "terser-webpack-plugin": "5.3.6",
+    "webpack": "5.75.0",
+    "yargs-parser": "21.1.1",
+    "fork-ts-checker-webpack-plugin": "7.2.13",
+    "fork-ts-checker-notifier-webpack-plugin": "6.0.0"
   },
   "devDependencies": {
     "@eclipse-scout/releng": "^22.0.0"

package/scripts/AfterEmitWebpackPlugin.js

@@ -1,27 +1,28 @@
 /*
- * Copyright (c) 2010-2020 BSI Business Systems Integration AG.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
  *
- * Contributors:
- *     BSI Business Systems Integration AG - initial API and implementation
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 const pluginName = 'AfterEmitWebpackPlugin';
 const scoutPostBuild = require('./post-build');
 
 module.exports = class AfterEmitWebpackPlugin {
   constructor(options = {}) {
-    const {outDir} = options;
-    this.options = {outDir};
+    const {outDir, createFileList} = options;
+    this.options = {outDir, createFileList};
   }
 
   // noinspection JSUnusedGlobalSymbols
   apply(compiler) {
     compiler.hooks.afterEmit.tap(pluginName, compilation => {
       scoutPostBuild.cleanOutDir(this.options.outDir);
-      scoutPostBuild.createFileList(this.options.outDir);
+      if (this.options.createFileList ?? true) {
+        scoutPostBuild.createFileList(this.options.outDir);
+      }
     });
   }
 };

package/scripts/StatsExtractWebpackPlugin.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+const pluginName = 'StatsExtractWebpackPlugin';
+/**
+ * Webpack plugin used to store the build stats (results) on build completion.
+ * Result may be obtained using 'statsExtractWebpackPlugin.stats'.
+ */
+module.exports = class StatsExtractWebpackPlugin {
+  apply(compiler) {
+    compiler.hooks.done.tap(pluginName, stats => {
+      this.stats = stats;
+    });
+  }
+};

package/scripts/constants.js

@@ -1,16 +1,17 @@
 /*
- * Copyright (c) 2010-2022 BSI Business Systems Integration AG.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
  *
- * Contributors:
- *     BSI Business Systems Integration AG - initial API and implementation
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 const fs = require('fs');
 const path = require('path');
 
+const contentHashSuffix = '-[contenthash]';
+
 const mode = {
   production: 'production',
   development: 'development'
@@ -37,31 +38,46 @@ const cssFilename = {
   development: '[name].css'
 };
 
+function isMavenModule() {
+  const workingDir = process.cwd();
+  return fs.existsSync(path.resolve(workingDir, 'src', 'main')) || fs.existsSync(path.resolve(workingDir, 'src', 'test'));
+}
+
+function getConstantsForMode(buildMode) {
+  if (buildMode !== mode.production) {
+    return {
+      devMode: true,
+      jsFilename: jsFilename.development,
+      cssFilename: cssFilename.development,
+      outSubDir: outSubDir.development
+    };
+  }
+  return {
+    devMode: false,
+    jsFilename: jsFilename.production,
+    cssFilename: cssFilename.production,
+    outSubDir: outSubDir.production
+  };
+}
+
+function getOutputDir(mode) {
+  const outSubDir = getConstantsForMode(mode).outSubDir;
+  const isMavenModule = this.isMavenModule();
+  if (isMavenModule) {
+    return path.resolve(this.outDir.target, this.outDir.dist, outSubDir);
+  }
+  return path.resolve(this.outDir.dist);
+}
+
 module.exports = {
+  contentHashSuffix: contentHashSuffix,
   mode: mode,
   outDir: outDir,
   outSubDir: outSubDir,
   fileListName: 'file-list',
   jsFilename: jsFilename,
   cssFilename: cssFilename,
-  isMavenModule: () => {
-    const workingDir = process.cwd();
-    return fs.existsSync(path.resolve(workingDir, 'src', 'main')) || fs.existsSync(path.resolve(workingDir, 'src', 'test'));
-  },
-  getConstantsForMode: buildMode => {
-    if (buildMode !== mode.production) {
-      return {
-        devMode: true,
-        jsFilename: jsFilename.development,
-        cssFilename: cssFilename.development,
-        outSubDir: outSubDir.development
-      };
-    }
-    return {
-      devMode: false,
-      jsFilename: jsFilename.production,
-      cssFilename: cssFilename.production,
-      outSubDir: outSubDir.production
-    };
-  }
+  isMavenModule: isMavenModule,
+  getConstantsForMode: getConstantsForMode,
+  getOutputDir: getOutputDir
 };

package/scripts/files.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+const fs = require('fs');
+const path = require('path');
+
+const getAllFiles = dir => {
+  if (!fs.existsSync(dir)) {
+    return [];
+  }
+
+  return fs.readdirSync(dir).reduce((files, file) => {
+    const filePath = path.join(dir, file);
+    if (!fs.existsSync(filePath)) {
+      return files;
+    }
+    return isDirectory(filePath) ? [...files, ...getAllFiles(filePath)] : [...files, filePath];
+  }, []);
+};
+
+function isDirectory(filePath) {
+  return fs.statSync(filePath).isDirectory();
+}
+
+const cleanFolder = dir => {
+  if (!fs.existsSync(dir)) {
+    return;
+  }
+
+  const files = fs.readdirSync(dir);
+  for (const file of files) {
+    try {
+      let filePath = path.join(dir, file);
+      if (isDirectory(filePath)) {
+        fs.rmdirSync(filePath, {recursive: true});
+      } else {
+        file.unlink(path.resolve(dir, file));
+      }
+    } catch (err) {
+      console.log(`${dir}/${file} could not be removed`, err);
+    }
+  }
+};
+
+const deleteFolder = dir => {
+  if (!fs.existsSync(dir)) {
+    return;
+  }
+
+  try {
+    fs.rmdirSync(dir, {recursive: true});
+  } catch (err) {
+    console.log(`${dir} could not be deleted`, err);
+  }
+};
+
+module.exports.listFiles = getAllFiles;
+module.exports.cleanFolder = cleanFolder;
+module.exports.deleteFolder = deleteFolder;

package/scripts/karma-defaults.js

@@ -1,20 +1,18 @@
 /*
- * Copyright (c) 2010-2022 BSI Business Systems Integration AG.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
+ * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
  *
- * Contributors:
- *     BSI Business Systems Integration AG - initial API and implementation
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 const fs = require('fs');
 const path = require('path');
-
 const jquery = require.resolve('jquery');
-const webpack = require('webpack');
-
 const scoutBuildConstants = require('./constants');
+const {SourceMapDevToolPlugin} = require('webpack');
+const StatsExtractWebpackPlugin = require('./StatsExtractWebpackPlugin');
 
 module.exports = (config, specEntryPoint) => {
   const webpackConfigFilePath = path.resolve('webpack.config.js');
@@ -25,32 +23,56 @@ module.exports = (config, specEntryPoint) => {
   }
   let webpackConfigProvider = require(webpackConfigFilePath);
 
-  const webpackArgs = Object.assign({mode: scoutBuildConstants.mode.development}, config.webpackArgs);
-  const webpackConfig = webpackConfigProvider(null, webpackArgs);
+  const webpackArgs = Object.assign({
+    mode: scoutBuildConstants.mode.development,
+    watch: true, // by default tests are running in watch mode
+    tsOptions: {
+      compilerOptions: {
+        // No need to create declarations for tests
+        declaration: false,
+        declarationMap: false
+      }
+    }
+  }, config.webpackArgs);
+  let webpackConfig = webpackConfigProvider(null, webpackArgs);
+  if (Array.isArray(webpackConfig)) {
+    webpackConfig = webpackConfig[0];
+  }
   delete webpackConfig.entry;
   if (webpackConfig.optimization) {
     delete webpackConfig.optimization.splitChunks; // disable splitting for tests
   }
 
   if (webpackConfig.output) {
-    // remove output file as Karma uses an in-memory middleware and complains if an output file is present
+    // Remove output file as Karma uses an in-memory middleware and complains if an output file is present
     delete webpackConfig.output.filename;
+    // Don't create a library, it would create an error during test run (module not found)
+    delete webpackConfig.output.library;
   }
 
-  // specify output directory for webpack (use different than normal output dir so that they are not polluted with test artifacts)
+  if (webpackConfig.externals) {
+    // Remove externals, so they don't have to be provided
+    // Add jquery as the only external, so it won't be loaded twice because it is provided by @metahub/karma-jasmine-jquery
+    webpackConfig.externals = {
+      'jquery': 'global jQuery'
+    };
+  }
+
+  // specify output directory for webpack (use different from normal output dir so that they are not polluted with test artifacts)
   webpackConfig.output = webpackConfig.output || {};
   webpackConfig.output.path = path.resolve(scoutBuildConstants.outDir.target, scoutBuildConstants.outDir.distKarma, scoutBuildConstants.outSubDir.development);
   fs.mkdirSync(webpackConfig.output.path, {recursive: true});
 
-  webpackConfig.watch = true;
+  webpackConfig.watch = !!webpackArgs.watch;
 
-  const sourceMapPlugin = webpackConfig.plugins.find(plugin => plugin instanceof webpack.SourceMapDevToolPlugin);
+  const sourceMapPlugin = webpackConfig.plugins.find(plugin => plugin instanceof SourceMapDevToolPlugin);
   if (sourceMapPlugin) {
     // Use inline source maps because external source maps are not supported by karma (https://github.com/webpack-contrib/karma-webpack/issues/224)
     delete sourceMapPlugin.sourceMapFilename;
   }
+  webpackConfig.plugins.push(new StatsExtractWebpackPlugin()); // used by scout-scripts to access the webpack build result.
 
-  const specIndex = specEntryPoint ? path.resolve(specEntryPoint) : path.resolve('test', 'test-index.js');
+  const specIndex = searchSpecEntryPoint(specEntryPoint);
   const preprocessorObj = {};
   preprocessorObj[specIndex] = ['webpack'];
 
@@ -96,3 +118,14 @@ module.exports = (config, specEntryPoint) => {
     }
   });
 };
+
+function searchSpecEntryPoint(specEntryPoint) {
+  if (specEntryPoint) {
+    return path.resolve(specEntryPoint);
+  }
+  let defaultTypescriptIndex = path.resolve('test', 'test-index.ts');
+  if (fs.existsSync(defaultTypescriptIndex)) {
+    return defaultTypescriptIndex;
+  }
+  return path.resolve('test', 'test-index.js');
+}