@ui5/webcomponents-tools 0.0.0-a7032d86e → 0.0.0-a8a75c830

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/CHANGELOG.md +2188 -0
  2. package/LICENSE.txt +201 -0
  3. package/README.md +7 -9
  4. package/assets-meta.js +12 -11
  5. package/bin/dev.js +10 -4
  6. package/bin/ui5nps.js +301 -0
  7. package/components-package/eslint.js +51 -15
  8. package/components-package/nps.js +123 -80
  9. package/components-package/postcss.components.js +1 -21
  10. package/components-package/postcss.themes.js +1 -26
  11. package/components-package/vite.config.js +7 -10
  12. package/components-package/wdio.js +43 -15
  13. package/icons-collection/nps.js +32 -19
  14. package/lib/amd-to-es6/index.js +109 -0
  15. package/lib/amd-to-es6/no-remaining-require.js +33 -0
  16. package/lib/cem/cem.js +16 -0
  17. package/lib/cem/custom-elements-manifest.config.mjs +575 -0
  18. package/lib/cem/event.mjs +168 -0
  19. package/lib/cem/patch/@custom-elements-manifest/analyzer/cli.js +128 -0
  20. package/lib/cem/patch/@custom-elements-manifest/analyzer/package.json +59 -0
  21. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/browser-entrypoint.js +23 -0
  22. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/create.js +117 -0
  23. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/arrow-function.js +26 -0
  24. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/class-jsdoc.js +157 -0
  25. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/classes.js +20 -0
  26. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createArrowFunction.js +17 -0
  27. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createAttribute.js +24 -0
  28. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createClass.js +301 -0
  29. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createClassField.js +26 -0
  30. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createFunctionLike.js +73 -0
  31. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createMixin.js +33 -0
  32. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/createVariable.js +22 -0
  33. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/creators/handlers.js +338 -0
  34. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/custom-elements-define-calls.js +90 -0
  35. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/exports.js +156 -0
  36. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/function-like.js +24 -0
  37. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/mixins.js +29 -0
  38. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/reexported-wrapped-mixin-exports.js +84 -0
  39. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/analyse-phase/variables.js +34 -0
  40. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/collect-phase/collect-imports.js +101 -0
  41. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/catalyst/catalyst.js +11 -0
  42. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/catalyst/controller.js +34 -0
  43. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/catalyst-major-2/catalyst.js +11 -0
  44. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/catalyst-major-2/controller.js +34 -0
  45. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/decorators/attr.js +53 -0
  46. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/decorators/custom-element-decorator.js +36 -0
  47. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/fast/fast.js +7 -0
  48. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/lit.js +13 -0
  49. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/member-denylist.js +21 -0
  50. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/method-denylist.js +20 -0
  51. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/property-decorator.js +94 -0
  52. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/static-properties.js +121 -0
  53. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/lit/utils.js +66 -0
  54. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/framework-plugins/stencil/stencil.js +129 -0
  55. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/index.js +80 -0
  56. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/link-phase/cleanup-classes.js +25 -0
  57. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/link-phase/field-denylist.js +22 -0
  58. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/link-phase/method-denylist.js +25 -0
  59. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/post-processing/apply-inheritance.js +78 -0
  60. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/post-processing/is-custom-element.js +34 -0
  61. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/post-processing/link-class-to-tagname.js +27 -0
  62. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/post-processing/remove-unexported-declarations.js +23 -0
  63. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/features/post-processing/resolve-initializers.js +52 -0
  64. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/ast-helpers.js +186 -0
  65. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/cli-helpers.js +164 -0
  66. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/exports.js +44 -0
  67. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/find-external-manifests.js +67 -0
  68. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/imports.js +25 -0
  69. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/index.js +71 -0
  70. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/jsdoc.js +19 -0
  71. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/manifest-helpers.js +194 -0
  72. package/lib/cem/patch/@custom-elements-manifest/analyzer/src/utils/mixins.js +112 -0
  73. package/lib/cem/schema-internal.json +1422 -0
  74. package/lib/cem/schema.json +1098 -0
  75. package/lib/cem/types-internal.d.ts +808 -0
  76. package/lib/cem/types.d.ts +736 -0
  77. package/lib/cem/utils.mjs +429 -0
  78. package/lib/cem/validate.js +81 -0
  79. package/lib/chokidar/chokidar.js +28 -0
  80. package/lib/copy-and-watch/index.js +110 -97
  81. package/lib/copy-list/index.js +18 -10
  82. package/lib/create-icons/index.js +57 -27
  83. package/lib/create-illustrations/index.js +94 -45
  84. package/lib/create-new-component/Component.js +74 -0
  85. package/lib/create-new-component/ComponentTemplate.js +12 -0
  86. package/lib/create-new-component/index.js +62 -101
  87. package/lib/css-processors/css-processor-components.mjs +103 -0
  88. package/lib/css-processors/css-processor-themes.mjs +122 -0
  89. package/lib/css-processors/postcss-plugin.mjs +153 -0
  90. package/lib/css-processors/scope-variables.mjs +74 -0
  91. package/lib/css-processors/shared.mjs +47 -0
  92. package/lib/dev-server/custom-hot-update-plugin.js +39 -0
  93. package/lib/dev-server/{dev-server.js → dev-server.mjs} +26 -14
  94. package/lib/dev-server/virtual-index-html-plugin.js +24 -21
  95. package/lib/eslint/eslint.js +44 -0
  96. package/lib/generate-js-imports/illustrations.js +79 -64
  97. package/lib/generate-json-imports/i18n.js +63 -68
  98. package/lib/generate-json-imports/themes.js +38 -43
  99. package/lib/hbs2lit/src/compiler.js +9 -6
  100. package/lib/hbs2lit/src/litVisitor2.js +42 -17
  101. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  102. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +39 -6
  103. package/lib/hbs2ui5/index.js +23 -6
  104. package/lib/i18n/defaults.js +24 -9
  105. package/lib/i18n/toJSON.js +41 -13
  106. package/lib/icons-hash/icons-hash.mjs +149 -0
  107. package/lib/postcss-combine-duplicated-selectors/index.js +12 -5
  108. package/lib/remove-dev-mode/remove-dev-mode.mjs +51 -0
  109. package/lib/rimraf/rimraf.js +31 -0
  110. package/lib/scoping/get-all-tags.js +10 -3
  111. package/lib/scoping/lint-src.js +8 -7
  112. package/lib/scoping/scope-test-pages.js +2 -1
  113. package/lib/test-runner/test-runner.js +59 -43
  114. package/lib/vite-bundler/vite-bundler.mjs +35 -0
  115. package/package.json +36 -25
  116. package/tsconfig.json +18 -0
  117. package/components-package/wdio.sync.js +0 -360
  118. package/lib/esm-abs-to-rel/index.js +0 -58
  119. package/lib/generate-custom-elements-manifest/index.js +0 -373
  120. package/lib/jsdoc/config.json +0 -29
  121. package/lib/jsdoc/configTypescript.json +0 -29
  122. package/lib/jsdoc/plugin.js +0 -2468
  123. package/lib/jsdoc/preprocess.js +0 -146
  124. package/lib/jsdoc/template/publish.js +0 -4120
  125. package/lib/postcss-css-to-esm/index.js +0 -57
  126. package/lib/postcss-css-to-json/index.js +0 -47
  127. package/lib/postcss-new-files/index.js +0 -36
  128. package/lib/postcss-p/postcss-p.mjs +0 -14
  129. package/lib/replace-global-core/index.js +0 -25
