@ui5/webcomponents-tools 0.0.0-fb61e9889 → 0.0.0-fca1107e7

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 (82) hide show
  1. package/CHANGELOG.md +980 -0
  2. package/README.md +6 -6
  3. package/assets-meta.js +16 -3
  4. package/bin/dev.js +1 -5
  5. package/components-package/eslint.js +36 -0
  6. package/components-package/nps.js +108 -70
  7. package/components-package/postcss.components.js +1 -21
  8. package/components-package/postcss.themes.js +1 -23
  9. package/components-package/vite.config.js +13 -0
  10. package/components-package/wdio.js +405 -353
  11. package/components-package/wdio.sync.js +26 -2
  12. package/icons-collection/nps.js +51 -18
  13. package/lib/amd-to-es6/index.js +102 -0
  14. package/lib/amd-to-es6/no-remaining-require.js +33 -0
  15. package/lib/cem/custom-elements-manifest.config.mjs +501 -0
  16. package/lib/cem/event.mjs +131 -0
  17. package/lib/cem/schema-internal.json +1357 -0
  18. package/lib/cem/schema.json +1098 -0
  19. package/lib/cem/types-internal.d.ts +796 -0
  20. package/lib/cem/types.d.ts +736 -0
  21. package/lib/cem/utils.mjs +384 -0
  22. package/lib/cem/validate.js +70 -0
  23. package/lib/copy-and-watch/index.js +24 -1
  24. package/lib/copy-list/index.js +17 -17
  25. package/lib/create-icons/index.js +124 -58
  26. package/lib/create-illustrations/index.js +153 -66
  27. package/lib/create-new-component/index.js +71 -104
  28. package/lib/create-new-component/jsFileContentTemplate.js +73 -0
  29. package/lib/create-new-component/tsFileContentTemplate.js +71 -0
  30. package/lib/css-processors/css-processor-component-styles.mjs +47 -0
  31. package/lib/css-processors/css-processor-components.mjs +77 -0
  32. package/lib/css-processors/css-processor-themes.mjs +79 -0
  33. package/lib/css-processors/scope-variables.mjs +49 -0
  34. package/lib/css-processors/shared.mjs +76 -0
  35. package/lib/dev-server/custom-hot-update-plugin.js +39 -0
  36. package/lib/dev-server/dev-server.js +66 -0
  37. package/lib/dev-server/virtual-index-html-plugin.js +52 -0
  38. package/lib/generate-custom-elements-manifest/index.js +271 -0
  39. package/lib/generate-js-imports/illustrations.js +86 -0
  40. package/lib/generate-json-imports/i18n.js +43 -31
  41. package/lib/generate-json-imports/themes.js +36 -24
  42. package/lib/hbs2lit/src/compiler.js +24 -4
  43. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  44. package/lib/hbs2lit/src/litVisitor2.js +95 -24
  45. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  46. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +32 -4
  47. package/lib/hbs2ui5/index.js +56 -23
  48. package/lib/i18n/defaults.js +65 -57
  49. package/lib/i18n/toJSON.js +12 -11
  50. package/lib/jsdoc/configTypescript.json +29 -0
  51. package/lib/jsdoc/plugin.js +41 -0
  52. package/lib/jsdoc/preprocess.js +146 -0
  53. package/lib/jsdoc/template/publish.js +21 -2
  54. package/lib/postcss-combine-duplicated-selectors/index.js +185 -0
  55. package/lib/scoping/get-all-tags.js +2 -9
  56. package/lib/scoping/missing-dependencies.js +65 -0
  57. package/lib/scoping/report-tags-usage.js +28 -0
  58. package/lib/scoping/scope-test-pages.js +2 -1
  59. package/lib/test-runner/test-runner.js +71 -0
  60. package/package.json +32 -29
  61. package/components-package/rollup-plugins/empty-module.js +0 -15
  62. package/components-package/rollup.js +0 -237
  63. package/lib/documentation/index.js +0 -165
  64. package/lib/documentation/templates/api-component-since.js +0 -3
  65. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  66. package/lib/documentation/templates/api-events-section.js +0 -35
  67. package/lib/documentation/templates/api-methods-section.js +0 -26
  68. package/lib/documentation/templates/api-properties-section.js +0 -40
  69. package/lib/documentation/templates/api-slots-section.js +0 -28
  70. package/lib/documentation/templates/template.js +0 -38
  71. package/lib/esm-abs-to-rel/index.js +0 -54
  72. package/lib/hash/config.js +0 -10
  73. package/lib/hash/generate.js +0 -19
  74. package/lib/hash/upToDate.js +0 -31
  75. package/lib/polyfill-placeholder/index.js +0 -5
  76. package/lib/postcss-css-to-esm/index.js +0 -45
  77. package/lib/postcss-css-to-json/index.js +0 -31
  78. package/lib/postcss-new-files/index.js +0 -36
  79. package/lib/replace-global-core/index.js +0 -20
  80. package/lib/serve/index.js +0 -46
  81. package/lib/serve/serve.json +0 -3
  82. package/package-lock.json +0 -48
