@ui5/webcomponents-tools 0.0.0-dff5837d7 → 0.0.0-ec448881d

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 (75) hide show
  1. package/CHANGELOG.md +208 -0
  2. package/README.md +1 -1
  3. package/assets-meta.js +18 -1
  4. package/bin/dev.js +10 -5
  5. package/components-package/nps.js +53 -26
  6. package/components-package/postcss.themes.js +6 -3
  7. package/components-package/rollup-plugins/empty-module.js +15 -0
  8. package/components-package/rollup.js +93 -77
  9. package/components-package/wdio.js +54 -29
  10. package/components-package/wdio.sync.js +360 -0
  11. package/icons-collection/nps.js +47 -9
  12. package/lib/copy-and-watch/index.js +30 -5
  13. package/lib/copy-list/index.js +28 -0
  14. package/lib/create-icons/index.js +82 -54
  15. package/lib/create-illustrations/index.js +161 -0
  16. package/lib/create-new-component/index.js +16 -4
  17. package/lib/documentation/index.js +124 -99
  18. package/lib/documentation/templates/api-properties-section.js +3 -1
  19. package/lib/documentation/templates/template.js +2 -1
  20. package/lib/esm-abs-to-rel/index.js +58 -0
  21. package/lib/generate-json-imports/i18n.js +74 -32
  22. package/lib/generate-json-imports/themes.js +64 -17
  23. package/lib/hbs2lit/src/compiler.js +12 -3
  24. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  25. package/lib/hbs2lit/src/litVisitor2.js +43 -7
  26. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  27. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +5 -5
  28. package/lib/hbs2ui5/index.js +50 -18
  29. package/lib/i18n/defaults.js +49 -57
  30. package/lib/i18n/toJSON.js +13 -12
  31. package/lib/jsdoc/config.json +1 -1
  32. package/lib/jsdoc/plugin.js +33 -4
  33. package/lib/jsdoc/template/publish.js +24 -4
  34. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  35. package/lib/postcss-css-to-esm/index.js +19 -16
  36. package/lib/postcss-css-to-json/index.js +20 -11
  37. package/lib/postcss-new-files/index.js +36 -0
  38. package/lib/postcss-p/postcss-p.mjs +11 -0
  39. package/lib/replace-global-core/index.js +25 -0
  40. package/lib/scoping/get-all-tags.js +44 -0
  41. package/lib/scoping/lint-src.js +31 -0
  42. package/lib/scoping/missing-dependencies.js +65 -0
  43. package/lib/scoping/report-tags-usage.js +28 -0
  44. package/lib/scoping/scope-test-pages.js +40 -0
  45. package/lib/serve/index.js +46 -0
  46. package/{components-package → lib/serve}/serve.json +0 -0
  47. package/package-lock.json +48 -0
  48. package/package.json +47 -53
  49. package/bin/init-ui5-package.js +0 -3
  50. package/lib/init-package/index.js +0 -112
  51. package/lib/init-package/resources/.eslintignore +0 -3
  52. package/lib/init-package/resources/bundle.es5.js +0 -25
  53. package/lib/init-package/resources/bundle.esm.js +0 -34
  54. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  55. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  56. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  57. package/lib/init-package/resources/config/rollup.config.js +0 -1
  58. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  59. package/lib/init-package/resources/package-scripts.js +0 -11
  60. package/lib/init-package/resources/src/Assets.js +0 -5
  61. package/lib/init-package/resources/src/Demo.hbs +0 -1
  62. package/lib/init-package/resources/src/Demo.js +0 -56
  63. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  64. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  65. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  66. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  67. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  68. package/lib/init-package/resources/src/themes/Demo.css +0 -11
  69. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  70. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  71. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  72. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  73. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  74. package/lib/init-package/resources/test/pages/index.html +0 -51
  75. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
@@ -1,38 +1,38 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require('path');
3
- const mkdirp = require("mkdirp");
4
- const assets = require("../../assets-meta.js");
5
3
 
