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

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 (86) hide show
  1. package/CHANGELOG.md +294 -0
  2. package/README.md +5 -6
  3. package/assets-meta.js +18 -1
  4. package/bin/dev.js +6 -5
  5. package/components-package/eslint.js +28 -0
  6. package/components-package/nps.js +94 -38
  7. package/components-package/postcss.themes.js +6 -3
  8. package/components-package/vite.config.js +12 -0
  9. package/components-package/wdio.js +73 -31
  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 +101 -54
  15. package/lib/create-illustrations/index.js +161 -0
  16. package/lib/create-new-component/index.js +17 -5
  17. package/lib/dev-server/dev-server.js +66 -0
  18. package/lib/dev-server/virtual-index-html-plugin.js +52 -0
  19. package/lib/esm-abs-to-rel/index.js +58 -0
  20. package/lib/generate-custom-elements-manifest/index.js +369 -0
  21. package/lib/generate-js-imports/illustrations.js +72 -0
  22. package/lib/generate-json-imports/i18n.js +74 -32
  23. package/lib/generate-json-imports/themes.js +65 -18
  24. package/lib/hbs2lit/src/compiler.js +20 -3
  25. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  26. package/lib/hbs2lit/src/litVisitor2.js +89 -15
  27. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  28. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +5 -5
  29. package/lib/hbs2ui5/index.js +50 -18
  30. package/lib/i18n/defaults.js +58 -57
  31. package/lib/i18n/toJSON.js +13 -12
  32. package/lib/jsdoc/config.json +1 -1
  33. package/lib/jsdoc/configTypescript.json +29 -0
  34. package/lib/jsdoc/plugin.js +65 -4
  35. package/lib/jsdoc/preprocess.js +60 -0
  36. package/lib/jsdoc/template/publish.js +32 -4
  37. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  38. package/lib/postcss-css-to-esm/index.js +33 -18
  39. package/lib/postcss-css-to-json/index.js +31 -11
  40. package/lib/postcss-new-files/index.js +36 -0
  41. package/lib/postcss-p/postcss-p.mjs +14 -0
  42. package/lib/replace-global-core/index.js +25 -0
  43. package/lib/scoping/get-all-tags.js +37 -0
  44. package/lib/scoping/lint-src.js +31 -0
  45. package/lib/scoping/missing-dependencies.js +65 -0
  46. package/lib/scoping/report-tags-usage.js +28 -0
  47. package/lib/scoping/scope-test-pages.js +40 -0
  48. package/lib/test-runner/test-runner.js +63 -0
  49. package/package.json +45 -52
  50. package/bin/init-ui5-package.js +0 -3
  51. package/components-package/rollup.js +0 -134
  52. package/components-package/serve.json +0 -3
  53. package/lib/documentation/index.js +0 -143
  54. package/lib/documentation/templates/api-component-since.js +0 -3
  55. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  56. package/lib/documentation/templates/api-events-section.js +0 -35
  57. package/lib/documentation/templates/api-methods-section.js +0 -26
  58. package/lib/documentation/templates/api-properties-section.js +0 -40
  59. package/lib/documentation/templates/api-slots-section.js +0 -28
  60. package/lib/documentation/templates/template.js +0 -38
  61. package/lib/init-package/index.js +0 -112
  62. package/lib/init-package/resources/.eslintignore +0 -3
  63. package/lib/init-package/resources/bundle.es5.js +0 -25
  64. package/lib/init-package/resources/bundle.esm.js +0 -34
  65. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  66. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  67. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  68. package/lib/init-package/resources/config/rollup.config.js +0 -1
  69. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  70. package/lib/init-package/resources/package-scripts.js +0 -11
  71. package/lib/init-package/resources/src/Assets.js +0 -5
  72. package/lib/init-package/resources/src/Demo.hbs +0 -1
  73. package/lib/init-package/resources/src/Demo.js +0 -56
  74. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  75. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  76. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  77. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  78. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  79. package/lib/init-package/resources/src/themes/Demo.css +0 -11
  80. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  81. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  82. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  83. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  84. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  85. package/lib/init-package/resources/test/pages/index.html +0 -51
  86. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
@@ -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
@@ -5,17 +5,37 @@ 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 = [];
14
34
  this.blocks = {};
15
35
  this.result = "";
16
36
  this.mainBlock = "";