@@ -0,0 +1,74 @@
1
+ import * as path from "path";
2
+ import { createRequire } from 'node:module';
3
+
4
+ const require = createRequire(import.meta.url);
5
+
6
+ /**
7
+ * Tries to detect an override for a package
8
+ * @param {*} filePath For example: /my_project/src/themes/overrides/@ui5/webcomponents/my_custom_theme/parameters-bundle.css
9
+ * @returns
10
+ */
11
+ const getOverrideVersion = filePath => {
12
+ if (!filePath) {
13
+ return;
14
+ }
15
+
16
+ if (!filePath.includes(`overrides${path.sep}`)) {
17
+ return; // The "overrides/" directory is the marker
18
+ }
19
+ const override = filePath.split(`overrides${path.sep}`)[1]; // For example, this will be: @ui5/webcomponents/my_custom_theme/parameters-bundle.css
20
+ if (!override) {
21
+ return; // There must be other directories after overrides/, the path can't end with it
22
+ }
23
+ const parts = override.split(path.sep);
24
+ if (parts.length < 3) {
25
+ return; // There must be at least a directory for the theme that is being overridden (my_custom_theme) and the name of the CSS file after the name of the package that is overridden
26
+ }
27
+ const packageName = parts.slice(0, -2).join(path.sep); // After the last 2 parts are removed (my_custom_theme and parameters-bundle.css from the example), the rest is the package
28
+
29
+ let overrideVersion;
30
+ try {
31
+ overrideVersion = require(`${packageName}${path.sep}package.json`).version;
32
+ } catch (e) {
33
+ if (process.env.UI5_VERBOSE === "true") {
34
+ console.log(`Error requiring package ${packageName}: ${e.message}`);
35
+ }
36
+ }
37
+
38
+ return overrideVersion;
39
+ }
40
+
41
+ /**
42
+ * `packageJSON` should reference the `package.json` of the base package,
43
+ * as it serves as the starting point for every runtime and carries a unique version.
44
+ * The `getScopedVarName` function is also defined in the base package
45
+ * and is consumed by all other packages.
46
+ *
47
+ * Runtime (2.19.0)
48
+ * - base (2.19.0)
49
+ * - At least one of the following packages: ai / main / fiori / compat (2.19.0)
50
+ * - Custom package (x.x.x)
51
+ *
52
+ * It is not possible to have a runtime with the main package at version 2.19.0
53
+ * and the base package at a different version (e.g., 2.18.0),
54
+ * because the main package depends on the base package.
55
+ * Such a mismatch would create a new runtime.
56
+ *
57
+ * Therefore, we can safely assume that the base package version
58
+ * matches the runtime version and can be reliably used for scoping.
59
+ *
60
+ * It is still needed for third-party packages that have not yet migrated to the
61
+ * component-level variable approach.
62
+ */
63
+
64
+ const scopeVariables = (cssText, packageJSON, inputFile) => {
65
+ const escapeVersion = version => "v" + version?.replaceAll(/[^0-9A-Za-z\-_]/g, "-");
66
+ const versionStr = escapeVersion(getOverrideVersion(inputFile) || packageJSON.version);
67
+
68
+ const expr = /(--_?ui5)([^\,\:\)\s]+)/g;
69
+
70
+ return cssText.replaceAll(expr, `$1-${versionStr}$2`);
71
+ }
72
+
73
+ export default scopeVariables;
74
+
@@ -0,0 +1,47 @@
1
+ import { writeFile, readFile, mkdir } from "fs/promises";
2
+ import * as path from "path";
3
+ import assets from "../../assets-meta.js";
4
+
5
+ const readOldContent = async (fileName) => {
6
+ // it seems slower to read the old content, but writing the same content with no real changes
7
+ // (as in initial build and then watch mode) will cause an unnecessary dev server refresh
8
+ let oldContent = "";
9
+ try {
10
+ oldContent = (await readFile(fileName)).toString();
11
+ } catch (e) {
12
+ // file not found
13
+ }
14
+ return oldContent;
15
+ }
16
+
17
+ const writeFileIfChanged = async (fileName, content) => {
18
+ const oldContent = await readOldContent(fileName);
19
+ if (content !== oldContent) {
20
+ if (!oldContent) {
21
+ await mkdir(path.dirname(fileName), { recursive: true });
22
+ }
23
+ return writeFile(fileName, content);
24
+ }
25
+ }
26
+
27
+ const DEFAULT_THEME = assets.themes.default;
28
+ const CSS_VARIABLES_TARGET = process.env.CSS_VARIABLES_TARGET === "host";
29
+
30
+ const getDefaultThemeCode = packageName => {
31
+ return `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
32
+
33
+ import defaultThemeBase from "@ui5/webcomponents-theming/dist/generated/themes/${DEFAULT_THEME}/parameters-bundle.css.js";
34
+ import defaultTheme from "./${DEFAULT_THEME}/parameters-bundle.css.js";
35
+
36
+ registerThemePropertiesLoader("@" + "ui5" + "/" + "webcomponents-theming", "${DEFAULT_THEME}", async () => defaultThemeBase);
37
+ registerThemePropertiesLoader(${packageName.split("").map(c => `"${c}"`).join(" + ")}, "${DEFAULT_THEME}", async () => defaultTheme${CSS_VARIABLES_TARGET ? ', "host"' : ''});
38
+ `;
39
+ };
40
+
41
+ const getFileContent = (packageName, css, includeDefaultTheme) => {
42
+ const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
43
+ return `${defaultTheme}export default ${css.trim()}`
44
+ }
45
+
46
+
47
+ export { writeFileIfChanged, getFileContent }
@@ -0,0 +1,39 @@
1
+ const fs = require("fs");
2
+
3
+ /**
4
+ * A change is observed on MacOS since 13.5, where the build generates a large amount
5
+ * of JSON file that spotlight search has to index, as they are considered new files.
6
+ *
7
+ * Starting the vitejs dev server reads all of these files and this triggers the indexing.
8
+ * The indexing has a side effect of changing some file metadata (can be checked with `mdls <path_to_file>`).
9
+ * This metadata change is changing the ctime of the file, but not the mtime. This can be checked with `stat -x <path_to_file>
10
+ *
11
+ * Essentially only metadata is changed, not content. This should not cause a page refresh,
12
+ * but chokidar reports this change and vite refreshes the page.
13
+ * The indexing is running with a 10 second interval, so for roughtly 20 minutes vite is refreshing the page every 10 seconds
14
+ *
15
+ * This plugin checks if the file causing the refresh is a generated json file (dist/*.json) and if ctime is changed after mtime
16
+ * In that case, returing an empty array tells vitejs that a custom update will be made by the plugin,
17
+ * which is in effect ignoring the page refresh.
18
+ */
19
+
20
+ const customHotUpdate = async () => {
21
+ return {
22
+ name: 'custom-hot-update',
23
+ handleHotUpdate(ctx) {
24
+ // custom check for generated json files
25
+ if (ctx.file.endsWith(".json")) {
26
+ const stat = fs.statSync(ctx.file);
27
+
28
+ // metadata change only
29
+ if (stat.ctime > stat.mtime) {
30
+ // uncomment for debugging
31
+ // console.log("ignoring hot update for:", ctx.file);
32
+ return [];
33
+ }
34
+ }
35
+ }
36
+ }
37
+ };
38
+
39
+ module.exports = customHotUpdate;
@@ -1,15 +1,12 @@
1
- const fs = require("fs/promises");
2
- const { createServer } = require('vite');
3
- const yargs = require('yargs/yargs')
4
- const { hideBin } = require('yargs/helpers')
1
+ import fs from "fs/promises";
2
+ import { createServer } from 'vite';
3
+ import yargs from 'yargs';
4
+ import { hideBin } from 'yargs/helpers';
5
+ import { pathToFileURL } from "url";
5
6
 