6
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
4
+ const generate = async () => {
7
5
 
8
- const inputFolder = path.normalize(process.argv[2]);
9
- const outputFile = path.normalize(`${process.argv[3]}/i18n.js`);
6
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
10
7
 
11
- const defaultLanguage = assets.languages.default;
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`);
12
11
 
13
12
  // All languages present in the file system
14
- const files = fs.readdirSync(inputFolder);
15
- const languages = files.map(file => {
16
- const matches = file.match(/messagebundle_(.+?).json$/);
17
- return matches ? matches[1] : undefined;
18
- }).filter(key => !!key && key !== defaultLanguage);
13
+ const files = await fs.readdir(inputFolder);
14
+ const languages = files.map(file => {
15
+ const matches = file.match(/messagebundle_(.+?).json$/);
16
+ return matches ? matches[1] : undefined;
17
+ }).filter(key => !!key);
19
18
 
20
- let content;
19
+ let contentStatic, contentDynamic;
21
20
 
22
21
  // No i18n - just import dependencies, if any
23
- if (languages.length === 0) {
24
- content = ``;
22
+ if (languages.length === 0) {
23
+ contentStatic = "";
24
+ contentDynamic = "";
25
25
  // There is i18n - generate the full file
26
- } else {
26
+ } else {
27
+ // Keys for the array
28
+ const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
29
+ const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
27
30
 
28
- // Keys for the array
29
- const languagesKeysString = languages.map(key => `${key},`).join("\n\t");
31
+ // Actual imports for json assets
32
+ const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
30
33
 
31
- // Actual imports for json assets
32
- const assetsImportsString = languages.map(key => `import ${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
33
-
34
- // Resulting file content
35
- content = `import { registerI18nBundle } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
34
+ // static imports
35
+ contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
36
36
 
37
37
  ${assetsImportsString}
38
38
 
@@ -40,17 +40,59 @@ const bundleMap = {
40
40
  ${languagesKeysString}
41
41
  };
42
42
 
43
- const allEntriesInlined = Object.entries(bundleMap).every(([_key, value]) => typeof (value) === "object");
44
-
45
- if (allEntriesInlined) {
46
- console.warn(\`Inefficient bundling detected: consider bundling i18n imports as URLs instead of inlining them.
47
- See rollup-plugin-url or webpack file-loader for more information.
48
- Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
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
49
  }
50
50
 
51
- registerI18nBundle("${packageName}", bundleMap);
51
+ const localeIds = [${languagesKeysStringArray}];
52
+
53
+ localeIds.forEach(localeId => {
54
+ registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
55
+ });
52
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");
60
+
61
+ // Resulting file content
62
+ contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
63
+
64
+ const importMessageBundle = async (localeId) => {
65
+ switch (localeId) {
66
+ ${dynamicImportsString}
67
+ default: throw "unknown locale"
68
+ }
69
+ }
70
+
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.\`);
75
+ }
76
+ return data;
77
+ }
78
+
79
+ const localeIds = [${languagesKeysStringArray}];
80
+
81
+ localeIds.forEach(localeId => {
82
+ registerI18nLoader("${packageName}", localeId, importAndCheck);
83
+ });
84
+ `;
85
+
86
+
87
+ }
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
+ ]);
53
94
  }
54
95
 
55
- mkdirp.sync(path.dirname(outputFile));
56
- fs.writeFileSync(outputFile, content);
96
+ generate().then(() => {
97
+ console.log("Generated i18n JSON imports.");
98
+ });
@@ -1,33 +1,80 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require('path');
3
- const mkdirp = require("mkdirp");
4
3
  const assets = require("../../assets-meta.js");
5
4
 