17
- this.blockPath = "context";
18
- this.blockParameters = ["context"];
37
+ this.blockLevel = 0;
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,18 +51,17 @@ 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(", ") + ")";
38
58
  } else {
39
59
  this.mainBlock = this.currentKey();
40
- this.paths.push(this.blockPath);
41
60
  }
42
61
 
43
62
  this.blocks[this.currentKey()] += "html`";
44
63
  Visitor.prototype.Program.call(this, program);
45
- this.blocks[this.currentKey()] += "`; };";
64
+ this.blocks[this.currentKey()] += "`;";
46
65
 
47
66
  this.keys.pop(key);
48
67
  };
@@ -51,9 +70,24 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
51
70
  Visitor.prototype.ContentStatement.call(this, content);
52
71
  // let content = content.orgiinal; // attribute="__ attribute = "__ attribute ="__
53
72
 
54
- const contentStatement = content.original;
73
+ let contentStatement = content.original;
55
74
  skipIfDefined = !!dynamicAttributeRgx.exec(contentStatement);
56
75
 
76
+ const closingIndex = contentStatement.lastIndexOf(">");
77
+ const openingIndex = contentStatement.lastIndexOf("<");
78
+ if (closingIndex !== -1 || openingIndex !== -1) { // Only change isNodeValue whenever < or > is found in the content statement
79
+ isNodeValue = closingIndex > openingIndex;
80
+ }
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
+
57
91
  this.blocks[this.currentKey()] += contentStatement;
58
92
  };
59
93
 
@@ -65,13 +99,14 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
65
99
  } else {
66
100
  const path = normalizePath.call(this, mustache.path.original);
67
101
  const hasCalculatingClasses = path.includes("context.classes");
68
- const hasStylesCalculation = path.includes("context.styles");
69
102
 
70
103
  let parsedCode = "";
71
104
 
72
- if (hasCalculatingClasses) {
105
+ if (isNodeValue && !mustache.escaped) {
106
+ parsedCode = `\${unsafeHTML(${path})}`;
107
+ } else if (hasCalculatingClasses) {
73
108
  parsedCode = `\${classMap(${path})}`;
74
- } else if (hasStylesCalculation) {
109
+ } else if (isStyleAttribute) {
75
110
  parsedCode = `\${styleMap(${path})}`;
76
111
  } else if (skipIfDefined){
77
112
  parsedCode = `\${${path}}`;
@@ -137,7 +172,7 @@ function visitEachBlock(block) {
137
172
 
138
173
  this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
139
174
  this.paths.push(normalizePath.call(this, block.params[0].original));
140
- this.blockPath = "item";
175
+ this.blockLevel++;
141
176
 
142
177
  if (this.blockParameters.indexOf("item") === -1) {
143
178
  bParamAdded = true;
@@ -149,8 +184,7 @@ function visitEachBlock(block) {
149
184
  this.blockParameters.shift("item");
150
185
  this.blockParameters.shift("index");
151
186
  }
152
- this.blockPath = "context";
153
-
187
+ this.blockLevel--;
154
188
  this.blocks[this.currentKey()] += ") }";
155
189
  }
156
190
 
@@ -159,12 +193,52 @@ function normalizePath(sPath) {
159
193
 
160
194
  //read carefully - https://github.com/wycats/handlebars.js/issues/1028
161
195
  //kpdecker commented on May 20, 2015
162
- if (result.indexOf("../") === 0) {
163
- 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
+
164
220
  result = replaceAll(path.normalize(absolutePath), path.sep, ".");
221
+
165
222
  } else {
166
- 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;
167
240
  }
241
+
168
242
  return result;
169
243
  }
170
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,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,75 @@
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
+ // Merge messagebundle.properties and messagebundle_en.properties files to generate the default texts.
26
+ // Note:
27
+ // (1) at DEV time, it's intuituve to work with the source bundle file - the messagebundle.properties,
28
+ // and see the changes there take effect.
29
+ // (2) as the messagebundle.properties file is always written in English,
30
+ // it makes sense to consider the messagebundle.properties content only when the default language is "en".
31
+ if (defaultLanguage === "en") {
32
+ defaultLanguageProperties = Object.assign({}, defaultLanguageProperties, properties);
33
+ }
25
34
 
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
35
+ /*
36
+ * Returns the single text object to enable single export.
37
+ *
38
+ * Example:
39
+ * const ARIA_LABEL_CARD_CONTENT = {
40
+ * key: "ARIA_LABEL_CARD_CONTENT",
41
+ * defaultText: "Card Content",
42
+ * };
43
+ */
44
+ const getTextInfo = (key, value, defaultLanguageValue) => {
45
+ let effectiveValue = defaultLanguageValue || value;
46
+ effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
38
47
 
39
- return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
40
- };
48
+ return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
49
+ };
41
50
 
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('');
51
+ /*
52
+ * Returns the complete content of i18n-defaults.js file:
53
+ * (1) the single text objects
54
+ * (2) the export statement at the end of the file
55
+ *
56
+ * Example:
57
+ * export {
58
+ * ARIA_LABEL_CARD_CONTENT,
59
+ * }
60
+ */
61
+ const getOutputFileContent = (properties, defaultLanguageProperties) => {
62
+ const textKeys = Object.keys(properties);
63
+ const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
55
64
 
56
- return `${texts}
65
+ return `${texts}
57
66
  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
- }
67
+ };
68
68
 
69
- console.log(`[i18n]: "${file}" file has been created`);
70
- });
69
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
70
+ await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
71
71
  };
