@ui5/webcomponents-tools 0.0.0-f1f9d888f → 0.0.0-f651a470c

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 (91) hide show
  1. package/CHANGELOG.md +447 -0
  2. package/README.md +5 -6
  3. package/assets-meta.js +16 -1
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +34 -0
  6. package/components-package/nps.js +103 -50
  7. package/components-package/postcss.components.js +13 -13
  8. package/components-package/postcss.themes.js +19 -16
  9. package/components-package/vite.config.js +13 -0
  10. package/components-package/wdio.js +393 -344
  11. package/components-package/wdio.sync.js +360 -0
  12. package/icons-collection/nps.js +51 -10
  13. package/lib/copy-and-watch/index.js +30 -5
  14. package/lib/copy-list/index.js +28 -0
  15. package/lib/create-icons/index.js +124 -52
  16. package/lib/create-illustrations/index.js +161 -0
  17. package/lib/create-new-component/index.js +108 -103
  18. package/lib/create-new-component/jsFileContentTemplate.js +77 -0
  19. package/lib/create-new-component/tsFileContentTemplate.js +84 -0
  20. package/lib/dev-server/dev-server.js +66 -0
  21. package/lib/dev-server/virtual-index-html-plugin.js +52 -0
  22. package/lib/esm-abs-to-rel/index.js +58 -0
  23. package/lib/generate-custom-elements-manifest/index.js +327 -0
  24. package/lib/generate-js-imports/illustrations.js +72 -0
  25. package/lib/generate-json-imports/i18n.js +75 -30
  26. package/lib/generate-json-imports/themes.js +62 -24
  27. package/lib/hbs2lit/src/compiler.js +20 -3
  28. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  29. package/lib/hbs2lit/src/litVisitor2.js +77 -14
  30. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  31. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +4 -11
  32. package/lib/hbs2ui5/index.js +37 -21
  33. package/lib/i18n/defaults.js +65 -57
  34. package/lib/i18n/toJSON.js +13 -12
  35. package/lib/jsdoc/configTypescript.json +29 -0
  36. package/lib/jsdoc/plugin.js +62 -1
  37. package/lib/jsdoc/preprocess.js +146 -0
  38. package/lib/jsdoc/template/publish.js +30 -2
  39. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  40. package/lib/postcss-css-to-esm/index.js +64 -16
  41. package/lib/postcss-css-to-json/index.js +31 -11
  42. package/lib/postcss-new-files/index.js +36 -0
  43. package/lib/postcss-p/postcss-p.mjs +14 -0
  44. package/lib/replace-global-core/index.js +25 -0
  45. package/lib/scoping/get-all-tags.js +1 -8
  46. package/lib/scoping/lint-src.js +1 -1
  47. package/lib/scoping/missing-dependencies.js +65 -0
  48. package/lib/scoping/report-tags-usage.js +28 -0
  49. package/lib/scoping/scope-test-pages.js +1 -1
  50. package/lib/test-runner/test-runner.js +71 -0
  51. package/package.json +51 -53
  52. package/bin/init-ui5-package.js +0 -3
  53. package/components-package/rollup.js +0 -147
  54. package/components-package/serve.json +0 -3
  55. package/lib/documentation/index.js +0 -143
  56. package/lib/documentation/templates/api-component-since.js +0 -3
  57. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  58. package/lib/documentation/templates/api-events-section.js +0 -35
  59. package/lib/documentation/templates/api-methods-section.js +0 -26
  60. package/lib/documentation/templates/api-properties-section.js +0 -40
  61. package/lib/documentation/templates/api-slots-section.js +0 -28
  62. package/lib/documentation/templates/template.js +0 -38
  63. package/lib/init-package/index.js +0 -123
  64. package/lib/init-package/resources/.eslintignore +0 -3
  65. package/lib/init-package/resources/bundle.es5.js +0 -25
  66. package/lib/init-package/resources/bundle.esm.js +0 -34
  67. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  68. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  69. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  70. package/lib/init-package/resources/config/rollup.config.js +0 -1
  71. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  72. package/lib/init-package/resources/package-scripts.js +0 -11
  73. package/lib/init-package/resources/src/Assets.js +0 -5
  74. package/lib/init-package/resources/src/MyFirstComponent.hbs +0 -1
  75. package/lib/init-package/resources/src/MyFirstComponent.js +0 -56
  76. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  77. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  78. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  79. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  80. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  81. package/lib/init-package/resources/src/themes/MyFirstComponent.css +0 -11
  82. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  83. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  84. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  85. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  86. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  87. package/lib/init-package/resources/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
  88. package/lib/init-package/resources/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
  89. package/lib/init-package/resources/test/pages/index.html +0 -56
  90. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
  91. package/package-lock.json +0 -48