@@ -8,6 +8,9 @@ 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
 
@@ -25,14 +28,18 @@ if (!String.prototype.replaceAll) {
25
28
  };
26
29
  }
27
30
 
28
- function HTMLLitVisitor(debug) {
31
+ function HTMLLitVisitor(componentName, debug) {
29
32
  this.blockCounter = 0;
30
33
  this.keys = [];
31
34
  this.blocks = {};
32
35
  this.result = "";
33
36
  this.mainBlock = "";
34
- this.blockPath = "context";
35
- this.blockParameters = ["context", "tags", "suffix"];
37
+ this.blockLevel = 0;
38
+ this.componentName = componentName
39
+ const blockParametersDefinitionTS = [`this: ${componentName}`, "context: UI5Element", "tags: string[]", "suffix: string | undefined"];
40
+ const blockParametersDefinitionJS = ["context", "tags", "suffix"];
41
+ this.blockParametersDefinition = process.env.UI5_TS ? blockParametersDefinitionTS : blockParametersDefinitionJS;
42
+ this.blockParametersUsage = ["this", "context", "tags", "suffix"];
36
43
  this.paths = []; //contains all normalized relative paths
37
44
  this.debug = debug;
38
45
  if (this.debug) {
@@ -48,18 +55,18 @@ HTMLLitVisitor.prototype.Program = function(program) {
48
55
  this.keys.push(key);
49
56
  this.debug && this.blockByNumber.push(key);
50
57
 
51
- this.blocks[this.currentKey()] = "const " + this.currentKey() + " = (" + this.blockParameters.join(", ") + ") => ";
58
+ // this.blocks[this.currentKey()] = "function " + this.currentKey() + ` (this: any, ` + this.blockParametersDefinition.join(", ") + ") { ";
59
+ this.blocks[this.currentKey()] = `function ${this.currentKey()} (${this.blockParametersDefinition.join(", ")}) { `;
52
60
 
53
61
  if (this.keys.length > 1) { //it's a nested block
54
- this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
62
+ this.blocks[this.prevKey()] += this.currentKey() + ".call(" + this.blockParametersUsage.join(", ") + ")";
55
63
  } else {
56
64
  this.mainBlock = this.currentKey();
57
- this.paths.push(this.blockPath);
58
65
  }
59
66
 
60
- this.blocks[this.currentKey()] += "html`";
67
+ this.blocks[this.currentKey()] += "return html`";
61
68
  Visitor.prototype.Program.call(this, program);
62
- this.blocks[this.currentKey()] += "`;";
69
+ this.blocks[this.currentKey()] += "`;}";
63
70
 
64
71
  this.keys.pop(key);
65
72
  };
@@ -77,6 +84,12 @@ HTMLLitVisitor.prototype.ContentStatement = function(content) {
77
84
  isNodeValue = closingIndex > openingIndex;
78
85
  }
79
86
 
87
+ isStyleAttribute = !isNodeValue && contentStatement.match(/style *= *["']? *$/);
88
+
89
+ if (!isStyleAttribute && contentStatement.match(/style=/)) {
90
+ console.log("WARNING: style hard-coded", contentStatement);
91
+ }
92
+
80
93
  // Scope custom element tags
81
94
  contentStatement = contentStatement.replaceAll(/(<\/?\s*)([a-zA-Z0-9_]+-[a-zA-Z0-9_-]+)/g, "$1\${scopeTag(\"$2\", tags, suffix)}");
82
95
 
@@ -90,16 +103,19 @@ HTMLLitVisitor.prototype.MustacheStatement = function(mustache) {
90
103
  this.blocks[this.currentKey()] += "${index}";
91
104
  } else {
92
105
  const path = normalizePath.call(this, mustache.path.original);
93
- const hasCalculatingClasses = path.includes("context.classes");
94
- const hasStylesCalculation = path.includes("context.styles");
106
+ const hasCalculatingClasses = path.includes("this.classes");
95
107
 
96
108
  let parsedCode = "";
97
109
 
98
110
  if (isNodeValue && !mustache.escaped) {
99
111
  parsedCode = `\${unsafeHTML(${path})}`;
100
112
  } else if (hasCalculatingClasses) {
101
- parsedCode = `\${classMap(${path})}`;
102
- } else if (hasStylesCalculation) {
113
+ if (process.env.UI5_TS) {
114
+ parsedCode = `\${classMap(${path} as ClassMapValue)}`;
115
+ } else {
116
+ parsedCode = `\${classMap(${path})}`;
117
+ }
118
+ } else if (isStyleAttribute) {
103
119
  parsedCode = `\${styleMap(${path})}`;
104
120
  } else if (skipIfDefined){
105
121
  parsedCode = `\${${path}}`;
@@ -163,22 +179,37 @@ function visitEachBlock(block) {
163
179
  var bParamAdded = false;
164
180
  visitSubExpression.call(this, block);
165
181
 
166
- this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
182
+ const reapeatDirectiveParamsTS = "(item, index) => (item as typeof item & {_id?: any})._id || index, (item, index: number)";
183
+ const reapeatDirectiveParamsJS = "(item, index) => item._id || index, (item, index)";
184
+ const repleatDirectiveParams = process.env.UI5_TS ? reapeatDirectiveParamsTS : reapeatDirectiveParamsJS;
185
+ this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", " + repleatDirectiveParams + " => ";
167
186
  this.paths.push(normalizePath.call(this, block.params[0].original));
168
- this.blockPath = "item";
187
+ this.blockLevel++;
169
188
 
170
- if (this.blockParameters.indexOf("item") === -1) {
189
+ // block params is [this, context, tags, suffix] for top level blocks
190
+ // blcok params is [this, context, tags, suffix, item, index] for nested blocks
191
+ if (!this.blockParametersUsage.includes("index")) {
192
+ // last item is not index, but an each block is processed, add the paramters for further nested blocks
171
193
  bParamAdded = true;
172
- this.blockParameters.unshift("index");
173
- this.blockParameters.unshift("item");
194
+ if (process.env.UI5_TS) {
195
+ this.blockParametersDefinition.push("item: any");
196
+ this.blockParametersDefinition.push("index: number");
197
+ } else {
198
+ this.blockParametersDefinition.push("item");
199
+ this.blockParametersDefinition.push("index");
200
+ }
201
+ this.blockParametersUsage.push("item");
202
+ this.blockParametersUsage.push("index");
174
203
  }
175
204
  this.acceptKey(block, "program");
176
205
  if (bParamAdded) {
177
- this.blockParameters.shift("item");
178
- this.blockParameters.shift("index");
206
+ // if parameters were added at this step, remove the last two
207
+ this.blockParametersDefinition.pop();
208
+ this.blockParametersDefinition.pop();
209
+ this.blockParametersUsage.pop();
210
+ this.blockParametersUsage.pop();
179
211
  }
180
- this.blockPath = "context";
181
-
212
+ this.blockLevel--;
182
213
  this.blocks[this.currentKey()] += ") }";
183
214
  }
184
215
 
@@ -187,12 +218,52 @@ function normalizePath(sPath) {
187
218
 
188
219
  //read carefully - https://github.com/wycats/handlebars.js/issues/1028
189
220
  //kpdecker commented on May 20, 2015
190
- if (result.indexOf("../") === 0) {
191
- let absolutePath = replaceAll(this.paths[this.paths.length - 1], ".", "/") + "/" + result;
221
+
222
+ if (result.indexOf("@root") === 0) {
223
+ // Trying to access root context via the HBS "@root" variable.
224
+ // Example: {{@root.property}} compiles to "context.property" - called from anywhere within the template.
225
+ result = result.replace("@root", "this");
226
+
227
+ } else if (result.indexOf("../") === 0) {
228
+ let absolutePath;
229
+ const levelsUp = (result.match(/..\//g) || []).length;
230
+
231
+ if (this.blockLevel <= levelsUp) {
232
+ // Trying to access root context from nested loops.
233
+ // Example: {{../../property}} compiles to "context.property" - when currently in a nested level loop.
234
+ // Example: {{../../../property}} compile to "context.property" - when requested levels are not present. fallback to root context.
235
+ absolutePath = `this.${replaceAll(result,"../", "")}`;
236
+ } else {
237
+ // Trying to access upper context (one-level-up) and based on the current lelev, that could be "context" or "item".
238
+ // Example: {{../property}} compiles to "context.property" - when called in a top level loop.
239
+ // Example: {{../property}} compiles to "item.property" - when called in a nested level loop.
240
+ // TODO: the second example, although correctly generated to "item.property", "item" will point to the current object within the nested loop,
241
+ // not the upper level loop as intended. So accessing the upper loop from nested loop is currently not working.
242
+ absolutePath = replaceAll(this.paths[this.paths.length - 1 - levelsUp], ".", "/") + "/" + result;
243
+ }
244
+
192
245
  result = replaceAll(path.normalize(absolutePath), path.sep, ".");
246
+
193
247
  } else {
194
- result = result ? replaceAll(this.blockPath + "/" + result, "/", ".") : this.blockPath;
248
+ // When neither "@root", nor "../" are used, use the following contexts:
249
+ // - use "context" - for the top level of execution, e.g "this.blockLevel = 0".
250
+ // - use "item" - for any nested level, e.g "this.blockLevel > 0".
251
+ // Example:
252
+ //
253
+ // {{text}} -> compiles to "context.text"
254
+ // {{#each items}}
255
+ // Item text: {{text}}</div> -> compiles to "item.text"
256
+ // {{#each words}}
257
+ // Word text: {{text}}</div> -> compiles to "item.text"
258
+ // {{/each}}
259
+ // Item text: {{text}}</div> -> compiles to "item.text"
260
+ // {{/each}}
261
+ // {{text}} -> compiles to "context.text"
262
+
263
+ const blockPath = this.blockLevel > 0 ? "item" : "this";
264
+ result = result ? replaceAll(blockPath + "/" + result, "/", ".") : blockPath;
195
265
  }
266
+
196
267
  return result;
197
268
  }
198
269
 
@@ -2,7 +2,7 @@
2
2
  const svgrx = new RegExp(/<svg[\s\S]*?>([\s\S]*?)<\/svg>/, 'g');
3
3
  const blockrx = /block[0-9]+/g;
4
4
 
5
- function process(input) {
5
+ function processSVG(input) {
6
6
  let matches;
7
7
  let template = input;
8
8
  let blockCounter = 0;
@@ -45,9 +45,16 @@ function getSVGMatches(template) {
45
45
  }
46
46
 
47
47
  function getSVGBlock(input, blockCounter) {
48
+ const definitionTS = `\nfunction blockSVG${blockCounter} (this: any, context: UI5Element, tags: string[], suffix: string | undefined) {
49
+ return svg\`${input}\`;
50
+ };`;
51
+ const definitionJS = `\nfunction blockSVG${blockCounter} (context, tags, suffix) {
52
+ return svg\`${input}\`;
53
+ };`;
54
+
48
55
  return {
49
- usage: `\${blockSVG${blockCounter}(context, tags, suffix)}`,
50
- definition: `\nconst blockSVG${blockCounter} = (context, tags, suffix) => svg\`${input}\`;`,
56
+ usage: `\${blockSVG${blockCounter}.call(this, context, tags, suffix)}`,
57
+ definition: process.env.UI5_TS ? definitionTS : definitionJS,
51
58
  };
52
59
  }
53
60
 
@@ -55,7 +62,7 @@ function replaceInternalBlocks(template, svgContent) {
55
62
  const internalBlocks = svgContent.match(blockrx) || [];
56
63
 
57
64
  internalBlocks.forEach(blockName => {
58
- const rx = new RegExp(`const ${blockName}.*(html\`).*;`);
65
+ const rx = new RegExp(`function ${blockName}.*(html\`).*;`);
59
66
  template = template.replace(rx, (match, p1) => {
60
67
  return match.replace(p1, "svg\`");
61
68
  });
@@ -65,5 +72,5 @@ function replaceInternalBlocks(template, svgContent) {
65
72
  }
66
73
 
67
74
  module.exports = {
68
- process: process
75
+ process: processSVG,
69
76
  };
@@ -1,7 +1,35 @@
1
- const buildRenderer = (controlName, litTemplate) => {
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";
1
+ const tsImports = (controlName, hasTypes) => {
2
+ if (!process.env.UI5_TS) {
3
+ return "";
4
+ }
5
+
6
+ const importPrefix = process.env.UI5_BASE ? "../../../" : "@ui5/webcomponents-base/dist/"
7
+
8
+ return `import type UI5Element from "${importPrefix}UI5Element.js";
9
+ ${importForControl(controlName, hasTypes)}
10
+ import type { ClassMapValue } from "${importPrefix}types.js";
11
+ `;
12
+ }
13
+ const importForControl = (controlName, hasTypes) => {
14
+
15
+ if (!hasTypes) {
16
+ return `type ${controlName} = any;`;
17
+ }
4
18
 
19
+ if (process.env.UI5_BASE) {
20
+ // base package has a component in `test/elements` instead of `src`
21
+ return `import type ${controlName} from "../../../../test/elements/${controlName}.js";`
22
+ }
23
+ return `import type ${controlName} from "../../${controlName}.js";`
24
+ }
25
+
26
+ const buildRenderer = (controlName, litTemplate, hasTypes) => {
27
+ const importPrefix = process.env.UI5_BASE ? "../../../" : "@ui5/webcomponents-base/dist/"
28
+
29
+ // typescript cannot process package imports for the same package and the paths are changed to relative for base package templates
30
+ return `/* eslint no-unused-vars: 0 */
31
+ import { html, svg, repeat, classMap, styleMap, ifDefined, unsafeHTML, scopeTag } from "${importPrefix}renderer/LitRenderer.js";
32
+ ${tsImports(controlName, hasTypes)}
5
33
  ${litTemplate}
6
34
 
7
35
  export default block0;`;
@@ -9,4 +37,4 @@ export default block0;`;
9
37
 
10
38
  module.exports = {
11
39
  generateTemplate: buildRenderer
12
- };
40
+ };
@@ -1,10 +1,12 @@
1
- const fs = require('fs');
1
+ const fs = require('fs').promises;
2
+ const existsSync = require('fs').existsSync;
2
3
  const getopts = require('getopts');
3
4
  const hbs2lit = require('../hbs2lit');
4
5
  const path = require('path');
5
6
  const litRenderer = require('./RenderTemplates/LitRenderer');
6
7
  const recursiveReadDir = require("recursive-readdir");
7
- const mkdirp = require('mkdirp');
8
+
9
+ let missingTypesReported = false;
8
10
 
9
11
  const args = getopts(process.argv.slice(2), {
10
12
  alias: {
@@ -24,13 +26,27 @@ const onError = (place) => {
24
26
 
25
27
  const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
26
28
 
27
- const processFile = (file, outputDir) => {
28
- const litCode = hbs2lit(file);
29
- const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
29
+ const hasTypes = (file, componentName) => {
30
+ const tsFile = path.join(path.dirname(file), componentName + ".ts")
31
+ const dtsFile = path.join(path.dirname(file), componentName + ".d.ts")
32
+ return existsSync(tsFile) || existsSync(dtsFile);
33
+ }
34
+
35
+ const processFile = async (file, outputDir) => {
30
36
  const componentNameMatcher = /(\w+)(\.hbs)/gim;
31
37
  const componentName = componentNameMatcher.exec(file)[1];
38
+ const componentHasTypes = hasTypes(file, componentName);
39
+ if (!componentHasTypes) {
40
+ if (!missingTypesReported) {
41
+ console.warn("[Warn] The following templates do not have a corresponging .ts or .d.ts file and won't be type checked:")
42
+ missingTypesReported = true;
43
+ }
44
+ console.log(" -> " + componentName + ".hbs");
45
+ }
46
+ const litCode = await hbs2lit(file, componentName);
47
+ const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
32
48
 
33
- writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
49
+ return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode, componentHasTypes));
34
50
  };
35
51
 
36
52
  const composeAbsoluteOutputDir = (file, outputDir) => {
@@ -40,39 +56,54 @@ const composeAbsoluteOutputDir = (file, outputDir) => {
40
56
  const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
41
57
 
42
58
  // (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
43
- return `${outputDir}${path.sep}${fileDir}`;
59
+ return `${outputDir}${path.sep}${fileDir}`;
44
60
  };
45
61
 
46
62
  const wrapDirectory = (directory, outputDir) => {
47
63
  directory = path.normalize(directory);
48
64
  outputDir = path.normalize(outputDir);
49
65
 
50
- recursiveReadDir(directory, (err, files) => {
51
-
52
- if (err) {
53
- onError('directory');
54
- }
66
+ return new Promise((resolve, reject) => {
67
+ recursiveReadDir(directory, (err, files) => {
55
68
 
56
- files.forEach(fileName => {
57
- if (isHandlebars(fileName)) {
58
- processFile(fileName, outputDir);
69
+ if (err) {
70
+ onError('directory');
71
+ reject();
59
72
  }
73
+
74
+ const promises = files.map(fileName => {
75
+ if (isHandlebars(fileName)) {
76
+ return processFile(fileName, outputDir);
77
+ }
78
+ }).filter(x => !!x);
79
+
80
+ resolve(Promise.all(promises));
60
81
  });
61
- })
82
+ });
62
83
  };
63
84
 
64
- const writeRenderers = (outputDir, controlName, fileContent) => {
85
+ const writeRenderers = async (outputDir, controlName, fileContent) => {
65
86
  try {
66
- if (!fs.existsSync(outputDir)) {
67
- mkdirp.sync(outputDir);
68
- }
69
87
 
70
- const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
88
+ await fs.mkdir(outputDir, { recursive: true });
89
+
90
+ const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.${process.env.UI5_TS ? "ts" : "js"}`;
71
91
 
72
92
  // strip DOS line endings because the break the source maps
73
93
  let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
74
94
  fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
75
- fs.writeFileSync(compiledFilePath, fileContentUnix);
95
+
96
+ // Only write to the file system actual changes - each updated file, no matter if the same or not, triggers an expensive operation for rollup
97
+ // Note: .hbs files that include a changed .hbs file will also be recompiled as their content will be updated too
98
+
99
+ let existingFileContent = "";
100
+ try {
101
+ existingFileContent = await fs.readFile(compiledFilePath);
102
+ } catch (e) {}
103
+
104
+ if (existingFileContent !== fileContentUnix) {
105
+ return fs.writeFile(compiledFilePath, fileContentUnix);
106
+ }
76
107
 
77
108
  } catch (e) {
78
109
  console.log(e);
@@ -82,5 +113,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
82
113
  if (!args['d'] || !args['o']) {
83
114
  console.log('Please provide an input and output directory (-d and -o)');
84
115
  } else {
85
- wrapDirectory(args['d'], args['o']);
116
+ wrapDirectory(args['d'], args['o']).then(() => {
117
+ console.log("Templates generated");
118
+ });
86
119
  }
@@ -1,74 +1,82 @@
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 tsMode = process.env.UI5_TS === "true"; // In Typescript mode, we output .ts files and set the required types, otherwise - output pure .js files
12
12
 
13
- if (!messageBundle || !outputFile) {
14
- return;
15
- }
13
+ const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.${tsMode ? "ts": "js"}`);
16
14
 
17
- const properties = PropertiesReader(messageBundle)._properties;
15
+ if (!messageBundle || !outputFile) {
16
+ return;
17
+ }
18
18
 
19
- let defaultLanguageProperties;
20
- try {
21
- defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
22
- }
23
- catch (e) {}
19
+ const properties = PropertiesReader(messageBundle)._properties;
24
20
 
21
+ let defaultLanguageProperties;
22
+ try {
23
+ defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
24
+ } catch (e) {
25
+ }
25
26
 
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
27
+ // Merge messagebundle.properties and messagebundle_en.properties files to generate the default texts.
28
+ // Note:
29
+ // (1) at DEV time, it's intuituve to work with the source bundle file - the messagebundle.properties,
30
+ // and see the changes there take effect.
31
+ // (2) as the messagebundle.properties file is always written in English,
32
+ // it makes sense to consider the messagebundle.properties content only when the default language is "en".
33
+ if (defaultLanguage === "en") {
34
+ defaultLanguageProperties = Object.assign({}, defaultLanguageProperties, properties);
35
+ }
38
36
 
39
- return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
40
- };
37
+ /*
38
+ * Returns the single text object to enable single export.
39
+ *
40
+ * Example:
41
+ * const ARIA_LABEL_CARD_CONTENT = {
42
+ * key: "ARIA_LABEL_CARD_CONTENT",
43
+ * defaultText: "Card Content",
44
+ * };
45
+ */
46
+ const getTextInfo = (key, value, defaultLanguageValue) => {
47
+ let effectiveValue = defaultLanguageValue || value;
48
+ effectiveValue = effectiveValue.replace(/\"/g, "\\\""); // escape double quotes in translations
41
49
 
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('');
50
+ if (tsMode) {
51
+ return `const ${key}: I18nText = {key: "${key}", defaultText: "${effectiveValue}"};`;
52
+ }
53
+ return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
54
+ };
55
55
 
56
- return `${texts}
57
- export {${textKeys.join()}};`;
58
- };
56
+ /*
57
+ * Returns the complete content of i18n-defaults.js file:
58
+ * (1) the single text objects
59
+ * (2) the export statement at the end of the file
60
+ *
61
+ * Example:
62
+ * export {
63
+ * ARIA_LABEL_CARD_CONTENT,
64
+ * }
65
+ */
66
+ const getOutputFileContent = (properties, defaultLanguageProperties) => {
67
+ const textKeys = Object.keys(properties);
68
+ const texts = textKeys.map(prop => getTextInfo(prop, properties[prop], defaultLanguageProperties && defaultLanguageProperties[prop])).join('');
59
69
 
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
- }
70
+ // tabs are intentionally mixed to have proper identation in the produced file
71
+ return `${tsMode ? `import { I18nText } from "@ui5/webcomponents-base/dist/i18nBundle.js";` : ""}
72
+ ${texts}
73
+ export {${textKeys.join()}};`;
74
+ };
68
75
 
69
- console.log(`[i18n]: "${file}" file has been created`);
70
- });
76
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
77
+ await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
71
78
  };
72
79
 
73
- mkdirp.sync(path.dirname(outputFile));
74
- writeI18nDefaultsFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
80
+ generate().then(() => {
81
+ console.log("i18n default file generated.");
82
+ });
@@ -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));
30
+ return fs.writeFile(outputFile, JSON.stringify(properties));
33
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.replace(/\\/g, "/"));
38
+ return Promise.all(files.map(convertToJSON));
39
+ };
40
+
41
+ generate().then(() => {
42
+ console.log("Message bundle JSON files generated.");
42
43
  });
@@ -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
+ }