6
- const argv = yargs(hideBin(process.argv))
7
- .alias("c", "config")
8
- .argv;
9
-
10
- const startVite = async (port) => {
7
+ const startVite = async (config, port) => {
11
8
  const server = await createServer({
12
- configFile: argv.config,
9
+ configFile: config,
13
10
  server: {
14
11
  port: port,
15
12
  strictPort: true,
@@ -28,7 +25,7 @@ const rmPortFile = async () => {
28
25
  // exit handler must be sync
29
26
  try {
30
27
  await fs.rm(".dev-server-port");
31
- } catch (e) {}
28
+ } catch (e) { }
32
29
  process.exit();
33
30
  }
34
31
 
@@ -36,7 +33,11 @@ const rmPortFile = async () => {
36
33
  process.on(eventType, rmPortFile);
37
34
  });
38
35
 
39
- (async () => {
36
+ async function start(outArgv) {
37
+ const argv = yargs(hideBin(outArgv))
38
+ .alias("c", "config")
39
+ .argv;
40
+
40
41
  let retries = 10;
41
42
  let port = 8080;
42
43
  while (retries--) {
@@ -44,7 +45,7 @@ const rmPortFile = async () => {
44
45
  await fs.writeFile(".dev-server-port", `${port}`);
45
46
  try {
46
47
  // execSync(command, {stdio: 'pipe'});
47
- const server = await startVite(port);
48
+ const server = await startVite(argv.config ?? "", port);
48
49
  if (server) {
49
50
  // server started, don't try other ports
50
51
  break;
@@ -63,4 +64,15 @@ const rmPortFile = async () => {
63
64
  // no error normal exit
64
65
  // process.exit();
65
66
  }
66
- })();
67
+ };
68
+
69
+ const filePath = process.argv[1];
70
+ const fileUrl = pathToFileURL(filePath).href;
71
+
72
+ if (import.meta.url === fileUrl) {
73
+ start(process.argv)
74
+ }
75
+
76
+ export default {
77
+ _ui5mainFn: start
78
+ }
@@ -1,24 +1,17 @@
1
- let path = require("path");
2
-
3
- const virtualIndexPlugin = async () => {
4
- const { globby } = await import("globby");
5
- const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
6
-
7
- const pagesPerFolder = {};
8
- files.forEach(file => {
9
- let folder = pagesPerFolder[path.dirname(file)] = pagesPerFolder[path.dirname(file)] || [];
10
- folder.push(path.basename(file));
11
- });
1
+ const virtualIndexPlugin = () => {
2
+ return {
3
+ name: 'virtual-index-html',
4
+ async config() {
5
+ const path = (await import("path")).default;
6
+ const globby = (await import("globby")).globby;
7
+ const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
12
8
 
13
- const rollupInput = {};
9
+ const rollupInput = {};
14
10
 
15
- files.forEach(file => {
16
- rollupInput[file] = path.resolve(process.cwd(), file);
17
- })
11
+ files.forEach(file => {
12
+ rollupInput[file] = path.resolve(process.cwd(), file);
13
+ });
18
14
 
19
- return {
20
- name: 'virtual-index-html',
21
- config() {
22
15
  return {
23
16
  build: {
24
17
  rollupOptions: {
@@ -27,7 +20,17 @@ const virtualIndexPlugin = async () => {
27
20
  }
28
21
  }
29
22
  },
30
- configureServer(server) {
23
+ async configureServer(server) {
24
+ const path = (await import("path")).default;
25
+ const globby = (await import("globby")).globby;
26
+ const files = await globby(["test/pages/**/*.html", "packages/*/test/pages/**/*.html"]);
27
+
28
+ const pagesPerFolder = {};
29
+ files.forEach(file => {
30
+ let folder = pagesPerFolder[path.dirname(file)] = pagesPerFolder[path.dirname(file)] || [];
31
+ folder.push(path.basename(file));
32
+ });
33
+
31
34
  server.middlewares.use((req, res, next) => {
32
35
  if (req.url === "/") {
33
36
  const folders = Object.keys(pagesPerFolder);
@@ -38,8 +41,8 @@ const virtualIndexPlugin = async () => {
38
41
  const pages = pagesPerFolder[folder];
39
42
  return `<h1>${folder}</h1>
40
43
  ${pages.map(page => {
41
- return `<li><a href='${folder}/${page}'>${page}</a></li>`
42
- }).join("")}
44
+ return `<li><a href='${folder}/${page}'>${page}</a></li>`
45
+ }).join("")}
43
46
  `
44
47
  }).join("")}`);
45
48
  } else {
@@ -0,0 +1,44 @@
1
+ const fs = require("fs");
2
+ const { ESLint: ESLint7 } = require("eslint"); // isolated v7
3
+ const path = require("path");
4
+
5
+ const main = async argv => {
6
+ let eslintConfig;
7
+ if (fs.existsSync(".eslintrc.js") || fs.existsSync(".eslintrc.cjs")) {
8
+ // preferred way of custom configuration in root project folder
9
+ eslintConfig = null;
10
+ } else {
11
+ // no custom configuration - use default from tools project
12
+ eslintConfig = require.resolve("@ui5/webcomponents-tools/components-package/eslint.js")
13
+ };
14
+
15
+ const packageDir = path.dirname(require.resolve("@ui5/webcomponents-tools/package.json"));
16
+ const eslint = new ESLint7({
17
+ overrideConfigFile: eslintConfig,
18
+ fix: argv.includes("--fix"),
19
+ resolvePluginsRelativeTo: packageDir,
20
+ });
21
+ console.log("Running ESLint v7...");
22
+
23
+ // Lint files
24
+ const results = await eslint.lintFiles(["."]);
25
+
26
+ // Format results
27
+ const formatter = await eslint.loadFormatter("stylish");
28
+ const resultText = formatter.format(results);
29
+
30
+ // Output results
31
+ console.log(resultText);
32
+
33
+ // Exit with error code if there are errors
34
+ const hasErrors = results.some(result => result.errorCount > 0);
35
+ if (hasErrors) {
36
+ process.exit(1);
37
+ }
38
+ }
39
+
40
+ if (require.main === module) {
41
+ main(process.argv)
42
+ }
43
+
44
+ exports._ui5mainFn = main;
@@ -1,72 +1,87 @@
1
1
  const fs = require("fs").promises;
2
- const path = require('path');
3
-
4
- const generate = async () => {
5
- const fioriInputFolder = path.normalize(process.argv[2]);
6
- const tntInputFolder = path.normalize(process.argv[3]);
7
- const outputFile = path.normalize(`${process.argv[4]}/Illustrations.js`);
8
-
9
- const dir = await fs.readdir(fioriInputFolder);
10
- const fioriIllustrationsOnFileSystem = dir.map(illustrationName => {
11
- const fioriMatches = illustrationName.match(/.*\.js$/);
12
- return fioriMatches ? illustrationName : undefined;
13
- }).filter(key => !!key);
14
-
15
- const tntDir = await fs.readdir(tntInputFolder);
16
- const tntIllustrationsOnFileSystem = tntDir.map(illustrationName => {
17
- const tntMatches = illustrationName.match(/.*\.js$/);
18
- return tntMatches ? illustrationName : undefined;
19
- }).filter(key => !!key);
20
-
21
- // dynamic imports for Fiori illustrations
22
- const fioriAvailableIllustrationsArray = `[${fioriIllustrationsOnFileSystem.filter(
23
- // skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
24
- line => !line.startsWith("sapIllus-Dialog") && !line.startsWith("sapIllus-Scene") && !line.startsWith("sapIllus-Spot") && !line.startsWith("AllIllustrations")).map(illustrationName => `"${illustrationName.replace('.js', '')}"`).join(", ")}]`;
25
-
26
- const fioriDynamicImportLines = fioriIllustrationsOnFileSystem.map(illustrationName =>
27
- `\t\tcase "${illustrationName.replace('.js', '')}": return (await import("../../illustrations/${illustrationName}")).default;`).filter(
28
- // skipping the items starting with sapIllus-Dialog, sapIllus-Scene, sapIllus-Spot since they are included in the illustration's js file
29
- line => !line.startsWith("\t\tcase \"sapIllus-Dialog") && !line.startsWith("\t\tcase \"sapIllus-Scene") && !line.startsWith("\t\tcase \"sapIllus-Spot") && !line.startsWith("\t\tcase \"AllIllustrations")).join("\n");
30
-
31
- // dynamic imports for Tnt illustrations
32
- const tntAvailableIllustrationsArray = `[${tntIllustrationsOnFileSystem.filter(
33
- // skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
34
- line => !line.startsWith("tnt-Dialog") && !line.startsWith("tnt-Scene") && !line.startsWith("tnt-Spot")).map(illustrationName => `"Tnt${illustrationName.replace('.js', '')}"`).join(", ")}]`;
35
-
36
- const tntDynamicImportLines = tntIllustrationsOnFileSystem.map(illustrationName =>
37
- `\t\tcase "Tnt${illustrationName.replace('.js', '')}": return (await import("../../illustrations/tnt/${illustrationName}")).default;`).filter(
38
- // skipping the items starting with tnt-Dialog, tnt-Scene, tnt-Spot since they are included in the illustration's js file
39
- line => !line.startsWith("\t\tcase \"Tnttnt-Dialog") && !line.startsWith("\t\tcase \"Tnttnt-Scene") && !line.startsWith("\t\tcase \"Tnttnt-Spot")).join("\n");
40
-
41
-
42
- // dynamic imports file content
43
- const contentDynamic = `import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
44
-
45
- const loadIllustration = async (illustrationName) => {
46
- switch (illustrationName) {
47
- ${fioriDynamicImportLines}
48
- ${tntDynamicImportLines}
49
- default: throw new Error("[Illustrations] Illustration not found: " + illustrationName);
50
- }
2
+ const path = require("path");
3
+
4
+ const generateDynamicImportLines = async (fileNames, location, exclusionPatterns = []) => {
5
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
6
+ return fileNames
7
+ .filter((fileName) => !exclusionPatterns.some((pattern) => fileName.startsWith(pattern)))
8
+ .map((fileName) => {
9
+ const illustrationName = fileName.replace(".svg", "");
10
+ const illustrationPath = `${location}/${illustrationName}`;
11
+ return `\t\tcase "${fileName.replace('.js', '')}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-${illustrationName.toLowerCase()}" */ "${illustrationPath}.js")).default;`;
12
+ })
13
+ .join("\n");
51
14
  };
52
- const loadAndCheck = async (illustrationName) => {
53
- const data = await loadIllustration(illustrationName);
54
- return data;
15
+
16
+ const generateDynamicImportsFileContent = (dynamicImports, availableIllustrations, collection, set, prefix = "") => {
17
+ return `// @ts-nocheck
18
+ import { registerIllustrationLoader } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
19
+
20
+ export const loadIllustration = async (illustrationName) => {
21
+ const collectionAndPrefix = "${set}/${collection}/${prefix}";
22
+ const cleanIllustrationName = illustrationName.startsWith(collectionAndPrefix) ? illustrationName.replace(collectionAndPrefix, "") : illustrationName;
23
+ switch (cleanIllustrationName) {
24
+ ${dynamicImports}
25
+ default:
26
+ throw new Error("[Illustrations] Illustration not found: " + illustrationName);
55
27
  }
28
+ };
56
29
 
30
+ const loadAndCheck = async (illustrationName) => {
31
+ const data = await loadIllustration(illustrationName);
32
+ return data;
33
+ };
57
34
 
58
- ${fioriAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));
59
- ${tntAvailableIllustrationsArray}.forEach(illustrationName => registerIllustrationLoader(illustrationName, loadAndCheck));`;
60
-
35
+ ${availableIllustrations}.forEach((illustrationName) =>
36
+ registerIllustrationLoader(\`${set}/${collection}/${prefix}\${illustrationName}\`, loadAndCheck)
37
+ );
38
+ `;
39
+ };
61
40
 
62
- await fs.mkdir(path.dirname(outputFile), { recursive: true });
63
- return Promise.all([fs.writeFile(outputFile, contentDynamic)]);
41
+ const getMatchingFiles = async (folder, pattern) => {
42
+ const dir = await fs.readdir(folder);
43
+ return dir.filter((fileName) => fileName.match(pattern));
64
44
  };
65
45
 
66
- generate().then(() => {
67
- console.log("Generated Illustrations.js");
68
- })
69
- .catch(err => {
70
- console.error(err);
71
- process.exit(1);
72
- });
46
+ const generateIllustrations = async (argv) => {
47
+ const config = {
48
+ inputFolder: argv[2],
49
+ outputFile: argv[3],
50
+ set: argv[4],
51
+ collection: argv[5],
52
+ location: argv[6],
53
+ filterOut: argv[7].slice().split(","),
54
+ };
55
+
56
+
57
+ const { inputFolder, outputFile, collection, location, prefix, filterOut, set } = config;
58
+
59
+ const normalizedInputFolder = path.normalize(inputFolder);
60
+ const normalizedOutputFile = path.normalize(outputFile);
61
+
62
+ const svgFiles = await getMatchingFiles(normalizedInputFolder, /\.svg$/);
63
+
64
+ const illustrations = [
65
+ ...new Set(
66
+ svgFiles
67
+ .filter(name => !name.includes("sapIllus-Patterns"))
68
+ .map(name => name.split("-").pop().replace(".svg", ""))
69
+ ),
70
+ ];
71
+
72
+ const dynamicImports = await generateDynamicImportLines(illustrations, location, filterOut);
73
+ const contentDynamic = generateDynamicImportsFileContent(dynamicImports, JSON.stringify(illustrations), collection, set, prefix);
74
+
75
+ await fs.mkdir(path.dirname(normalizedOutputFile), { recursive: true });
76
+ await fs.writeFile(normalizedOutputFile, contentDynamic);
77
+
78
+ if (process.env.UI5_VERBOSE === "true") {
79
+ console.log("Generated illustration imports.");
80
+ }
81
+ };
82
+
83
+ if (require.main === module) {
84
+ generateIllustrations(process.argv)
85
+ }
86
+
87
+ exports._ui5mainFn = generateIllustrations;
@@ -1,98 +1,93 @@
1
1
  const fs = require("fs").promises;
2
2
  const path = require('path');
3
3
 
4
- const generate = async () => {
4
+ const isTypeScript = process.env.UI5_TS;
5
+ const ext = isTypeScript ? 'ts' : 'js';
6
+
7
+
8
+ const getContent = function(caseLines, languagesKeysStringArray, packageName) {
9
+ return `// @ts-nocheck
10
+ import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
11
+
12
+ const importMessageBundle = async (localeId) => {
13
+ switch (localeId) {
14
+ ${caseLines}
15
+ default: throw "unknown locale"
16
+ }
17
+ }
18
+
19
+ const importAndCheck = async (localeId) => {
20
+ const data = await importMessageBundle(localeId);
21
+ if (typeof data === "string" && data.endsWith(".json")) {
22
+ throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build. Check the \"Assets\" documentation for more information.\`);
23
+ }
24
+ return data;
25
+ }
26
+
27
+ const localeIds = [${languagesKeysStringArray}];
28
+
29
+ localeIds.forEach(localeId => {
30
+ registerI18nLoader(${ packageName.split("").map(c => `"${c}"`).join (" + ") }, localeId, importAndCheck);
31
+ });
32
+ `;
33
+ }
34
+
35
+ const generate = async (argv) => {
5
36
 
6
37
  const packageName = JSON.parse(await fs.readFile("package.json")).name;
7
38
 
8
- const inputFolder = path.normalize(process.argv[2]);
9
- const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
10
- const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
39
+ const inputFolder = path.normalize(argv[2]);
40
+ const outputFileDynamic = path.normalize(`${argv[3]}/i18n.${ext}`);
41
+ const outputFileFetchMetaResolve = path.normalize(`${argv[3]}/i18n-fetch.${ext}`);
42
+ const outputFileDynamicImportJSONImport = path.normalize(`${argv[3]}/i18n-node.${ext}`);
11
43
 
12
- // All languages present in the file system
44
+ // All languages present in the file system
13
45
  const files = await fs.readdir(inputFolder);
14
46
  const languages = files.map(file => {
15
- const matches = file.match(/messagebundle_(.+?).json$/);
47
+ const matches = file.match(/messagebundle_(.+?).properties$/);
16
48
  return matches ? matches[1] : undefined;
17
49
  }).filter(key => !!key);
18
50
 
19
- let contentStatic, contentDynamic;
51
+ let contentDynamic;
52
+ let contentFetchMetaResolve;
53
+ let contentDynamicImportJSONAttr;
20
54
 
21
- // No i18n - just import dependencies, if any
55
+ // No i18n - just import dependencies, if any
22
56
  if (languages.length === 0) {
23
- contentStatic = "";
24
57
  contentDynamic = "";
25
- // There is i18n - generate the full file
58
+ contentFetchMetaResolve = "";
59
+ contentDynamicImportJSONAttr = "";
60
+ // There is i18n - generate the full file
26
61
  } else {
27
62
  // Keys for the array
28
- const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
29
63
  const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
30
64
 
31
65
  // Actual imports for json assets
32
- const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
33
-
34
- // static imports
35
- contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
36
-
37
- ${assetsImportsString}
38
-
39
- const bundleMap = {
40
- ${languagesKeysString}
41
- };
42
-
43
- const fetchMessageBundle = async (localeId) => {
44
- if (typeof bundleMap[localeId] === "object") {
45
- // inlined from build
46
- throw new Error("[i18n] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs")
47
- }
48
- return (await fetch(bundleMap[localeId])).json()
49
- }
50
-
51
- const localeIds = [${languagesKeysStringArray}];
52
-
53
- localeIds.forEach(localeId => {
54
- registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
55
- });
56
- `;
57
-
58
- // Actual imports for json assets
59
- const dynamicImportsString = languages.map(key => ` case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
66
+ const dynamicImportsString = languages.map(key => ` case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
67
+ const fetchMetaResolveString = languages.map(key => ` case "${key}": return (await fetch(new URL("../assets/i18n/messagebundle_${key}.json", import.meta.url))).json();`).join("\n");
68
+ const dynamicImportJSONAttrString = languages.map(key => ` case "${key}": return (await import(/* webpackChunkName: "${packageName.replace("@", "").replace("/", "-")}-messagebundle-${key}" */ "../assets/i18n/messagebundle_${key}.json", {with: { type: 'json'}})).default;`).join("\n");
60
69
 
61
70
  // Resulting file content
62
- contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
63
71
 
64
- const importMessageBundle = async (localeId) => {
65
- switch (localeId) {
66
- ${dynamicImportsString}
67
- default: throw "unknown locale"
68
- }
72
+ contentDynamic = getContent(dynamicImportsString, languagesKeysStringArray, packageName);
73
+ contentFetchMetaResolve = getContent(fetchMetaResolveString, languagesKeysStringArray, packageName);
74
+ contentDynamicImportJSONAttr = getContent(dynamicImportJSONAttrString, languagesKeysStringArray, packageName);
69
75
  }
70
76
 
71
- const importAndCheck = async (localeId) => {
72
- const data = await importMessageBundle(localeId);
73
- if (typeof data === "string" && data.endsWith(".json")) {
74
- throw new Error(\`[i18n] Invalid bundling detected - dynamic JSON imports bundled as URLs. Switch to inlining JSON files from the build or use 'import ".../Assets-static.js"'. Check the \"Assets\" documentation for more information.\`);
77
+ await fs.mkdir(path.dirname(outputFileDynamic), { recursive: true });
78
+ return Promise.all([
79
+ fs.writeFile(outputFileDynamic, contentDynamic),
80
+ fs.writeFile(outputFileFetchMetaResolve, contentFetchMetaResolve),
81
+ fs.writeFile(outputFileDynamicImportJSONImport, contentDynamicImportJSONAttr),
82
+ ]).then(() => {
83
+ if (process.env.UI5_VERBOSE === "true") {
84
+ console.log("Generated i18n JSON imports.");
75
85
  }
76
- return data;
77
- }
78
-
79
- const localeIds = [${languagesKeysStringArray}];
80
-
81
- localeIds.forEach(localeId => {
82
- registerI18nLoader("${packageName}", localeId, importAndCheck);
83
86
  });
84
- `;
85
-
86
-
87
- }
87
+ }
88
88
 
89
- await fs.mkdir(path.dirname(outputFile), { recursive: true });
90
- return Promise.all([
91
- fs.writeFile(outputFile, contentStatic),
92
- fs.writeFile(outputFileDynamic, contentDynamic),
93
- ]);
89
+ if (require.main === module) {
90
+ generate(process.argv)
94
91
  }
95
92
 
96
- generate().then(() => {
97
- console.log("Generated i18n JSON imports.");
98
- });
93
+ exports._ui5mainFn = generate;