@@ -1,35 +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
3
 
5
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
4
+ const generate = async () => {
6
5
 
7
- const inputFolder = path.normalize(process.argv[2]);
8
- const outputFile = path.normalize(`${process.argv[3]}/i18n.js`);
6
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
7
+
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`);
9
11
 
10
12
  // All languages present in the file system
11
- const files = fs.readdirSync(inputFolder);
12
- const languages = files.map(file => {
13
- const matches = file.match(/messagebundle_(.+?).json$/);
14
- return matches ? matches[1] : undefined;
15
- }).filter(key => !!key);
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);
16
18
 
17
- let content;
19
+ let contentStatic, contentDynamic;
18
20
 
19
21
  // No i18n - just import dependencies, if any
20
- if (languages.length === 0) {
21
- content = ``;
22
+ if (languages.length === 0) {
23
+ contentStatic = "";
24
+ contentDynamic = "";
22
25
  // There is i18n - generate the full file
23
- } else {
24
-
25
- // Keys for the array
26
- const languagesKeysString = languages.map(key => `${key},`).join("\n\t");
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
- // Actual imports for json assets
29
- const assetsImportsString = languages.map(key => `import ${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
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
- // Resulting file content
32
- 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";
33
36
 
34
37
  ${assetsImportsString}
35
38
 
@@ -37,17 +40,59 @@ const bundleMap = {
37
40
  ${languagesKeysString}
38
41
  };
39
42
 
40
- const allEntriesInlined = Object.entries(bundleMap).every(([_key, value]) => typeof (value) === "object");
41
-
42
- if (allEntriesInlined) {
43
- console.warn(\`Inefficient bundling detected: consider bundling i18n imports as URLs instead of inlining them.
44
- See rollup-plugin-url or webpack file-loader for more information.
45
- 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()
46
49
  }
47
50
 
48
- registerI18nBundle("${packageName}", bundleMap);
51
+ const localeIds = [${languagesKeysStringArray}];
52
+
53
+ localeIds.forEach(localeId => {
54
+ registerI18nLoader("${packageName}", localeId, fetchMessageBundle);
55
+ });
49
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
+ ]);
50
94
  }
51
95
 
52
- mkdirp.sync(path.dirname(outputFile));
53
- fs.writeFileSync(outputFile, content);
96
+ generate().then(() => {
97
+ console.log("Generated i18n JSON imports.");
98
+ });
@@ -1,42 +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 inputFolder = path.normalize(process.argv[2]);
7
- const outputFile = path.normalize(`${process.argv[3]}/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`);
8
9
 
9
10
  // All supported optional themes
10
- const optionalThemes = assets.themes.all.filter(theme => theme !== assets.themes.default);
11
+ const allThemes = assets.themes.all;
11
12
 
12
13
  // All themes present in the file system
13
- const dirs = fs.readdirSync(inputFolder);
14
- const themesOnFileSystem = dirs.map(dir => {
15
- const matches = dir.match(/sap_.*$/);
16
- return matches ? dir : undefined;
17
- }).filter(key => !!key && optionalThemes.includes(key));
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));
18
19
 
19
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
20
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
20
21
 
21
- const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
22
- const isInlinedCondition = themesOnFileSystem.map(theme => `isInlined(${theme})`).join(" || ");
23
- const registerLines = themesOnFileSystem.map(theme => `registerThemeProperties("${packageName}", "${theme}", ${theme});`).join("\n");
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");
24
26
 
25
- // Resulting file content
26
- const content = `import { registerThemeProperties } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
27
+
28
+ // static imports file content
29
+ const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
27
30
 
28
31
  ${importLines}
29
32
 
33
+ const themeUrlsByName = ${themeUrlsByName};
30
34
  const isInlined = obj => typeof (obj) === "object";
31
35
 
32
- if (${isInlinedCondition}) {
33
- console.warn(\`Inefficient bundling detected: consider bundling theme properties imports as URLs instead of inlining them.
34
- See rollup-plugin-url or webpack file-loader for more information.
35
- Suggested pattern: "assets\\\\\\/.*\\\\\\.json"\`);
36
- }
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();
42
+ };
43
+
44
+ ${availableThemesArray}
45
+ .forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
46
+ `;
47
+
37
48
 
38
- ${registerLines}
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));
39
69
  `;
40
70
 
41
- mkdirp.sync(path.dirname(outputFile));
42
- fs.writeFileSync(outputFile, content);
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,11 +12,19 @@ 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
 
20
+ // icons hack
21
+ if (sPreprocessed.startsWith("<g ") || sPreprocessed.startsWith("<g>")) {
22
+ return `
23
+ let block0 = () => {
24
+ return svg\`${sPreprocessed}\`
25
+ }`;
26
+ }
27
+
20
28
  const ast = Handlebars.parse(sPreprocessed);
21
29
 
22
30
  const pv = new PartialsVisitor();
@@ -30,7 +38,16 @@ const hbs2lit = (file) => {
30
38
  lv.accept(ast);
31
39
 
32
40
  for (let key in lv.blocks) {
33
- result += lv.blocks[key] + "\n";
41
+ let block = lv.blocks[key];
42
+
43
+ if (block.match(/scopeTag/)) {
44
+ const matches = block.match(/^(.*?)( => )(.*?);$/);
45
+ const scopedCode = matches[3];
46
+ const normalCode = scopedCode.replace(/\${scopeTag\("/g, "").replace(/", tags, suffix\)}/g, "");
47
+ block = `${matches[1]}${matches[2]}suffix ? ${scopedCode} : ${normalCode};`;
48
+ }
49
+
50
+ result += block + "\n";
34
51
  }
35
52
 
36
53
  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
@@ -8,17 +8,34 @@ let skipIfDefined = false;
8
8
  // when true => an HTML node value, when false => an attribute value
9
9
  let isNodeValue = false;
10
10
 
11
+ // when true => the current attribute is "style"
12
+ let isStyleAttribute = false;
13
+
11
14
  // matches event handlers @click= and boolean attrs ?disabled=
12
15
  const dynamicAttributeRgx = /\s(\?|@)([a-zA-Z|-]+)="?\s*$/;
13
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
+
14
31
  function HTMLLitVisitor(debug) {
15
32
  this.blockCounter = 0;
16
33
  this.keys = [];
17
34
  this.blocks = {};
18
35
  this.result = "";
19
36
  this.mainBlock = "";
20
- this.blockPath = "context";
21
- this.blockParameters = ["context"];
37
+ this.blockLevel = 0;
38
+ this.blockParameters = ["context", "tags", "suffix"];
22
39
  this.paths = []; //contains all normalized relative paths
23
40
  this.debug = debug;
24
41
  if (this.debug) {
@@ -34,18 +51,17 @@ HTMLLitVisitor.prototype.Program = function(program) {
34
51
  this.keys.push(key);
35
52
  this.debug && this.blockByNumber.push(key);
36
53
 
37
- this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => { return ";
54
+ this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
38
55
 
39
56
  if (this.keys.length > 1) { //it's a nested block
40
57
  this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
41
58
  } else {
42
59
  this.mainBlock = this.currentKey();
43
- this.paths.push(this.blockPath);
44
60
  }
45
61
 
46
62
  this.blocks[this.currentKey()] += "html`";
47
63
  Visitor.prototype.Program.call(this, program);
48
- this.blocks[this.currentKey()] += "`; };";
64
+ this.blocks[this.currentKey()] += "`;";
49
65
 
50
66
  this.keys.pop(key);
51
67
  };
@@ -54,7 +70,7 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
54
70
  Visitor.prototype.ContentStatement.call(this, content);
55
71
  // let content = content.orgiinal; // attribute="__ attribute = "__ attribute ="__
56
72
 
57
- const contentStatement = content.original;
73
+ let contentStatement = content.original;
58
74
  skipIfDefined = !!dynamicAttributeRgx.exec(contentStatement);
59
75
 
60
76
  const closingIndex = contentStatement.lastIndexOf(">");
@@ -63,6 +79,15 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
63
79
  isNodeValue = closingIndex > openingIndex;
64
80
  }
65
81
 
82
+ isStyleAttribute = !isNodeValue && contentStatement.match(/style *= *["']? *$/);
83
+
84
+ if (!isStyleAttribute && contentStatement.match(/style=/)) {
85
+ console.log("WARNING: style hard-coded", contentStatement);
86
+ }
87
+
88
+ // Scope custom element tags
89
+ contentStatement = contentStatement.replaceAll(/(<\/?\s*)([a-zA-Z0-9_]+-[a-zA-Z0-9_-]+)/g, "$1\${scopeTag(\"$2\", tags, suffix)}");
90
+
66
91
  this.blocks[this.currentKey()] += contentStatement;
67
92
  };
68
93
 
@@ -74,7 +99,6 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
74
99
  } else {
75
100
  const path = normalizePath.call(this, mustache.path.original);
76
101
  const hasCalculatingClasses = path.includes("context.classes");
77
- const hasStylesCalculation = path.includes("context.styles");
78
102
 
79
103
  let parsedCode = "";
80
104
 
@@ -82,7 +106,7 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
82
106
  parsedCode = `\${unsafeHTML(${path})}`;
83
107
  } else if (hasCalculatingClasses) {
84
108
  parsedCode = `\${classMap(${path})}`;
85
- } else if (hasStylesCalculation) {
109
+ } else if (isStyleAttribute) {
86
110
  parsedCode = `\${styleMap(${path})}`;
87
111
  } else if (skipIfDefined){
88
112
  parsedCode = `\${${path}}`;
@@ -148,7 +172,7 @@ function visitEachBlock(block) {
148
172
 
149
173
  this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
150
174
  this.paths.push(normalizePath.call(this, block.params[0].original));
151
- this.blockPath = "item";
175
+ this.blockLevel++;
152
176
 
153
177
  if (this.blockParameters.indexOf("item") === -1) {
154
178
  bParamAdded = true;
@@ -160,8 +184,7 @@ function visitEachBlock(block) {
160
184
  this.blockParameters.shift("item");
161
185
  this.blockParameters.shift("index");
162
186
  }
163
- this.blockPath = "context";
164
-
187
+ this.blockLevel--;
165
188
  this.blocks[this.currentKey()] += ") }";
166
189
  }
167
190
 
@@ -170,12 +193,52 @@ function normalizePath(sPath) {
170
193
 
171
194
  //read carefully - https://github.com/wycats/handlebars.js/issues/1028
172
195
  //kpdecker commented on May 20, 2015
173
- if (result.indexOf("../") === 0) {
174
- let absolutePath = replaceAll(this.paths[this.paths.length - 1], ".", "/") + "/" + result;
196
+
197
+ if (result.indexOf("@root") === 0) {
198
+ // Trying to access root context via the HBS "@root" variable.
199
+ // Example: {{@root.property}} compiles to "context.property" - called from anywhere within the template.
200
+ result = result.replace("@root", "context");
201
+
202
+ } else if (result.indexOf("../") === 0) {
203
+ let absolutePath;
204
+ const levelsUp = (result.match(/..\//g) || []).length;
205
+
206
+ if (this.blockLevel <= levelsUp) {
207
+ // Trying to access root context from nested loops.
208
+ // Example: {{../../property}} compiles to "context.property" - when currently in a nested level loop.
209
+ // Example: {{../../../property}} compile to "context.property" - when requested levels are not present. fallback to root context.
210
+ absolutePath = `context.${replaceAll(result,"../", "")}`;
211
+ } else {
212
+ // Trying to access upper context (one-level-up) and based on the current lelev, that could be "context" or "item".
213
+ // Example: {{../property}} compiles to "context.property" - when called in a top level loop.
214
+ // Example: {{../property}} compiles to "item.property" - when called in a nested level loop.
215
+ // TODO: the second example, although correctly generated to "item.property", "item" will point to the current object within the nested loop,
216
+ // not the upper level loop as intended. So accessing the upper loop from nested loop is currently not working.
217
+ absolutePath = replaceAll(this.paths[this.paths.length - 1 - levelsUp], ".", "/") + "/" + result;
218
+ }
219
+
175
220
  result = replaceAll(path.normalize(absolutePath), path.sep, ".");
221
+
176
222
  } else {
177
- result = result ? replaceAll(this.blockPath + "/" + result, "/", ".") : this.blockPath;
223
+ // When neither "@root", nor "../" are used, use the following contexts:
224
+ // - use "context" - for the top level of execution, e.g "this.blockLevel = 0".
225
+ // - use "item" - for any nested level, e.g "this.blockLevel > 0".
226
+ // Example:
227
+ //
228
+ // {{text}} -> compiles to "context.text"
229
+ // {{#each items}}
230
+ // Item text: {{text}}</div> -> compiles to "item.text"
231
+ // {{#each words}}
232
+ // Word text: {{text}}</div> -> compiles to "item.text"
233
+ // {{/each}}
234
+ // Item text: {{text}}</div> -> compiles to "item.text"
235
+ // {{/each}}
236
+ // {{text}} -> compiles to "context.text"
237
+
238
+ const blockPath = this.blockLevel > 0 ? "item" : "context";
239
+ result = result ? replaceAll(blockPath + "/" + result, "/", ".") : blockPath;
178
240
  }
241
+
179
242
  return result;
180
243
  }
181
244
 
@@ -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,17 +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, unsafeHTML, setTags, setSuffix } 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
6
 
8
- const main = (context, tags, suffix) => {
9
- setTags(tags);
10
- setSuffix(suffix);
11
- return block0(context);
12
- };
13
-
14
- export default main;`
7
+ export default block0;`;
15
8
  };
16
9
 
17
10
  module.exports = {
@@ -1,10 +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
6
  const recursiveReadDir = require("recursive-readdir");
7
- const mkdirp = require('mkdirp');
8
7
 
9
8
  const args = getopts(process.argv.slice(2), {
10
9
  alias: {
@@ -24,13 +23,13 @@ const onError = (place) => {
24
23
 
25
24
  const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
26
25
 
27
- const processFile = (file, outputDir) => {
28
- const litCode = hbs2lit(file);
26
+ const processFile = async (file, outputDir) => {
27
+ const litCode = await hbs2lit(file);
29
28
  const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
30
29
  const componentNameMatcher = /(\w+)(\.hbs)/gim;
31
30
  const componentName = componentNameMatcher.exec(file)[1];
32
31
 
33
- writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
32
+ return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
34
33
  };
35
34
 
36
35
  const composeAbsoluteOutputDir = (file, outputDir) => {
@@ -40,39 +39,54 @@ const composeAbsoluteOutputDir = (file, outputDir) => {
40
39
  const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
41
40
 
42
41
  // (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
43
- return `${outputDir}${path.sep}${fileDir}`;
42
+ return `${outputDir}${path.sep}${fileDir}`;
44
43
  };
45
44
 
46
45
  const wrapDirectory = (directory, outputDir) => {
47
46
  directory = path.normalize(directory);
48
47
  outputDir = path.normalize(outputDir);
49
48
 
50
- recursiveReadDir(directory, (err, files) => {
49
+ return new Promise((resolve, reject) => {
50
+ recursiveReadDir(directory, (err, files) => {
51
51
 
52
- if (err) {
53
- onError('directory');
54
- }
55
-
56
- files.forEach(fileName => {
57
- if (isHandlebars(fileName)) {
58
- processFile(fileName, outputDir);
52
+ if (err) {
53
+ onError('directory');
54
+ reject();
59
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));
60
64
  });
61
- })
65
+ });
62
66
  };
63
67
 
64
- const writeRenderers = (outputDir, controlName, fileContent) => {
68
+ const writeRenderers = async (outputDir, controlName, fileContent) => {
65
69
  try {
66
- if (!fs.existsSync(outputDir)) {
67
- mkdirp.sync(outputDir);
68
- }
70
+
71
+ await fs.mkdir(outputDir, { recursive: true });
69
72
 
70
73
  const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
71
74
 
72
75
  // strip DOS line endings because the break the source maps
73
76
  let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
74
77
  fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
75
- 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
+ }
76
90
 
77
91
  } catch (e) {
78
92
  console.log(e);
@@ -82,5 +96,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
82
96
  if (!args['d'] || !args['o']) {
83
97
  console.log('Please provide an input and output directory (-d and -o)');
84
98
  } else {
85
- wrapDirectory(args['d'], args['o']);
99
+ wrapDirectory(args['d'], args['o']).then(() => {
100
+ console.log("Templates generated");
101
+ });
86
102
  }