72
72
 
73
- mkdirp.sync(path.dirname(outputFile));
74
- writeI18nDefaultsFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
73
+ generate().then(() => {
74
+ console.log("i18n default file generated.");
75
+ });
@@ -8,18 +8,16 @@
8
8
  * The 2nd param './../dist/generated/assets/i18n' is where the JSON files would be written to.
9
9
  */
10
10
  const path = require("path");
11
- const glob = require("glob");
12
11
  const PropertiesReader = require('properties-reader');
13
- const fs = require('fs');
12
+ const fs = require('fs').promises;
14
13
  const assets = require('../../assets-meta.js');
15
- const mkdirp = require("mkdirp");
16
14
 
17
15
  const allLanguages = assets.languages.all;
18
16
 
19
17
  const messagesBundles = path.normalize(`${process.argv[2]}/messagebundle_*.properties`);
20
18
  const messagesJSONDist = path.normalize(`${process.argv[3]}`);
21
19
 
22
- const convertToJSON = (file) => {
20
+ const convertToJSON = async (file) => {
23
21
  const properties = PropertiesReader(file)._properties;
24
22
  const filename = path.basename(file, path.extname(file));
25
23
  const language = filename.match(/^messagebundle_(.*?)$/)[1];
@@ -29,14 +27,17 @@ const messagesJSONDist = path.normalize(`${process.argv[3]}`);
29
27
  }
30
28
  const outputFile = path.normalize(`${messagesJSONDist}/${filename}.json`);
31
29
 
32
- fs.writeFileSync(outputFile, JSON.stringify(properties));
33
- console.log(`[i18n]: "${filename}.json" has been generated!`);
30
+ return fs.writeFile(outputFile, JSON.stringify(properties));
31
+ // console.log(`[i18n]: "${filename}.json" has been generated!`);
34
32
  };
35
33
 
36
- mkdirp.sync(messagesJSONDist);
37
- glob(messagesBundles, {}, (err, files) => {
38
- if (err) {
39
- return console.log("No messagebundle files found!");
40
- }
41
- files.forEach(convertToJSON);
34
+ const generate = async () => {
35
+ const { globby } = await import("globby");
36
+ await fs.mkdir(messagesJSONDist, { recursive: true });
37
+ const files = await globby(messagesBundles);
38
+ return Promise.all(files.map(convertToJSON));
39
+ };
40
+
41
+ generate().then(() => {
42
+ console.log("Message bundle JSON files generated.");
42
43
  });
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "source": {
3
3
  "include": "src",
4
- "excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js"
4
+ "excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
5
5
  },
6
6
  "opts" : {
7
7
  "recurse": true,
@@ -0,0 +1,29 @@
1
+ {
2
+ "source": {
3
+ "include": "jsdoc-dist",
4
+ "excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
5
+ },
6
+ "opts" : {
7
+ "recurse": true,
8
+ "template" : "template",
9
+ "destination": ""
10
+ },
11
+ "plugins": [
12
+ "./plugin.js"
13
+ ],
14
+ "templates" : {
15
+ "ui5" : {
16
+ "variants": [
17
+ "apijson"
18
+ ],
19
+ "version": "1.62",
20
+ "apiJsonFolder": "",
21
+ "apiJsonFile": "dist/api.json",
22
+ "includeSettingsInConstructor": false
23
+ }
24
+ },
25
+ "tags": {
26
+ "allowUnknownTags": true,
27
+ "dictionaries": ["jsdoc"]
28
+ }
29
+ }