6
- const outputFile = path.normalize(`${process.argv[2]}/Themes.js`);
5
+ const generate = async () => {
6
+ const inputFolder = path.normalize(process.argv[2]);
7
+ const outputFile = path.normalize(`${process.argv[3]}/Themes-static.js`);
8
+ const outputFileDynamic = path.normalize(`${process.argv[3]}/Themes.js`);
7
9
 
8
- const optionalThemes = assets.themes.all.filter(theme => theme !== assets.themes.default);
10
+ // All supported optional themes
11
+ const allThemes = assets.themes.all;
9
12
 
10
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
13
+ // All themes present in the file system
14
+ const dirs = await fs.readdir(inputFolder);
15
+ const themesOnFileSystem = dirs.map(dir => {
16
+ const matches = dir.match(/sap_.*$/);
17
+ return matches ? dir : undefined;
18
+ }).filter(key => !!key && allThemes.includes(key));
11
19
 
12
- const importLines = optionalThemes.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
13
- const isInlinedCondition = optionalThemes.map(theme => `isInlined(${theme})`).join(" || ");
14
- const registerLines = optionalThemes.map(theme => `registerThemeProperties("${packageName}", "${theme}", ${theme});`).join("\n");
20
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
15
21
 
16
- // Resulting file content
17
- const content = `import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
22
+ const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
23
+ const themeUrlsByName = "{\n" + themesOnFileSystem.join(",\n") + "\n}";
24
+ const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
25
+ const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
26
+
27
+
28
+ // static imports file content
29
+ const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
18
30
 
19
31
  ${importLines}
20
32
 
33
+ const themeUrlsByName = ${themeUrlsByName};
21
34
  const isInlined = obj => typeof (obj) === "object";
22
35
 
23
- if (${isInlinedCondition}) {
24
- console.warn(\`Inefficient bundling detected: consider bundling theme properties imports as URLs instead of inlining them.
25
- See rollup-plugin-url or webpack file-loader for more information.
26
- Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
36
+ const loadThemeProperties = async (themeName) => {
37
+ if (typeof themeUrlsByName[themeName] === "object") {
38
+ // inlined from build
39
+ throw new Error("[themes] Inlined JSON not supported with static imports of assets. Use dynamic imports of assets or configure JSON imports as URLs");
40
+ }
41
+ return (await fetch(themeUrlsByName[themeName])).json();
27
42
  }
28
43
 
29
- ${registerLines};
44
+ ${availableThemesArray}
45
+ .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
30
46
  `;
31
47
 
32
- mkdirp.sync(path.dirname(outputFile));
33
- fs.writeFileSync(outputFile, content);
48
+
49
+ // dynamic imports file content
50
+ const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
51
+
52
+ const loadThemeProperties = async (themeName) => {
53
+ switch (themeName) {
54
+ ${dynamicImportLines}
55
+ default: throw "unknown theme"
56
+ }
57
+ }
58
+
59
+ const loadAndCheck = async (themeName) => {
60
+ const data = await loadThemeProperties(themeName);
61
+ if (typeof data === "string" && data.endsWith(".json")) {
62
+ throw new Error(\`[themes] 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.\`);
63
+ }
64
+ return data;
65
+ }
66
+
67
+ ${availableThemesArray}
68
+ .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadAndCheck));
69
+ `;
70
+
71
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
72
+ return Promise.all([
73
+ fs.writeFile(outputFile, contentStatic),
74
+ fs.writeFile(outputFileDynamic, contentDynamic)
75
+ ]);
76
+ };
77
+
78
+ generate().then(() => {
79
+ console.log("Generated themes JSON imports.");
80
+ });
@@ -12,8 +12,8 @@ const removeWhiteSpaces = (source) => {
12
12
  .replace(/}}\s+{{/g, "}}{{"); // Remove whitespace between }} and {{
13
13
  };
14
14
 
15
- const hbs2lit = (file) => {
16
- let sPreprocessed = includesReplacer.replace(file);
15
+ const hbs2lit = async (file) => {
16
+ let sPreprocessed = await includesReplacer.replace(file);
17
17
 
18
18
  sPreprocessed = removeWhiteSpaces(sPreprocessed);
19
19
 
@@ -30,7 +30,16 @@ const hbs2lit = (file) => {
30
30
  lv.accept(ast);
31
31
 
32
32
  for (let key in lv.blocks) {
33
- result += lv.blocks[key] + "\n";
33
+ let block = lv.blocks[key];
34
+
35
+ if (block.match(/scopeTag/)) {
36
+ const matches = block.match(/^(.*?)( => )(.*?);$/);
37
+ const scopedCode = matches[3];
38
+ const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
39
+ block = `${matches[1]}${matches[2]}suffix ? ${scopedCode} : ${normalCode};`;
40
+ }
41
+
42
+ result += block + "\n";
34
43
  }
35
44
 
36
45
  result = svgProcessor.process(result);
@@ -1,9 +1,9 @@
1
1
  const path = require("path");
2
- const fs = require("fs");
2
+ const fs = require("fs").promises;
3
3
 
4
- function replaceIncludes(file) {
4
+ const replaceIncludes = async (file) => {
5
5
  const filePath = path.dirname(file);
6
- let fileContent = fs.readFileSync(file, "utf-8");
6
+ let fileContent = await fs.readFile(file, "utf-8");
7
7
 
8
8
  const inclRegex = /{{>\s*include\s*["'](.+?)["']}}/g;
9
9
  let match;
@@ -20,11 +20,11 @@ function replaceIncludes(file) {
20
20
  targetFile = require.resolve(targetFile);
21
21
  }
22
22
 
23
- fileContent = fileContent.replace(match[0], replaceIncludes(targetFile));
23
+ fileContent = fileContent.replace(match[0], await replaceIncludes(targetFile));
24
24
  }
25
25
 
26
26
  return fileContent;
27
- }
27
+ };
28
28
 
29
29
  module.exports = {
30
30
  replace: replaceIncludes
@@ -5,9 +5,29 @@ const Visitor = Handlebars.Visitor;
5
5
  // skip ifDefined for event handlers and boolean attrs
6
6
  let skipIfDefined = false;
7
7
 
8
+ // when true => an HTML node value, when false => an attribute value
9
+ let isNodeValue = false;
10
+
11
+ // when true => the current attribute is "style"
12
+ let isStyleAttribute = false;
13
+
8
14
  // matches event handlers @click= and boolean attrs ?disabled=
9
15
  const dynamicAttributeRgx = /\s(\?|@)([a-zA-Z|-]+)="?\s*$/;
10
16
 
17
+ if (!String.prototype.replaceAll) {
18
+ String.prototype.replaceAll = function(str, newStr){
19
+
20
+ // If a regex pattern
21
+ if (Object.prototype.toString.call(str).toLowerCase() === '[object regexp]') {
22
+ return this.replace(str, newStr);
23
+ }
24
+
25
+ // If a string
26
+ return this.replace(new RegExp(str, 'g'), newStr);
27
+
28
+ };
29
+ }
30
+
11
31
  function HTMLLitVisitor(debug) {
12
32
  this.blockCounter = 0;
13
33
  this.keys = [];
@@ -15,7 +35,7 @@ function HTMLLitVisitor(debug) {
15
35
  this.result = "";
16
36
  this.mainBlock = "";
17
37
  this.blockPath = "context";
18
- this.blockParameters = ["context"];
38
+ this.blockParameters = ["context", "tags", "suffix"];
19
39
  this.paths = []; //contains all normalized relative paths
20
40
  this.debug = debug;
21
41
  if (this.debug) {
@@ -31,7 +51,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
31
51
  this.keys.push(key);
32
52
  this.debug && this.blockByNumber.push(key);
33
53
 
34
- this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => { return ";
54
+ this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
35
55
 
36
56
  if (this.keys.length > 1) { //it's a nested block
37
57
  this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
@@ -42,7 +62,7 @@ HTMLLitVisitor.prototype.Program = function(program) {
42
62
 
43
63
  this.blocks[this.currentKey()] += "html`";
44
64
  Visitor.prototype.Program.call(this, program);
45
- this.blocks[this.currentKey()] += "`; };";
65
+ this.blocks[this.currentKey()] += "`;";
46
66
 
47
67
  this.keys.pop(key);
48
68
  };
@@ -51,9 +71,24 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
51
71
  Visitor.prototype.ContentStatement.call(this, content);
52
72
  // let content = content.orgiinal; // attribute="__ attribute = "__ attribute ="__
53
73
 
54
- const contentStatement = content.original;
74
+ let contentStatement = content.original;
55
75
  skipIfDefined = !!dynamicAttributeRgx.exec(contentStatement);
56
76
 
77
+ const closingIndex = contentStatement.lastIndexOf(">");
78
+ const openingIndex = contentStatement.lastIndexOf("<");
79
+ if (closingIndex !== -1 || openingIndex !== -1) { // Only change isNodeValue whenever < or > is found in the content statement
80
+ isNodeValue = closingIndex > openingIndex;
81
+ }
82
+
83
+ isStyleAttribute = !isNodeValue && contentStatement.match(/style *= *["']? *$/);
84
+
85
+ if (!isStyleAttribute && contentStatement.match(/style=/)) {
86
+ console.log("WARNING: style hard-coded", contentStatement);
87
+ }
88
+
89
+ // Scope custom element tags
90
+ contentStatement = contentStatement.replaceAll(/(<\/?\s*)([a-zA-Z0-9_]+-[a-zA-Z0-9_-]+)/g, "$1\${scopeTag(\"$2\", tags, suffix)}");
91
+
57
92
  this.blocks[this.currentKey()] += contentStatement;
58
93
  };
59
94
 
@@ -65,13 +100,14 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
65
100
  } else {
66
101
  const path = normalizePath.call(this, mustache.path.original);
67
102
  const hasCalculatingClasses = path.includes("context.classes");
68
- const hasStylesCalculation = path.includes("context.styles");
69
103
 
70
104
  let parsedCode = "";
71
105
 
72
- if (hasCalculatingClasses) {
106
+ if (isNodeValue && !mustache.escaped) {
107
+ parsedCode = `\${unsafeHTML(${path})}`;
108
+ } else if (hasCalculatingClasses) {
73
109
  parsedCode = `\${classMap(${path})}`;
74
- } else if (hasStylesCalculation) {
110
+ } else if (isStyleAttribute) {
75
111
  parsedCode = `\${styleMap(${path})}`;
76
112
  } else if (skipIfDefined){
77
113
  parsedCode = `\${${path}}`;
@@ -46,8 +46,8 @@ function getSVGMatches(template) {
46
46
 
47
47
  function getSVGBlock(input, blockCounter) {
48
48
  return {
49
- usage: `\${blockSVG${blockCounter}(context)}`,
50
- definition: `\nconst blockSVG${blockCounter} = (context) => {return svg\`${input}\`};`,
49
+ usage: `\${blockSVG${blockCounter}(context, tags, suffix)}`,
50
+ definition: `\nconst blockSVG${blockCounter} = (context, tags, suffix) => svg\`${input}\`;`,
51
51
  };
52
52
  }
53
53
 
@@ -55,7 +55,7 @@ function replaceInternalBlocks(template, svgContent) {
55
55
  const internalBlocks = svgContent.match(blockrx) || [];
56
56
 
57
57
  internalBlocks.forEach(blockName => {
58
- const rx = new RegExp(`const ${blockName}.*(html\`).*};`);
58
+ const rx = new RegExp(`const ${blockName}.*(html\`).*;`);
59
59
  template = template.replace(rx, (match, p1) => {
60
60
  return match.replace(p1, "svg\`");
61
61
  });
@@ -1,10 +1,10 @@
1
1
  const buildRenderer = (controlName, litTemplate) => {
2
- return `
3
- /* eslint no-unused-vars: 0 */
4
- import ifDefined from '@ui5/webcomponents-base/dist/renderer/ifDefined.js';
5
- import { html, svg, repeat, classMap, styleMap } from '@ui5/webcomponents-base/dist/renderer/LitRenderer.js';
2
+ return `/* eslint no-unused-vars: 0 */
3
+ import { html, svg, repeat, classMap, styleMap, ifDefined, unsafeHTML, scopeTag } from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
4
+
6
5
  ${litTemplate}
7
- export default block0;`
6
+
7
+ export default block0;`;
8
8
  };
9
9
 
10
10
  module.exports = {
@@ -1,8 +1,9 @@
1
- const fs = require('fs');
1
+ const fs = require('fs').promises;
2
2
  const getopts = require('getopts');
3
3
  const hbs2lit = require('../hbs2lit');
4
4
  const path = require('path');
5
5
  const litRenderer = require('./RenderTemplates/LitRenderer');
6
+ const recursiveReadDir = require("recursive-readdir");
6
7
 
7
8
  const args = getopts(process.argv.slice(2), {
8
9
  alias: {
@@ -22,41 +23,70 @@ const onError = (place) => {
22
23
 
23
24
  const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
24
25
 
25
- const processFile = (file, outputDir) => {
26
-
27
- const litCode = hbs2lit(file);
28
-
26
+ const processFile = async (file, outputDir) => {
27
+ const litCode = await hbs2lit(file);
28
+ const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
29
29
  const componentNameMatcher = /(\w+)(\.hbs)/gim;
30
30
  const componentName = componentNameMatcher.exec(file)[1];
31
- writeRenderers(outputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
31
+
32
+ return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
33
+ };
34
+
35
+ const composeAbsoluteOutputDir = (file, outputDir) => {
36
+ // (1) Extract the dir structure from the source file path - "src/lvl1/lvl2/MyCompBadge.hbs"
37
+ // - remove the filename - "src/lvl1/lvl2"
38
+ // - remove the leading dir - "lvl1/lvl2"
39
+ const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
40
+
41
+ // (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
42
+ return `${outputDir}${path.sep}${fileDir}`;
32
43
  };
33
44
 
34
45
  const wrapDirectory = (directory, outputDir) => {
35
46
  directory = path.normalize(directory);
36
47
  outputDir = path.normalize(outputDir);
37
48
 
38
- fs.readdir(directory, (err, files) => {
39
-
40
- if (err) {
41
- onError('directory');
42
- }
49
+ return new Promise((resolve, reject) => {
50
+ recursiveReadDir(directory, (err, files) => {
43
51
 
44
- files.forEach(fileName => {
45
- if (isHandlebars(fileName)) {
46
- processFile(path.join(directory, fileName), outputDir);
52
+ if (err) {
53
+ onError('directory');
54
+ reject();
47
55
  }
56
+
57
+ const promises = files.map(fileName => {
58
+ if (isHandlebars(fileName)) {
59
+ return processFile(fileName, outputDir);
60
+ }
61
+ }).filter(x => !!x);
62
+
63
+ resolve(Promise.all(promises));
48
64
  });
49
- })
65
+ });
50
66
  };
51
67
 
52
- const writeRenderers = (outputDir, controlName, fileContent) => {
68
+ const writeRenderers = async (outputDir, controlName, fileContent) => {
53
69
  try {
70
+
71
+ await fs.mkdir(outputDir, { recursive: true });
72
+
54
73
  const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
55
74
 
56
75
  // strip DOS line endings because the break the source maps
57
76
  let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
58
77
  fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
59
- fs.writeFileSync(compiledFilePath, fileContentUnix);
78
+
79
+ // Only write to the file system actual changes - each updated file, no matter if the same or not, triggers an expensive operation for rollup
80
+ // Note: .hbs files that include a changed .hbs file will also be recompiled as their content will be updated too
81
+
82
+ let existingFileContent = "";
83
+ try {
84
+ existingFileContent = await fs.readFile(compiledFilePath);
85
+ } catch (e) {}
86
+
87
+ if (existingFileContent !== fileContentUnix) {
88
+ return fs.writeFile(compiledFilePath, fileContentUnix);
89
+ }
60
90
 
61
91
  } catch (e) {
62
92
  console.log(e);
@@ -66,5 +96,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
66
96
  if (!args['d'] || !args['o']) {
67
97
  console.log('Please provide an input and output directory (-d and -o)');
68
98
  } else {
69
- wrapDirectory(args['d'], args['o']);
99
+ wrapDirectory(args['d'], args['o']).then(() => {
100
+ console.log("Templates generated");
101
+ });
70
102
  }
@@ -1,74 +1,66 @@
1
- const fs = require('fs');
1
+ const fs = require('fs').promises;
2
2
  const path = require('path');
3
3
  const PropertiesReader = require('properties-reader');
4
- const mkdirp = require("mkdirp");
5
4
  const assets = require('../../assets-meta.js');
6
5
 
7
- const defaultLanguage = assets.languages.default;
6
+ const generate = async () => {
7
+ const defaultLanguage = assets.languages.default;
8
8
 
9
- const messageBundle = path.normalize(`${process.argv[2]}/messagebundle.properties`);
10
- const messageBundleDefaultLanguage = path.normalize(`${process.argv[2]}/messagebundle_${defaultLanguage}.properties`);
11
- const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.js`);
9
+ const messageBundle = path.normalize(`${process.argv[2]}/messagebundle.properties`);
10
+ const messageBundleDefaultLanguage = path.normalize(`${process.argv[2]}/messagebundle_${defaultLanguage}.properties`);
11
+ const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.js`);
12
12
 
13
- if (!messageBundle || !outputFile) {
14
- return;
15
- }
13
+ if (!messageBundle || !outputFile) {
14
+ return;
15
+ }
16
16
 
17
- const properties = PropertiesReader(messageBundle)._properties;
17
+ const properties = PropertiesReader(messageBundle)._properties;
18
18
 
19
- let defaultLanguageProperties;
20
- try {
21
- defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
22
- }
23
- catch (e) {}
19
+ let defaultLanguageProperties;
20
+ try {
21
+ defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
22
+ } catch (e) {
23
+ }
24
24
 
25
25
 
26
- /*
27
- * Returns the single text object to enable single export.
28
- *
29
- * Example:
30
- * const ARIA_LABEL_CARD_CONTENT = {
31
- * key: "ARIA_LABEL_CARD_CONTENT",
32
- * defaultText: "Card Content",
33
- * };
34
- */
35
- const getTextInfo = (key, value, defaultLanguageValue) => {
36
- let effectiveValue = defaultLanguageValue || value;
37
- effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
26
+ /*
27
+ * Returns the single text object to enable single export.
28
+ *
29
+ * Example:
30
+ * const ARIA_LABEL_CARD_CONTENT = {
31
+ * key: "ARIA_LABEL_CARD_CONTENT",
32
+ * defaultText: "Card Content",
33
+ * };
34
+ */
35
+ const getTextInfo = (key, value, defaultLanguageValue) => {
36
+ let effectiveValue = defaultLanguageValue || value;
37
+ effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
38
38
 
39
- return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
40
- };
39
+ return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
40
+ };
41
41
 
42
- /*
43
- * Returns the complete content of i18n-defaults.js file:
44
- * (1) the single text objects
45
- * (2) the export statement at the end of the file
46
- *
47
- * Example:
48
- * export {
49
- * ARIA_LABEL_CARD_CONTENT,
50
- * }
51
- */
52
- const getOutputFileContent = (properties, defaultLanguageProperties) => {
53
- const textKeys = Object.keys(properties);
54
- const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
42
+ /*
43
+ * Returns the complete content of i18n-defaults.js file:
44
+ * (1) the single text objects
45
+ * (2) the export statement at the end of the file
46
+ *
47
+ * Example:
48
+ * export {
49
+ * ARIA_LABEL_CARD_CONTENT,
50
+ * }
51
+ */
52
+ const getOutputFileContent = (properties, defaultLanguageProperties) => {
53
+ const textKeys = Object.keys(properties);
54
+ const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
55
55
 
56
- return `${texts}
56
+ return `${texts}
57
57
  export {${textKeys.join()}};`;
58
- };
59
-
60
- /*
61
- * Writes the i18n-defaults.js.
62
- */
63
- const writeI18nDefaultsFile = (file, content) => {
64
- fs.writeFile(file, content, (err) => {
65
- if (err) {
66
- return console.log(err);
67
- }
58
+ };
68
59
 
69
- console.log(`[i18n]: "${file}" file has been created`);
70
- });
60
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
61
+ await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
71
62
  };
72
63
 
73
- mkdirp.sync(path.dirname(outputFile));
74
- writeI18nDefaultsFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
64
+ generate().then(() => {
65
+ console.log("i18n default file generated.");
66
+ });