@ui5/webcomponents-tools 0.0.0-8db0ce01a → 0.0.0-918b4fbe7
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.
- package/CHANGELOG.md +224 -0
- package/README.md +5 -6
- package/assets-meta.js +7 -1
- package/bin/dev.js +1 -5
- package/components-package/eslint.js +28 -0
- package/components-package/nps.js +76 -52
- package/components-package/postcss.themes.js +6 -3
- package/components-package/vite.config.js +12 -0
- package/components-package/wdio.js +71 -29
- package/components-package/wdio.sync.js +360 -0
- package/icons-collection/nps.js +41 -13
- package/lib/copy-and-watch/index.js +24 -1
- package/lib/copy-list/index.js +28 -0
- package/lib/create-icons/index.js +101 -58
- package/lib/create-illustrations/index.js +161 -0
- package/lib/create-new-component/index.js +13 -5
- package/lib/dev-server/dev-server.js +66 -0
- package/lib/dev-server/virtual-index-html-plugin.js +52 -0
- package/lib/esm-abs-to-rel/index.js +58 -0
- package/lib/generate-custom-elements-manifest/index.js +369 -0
- package/lib/generate-js-imports/illustrations.js +72 -0
- package/lib/generate-json-imports/i18n.js +38 -31
- package/lib/generate-json-imports/themes.js +31 -24
- package/lib/hbs2lit/src/compiler.js +20 -3
- package/lib/hbs2lit/src/includesReplacer.js +5 -5
- package/lib/hbs2lit/src/litVisitor2.js +77 -14
- package/lib/hbs2lit/src/svgProcessor.js +3 -3
- package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +4 -11
- package/lib/hbs2ui5/index.js +37 -21
- package/lib/i18n/defaults.js +58 -57
- package/lib/i18n/toJSON.js +12 -11
- package/lib/jsdoc/configTypescript.json +29 -0
- package/lib/jsdoc/plugin.js +41 -0
- package/lib/jsdoc/preprocess.js +60 -0
- package/lib/jsdoc/template/publish.js +21 -2
- package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
- package/lib/postcss-css-to-esm/index.js +16 -4
- package/lib/postcss-css-to-json/index.js +18 -2
- package/lib/postcss-p/postcss-p.mjs +14 -0
- package/lib/replace-global-core/index.js +25 -0
- package/lib/scoping/get-all-tags.js +1 -8
- package/lib/scoping/lint-src.js +1 -1
- package/lib/scoping/missing-dependencies.js +65 -0
- package/lib/scoping/report-tags-usage.js +28 -0
- package/lib/scoping/scope-test-pages.js +1 -1
- package/lib/test-runner/test-runner.js +63 -0
- package/package.json +28 -41
- package/bin/init-ui5-package.js +0 -3
- package/components-package/rollup.js +0 -195
- package/lib/documentation/index.js +0 -165
- package/lib/documentation/templates/api-component-since.js +0 -3
- package/lib/documentation/templates/api-css-variables-section.js +0 -24
- package/lib/documentation/templates/api-events-section.js +0 -35
- package/lib/documentation/templates/api-methods-section.js +0 -26
- package/lib/documentation/templates/api-properties-section.js +0 -40
- package/lib/documentation/templates/api-slots-section.js +0 -28
- package/lib/documentation/templates/template.js +0 -38
- package/lib/hash/config.js +0 -10
- package/lib/hash/generate.js +0 -19
- package/lib/hash/upToDate.js +0 -31
- package/lib/init-package/index.js +0 -123
- package/lib/init-package/resources/.eslintignore +0 -3
- package/lib/init-package/resources/bundle.es5.js +0 -25
- package/lib/init-package/resources/bundle.esm.js +0 -31
- package/lib/init-package/resources/config/.eslintrc.js +0 -1
- package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
- package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
- package/lib/init-package/resources/config/rollup.config.js +0 -1
- package/lib/init-package/resources/config/wdio.conf.js +0 -1
- package/lib/init-package/resources/package-scripts.js +0 -11
- package/lib/init-package/resources/src/Assets.js +0 -5
- package/lib/init-package/resources/src/MyFirstComponent.hbs +0 -1
- package/lib/init-package/resources/src/MyFirstComponent.js +0 -56
- package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
- package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
- package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
- package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
- package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
- package/lib/init-package/resources/src/themes/MyFirstComponent.css +0 -11
- package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
- package/lib/init-package/resources/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
- package/lib/init-package/resources/test/pages/index.html +0 -56
- package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
- package/lib/polyfill-placeholder/index.js +0 -5
- package/lib/serve/index.js +0 -46
- package/lib/serve/serve.json +0 -3
- package/package-lock.json +0 -48
@@ -1,9 +1,9 @@
|
|
1
1
|
const path = require("path");
|
2
|
-
const fs = require("fs");
|
2
|
+
const fs = require("fs").promises;
|
3
3
|
|
4
|
-
|
4
|
+
const replaceIncludes = async (file) => {
|
5
5
|
const filePath = path.dirname(file);
|
6
|
-
let fileContent = fs.
|
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.
|
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(", ") + ") =>
|
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
|
-
|
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 (
|
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.
|
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.
|
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
|
-
|
174
|
-
|
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
|
-
|
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) =>
|
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
|
-
|
4
|
-
|
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
|
-
|
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 = {
|
package/lib/hbs2ui5/index.js
CHANGED
@@ -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
|
-
|
49
|
+
return new Promise((resolve, reject) => {
|
50
|
+
recursiveReadDir(directory, (err, files) => {
|
51
51
|
|
52
|
-
|
53
|
-
|
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
|
-
|
67
|
-
|
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
|
-
|
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
|
}
|
package/lib/i18n/defaults.js
CHANGED
@@ -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
|
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
|
-
|
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
|
-
|
22
|
-
}
|
23
|
-
|
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
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
const getTextInfo = (key, value, defaultLanguageValue) => {
|
36
|
-
|
37
|
-
|
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
|
-
|
40
|
-
};
|
48
|
+
return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
|
49
|
+
};
|
41
50
|
|
42
|
-
/*
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
const getOutputFileContent = (properties, defaultLanguageProperties) => {
|
53
|
-
|
54
|
-
|
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
|
-
|
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
|
-
|
70
|
-
|
69
|
+
await fs.mkdir(path.dirname(outputFile), { recursive: true });
|
70
|
+
await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
|
71
71
|
};
|
72
72
|
|
73
|
-
|
74
|
-
|
73
|
+
generate().then(() => {
|
74
|
+
console.log("i18n default file generated.");
|
75
|
+
});
|
package/lib/i18n/toJSON.js
CHANGED
@@ -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
|
-
|
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.
|
30
|
+
return fs.writeFile(outputFile, JSON.stringify(properties));
|
33
31
|
// console.log(`[i18n]: "${filename}.json" has been generated!`);
|
34
32
|
};
|
35
33
|
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
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
|
});
|
@@ -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
|
+
}
|
package/lib/jsdoc/plugin.js
CHANGED
@@ -33,6 +33,12 @@
|
|
33
33
|
*
|
34
34
|
* native
|
35
35
|
*
|
36
|
+
* noattribute
|
37
|
+
*
|
38
|
+
* formEvents
|
39
|
+
*
|
40
|
+
* formProperty
|
41
|
+
*
|
36
42
|
* allowPreventDefault
|
37
43
|
*
|
38
44
|
* It furthermore listens to the following JSDoc3 events to implement additional functionality
|
@@ -2099,6 +2105,41 @@ exports.defineTags = function(dictionary) {
|
|
2099
2105
|
doclet.native = true;
|
2100
2106
|
}
|
2101
2107
|
});
|
2108
|
+
|
2109
|
+
dictionary.defineTag('noattribute', {
|
2110
|
+
mustHaveValue: false,
|
2111
|
+
onTagged: function(doclet, tag) {
|
2112
|
+
doclet.noattribute = true;
|
2113
|
+
}
|
2114
|
+
});
|
2115
|
+
|
2116
|
+
dictionary.defineTag('formEvents', {
|
2117
|
+
mustHaveValue: false,
|
2118
|
+
onTagged: function(doclet, tag) {
|
2119
|
+
if (tag.value) {
|
2120
|
+
doclet.formEvents = doclet.formEvents || [];
|
2121
|
+
tag.value.split(" ").forEach(function($) {
|
2122
|
+
if ( doclet.formEvents.indexOf($) < 0 ) {
|
2123
|
+
doclet.formEvents.push($);
|
2124
|
+
}
|
2125
|
+
});
|
2126
|
+
}
|
2127
|
+
}
|
2128
|
+
});
|
2129
|
+
|
2130
|
+
dictionary.defineTag('formProperty', {
|
2131
|
+
mustHaveValue: false,
|
2132
|
+
onTagged: function(doclet, tag) {
|
2133
|
+
doclet.formProperty = true;
|
2134
|
+
}
|
2135
|
+
});
|
2136
|
+
|
2137
|
+
dictionary.defineTag('formAssociated', {
|
2138
|
+
mustHaveValue: false,
|
2139
|
+
onTagged: function(doclet, tag) {
|
2140
|
+
doclet.formAssociated = doclet.formAssociated || true;
|
2141
|
+
}
|
2142
|
+
});
|
2102
2143
|
};
|
2103
2144
|
|
2104
2145
|
exports.handlers = {
|
@@ -0,0 +1,60 @@
|
|
1
|
+
const process = require("process");
|
2
|
+
const path = require("path");
|
3
|
+
const fs = require("fs/promises");
|
4
|
+
|
5
|
+
const inputDir = process.argv[2];
|
6
|
+
|
7
|
+
const preprocess = async () => {
|
8
|
+
try {
|
9
|
+
const { globby } = await import("globby");
|
10
|
+
const fileNames = await globby(inputDir + "**/types/*.js");
|
11
|
+
|
12
|
+
return Promise.all(fileNames.map(processFile));
|
13
|
+
} catch(e) {
|
14
|
+
console.log("JSDoc preprocess failed: ", e);
|
15
|
+
}
|
16
|
+
};
|
17
|
+
|
18
|
+
const processFile = async (fileName) => {
|
19
|
+
let fileContent = `${await fs.readFile(fileName)}`;
|
20
|
+
|
21
|
+
const re = new RegExp(`(\\/\\*\\*[^\\/]+\\s+\\*\\/)?\\s+\\s+.*?\\["([\\w\\d]+)"\\].*?"([\\w\\d]+)";`, "gm")
|
22
|
+
let matches = [...fileContent.matchAll(re)];
|
23
|
+
|
24
|
+
// Get all type values
|
25
|
+
const typeData = matches.map(match => {
|
26
|
+
return {
|
27
|
+
comment: match[1],
|
28
|
+
key: match[2],
|
29
|
+
value: match[3],
|
30
|
+
};
|
31
|
+
});
|
32
|
+
if (typeData.length === 0) {
|
33
|
+
return;
|
34
|
+
}
|
35
|
+
|
36
|
+
const typeName = path.parse(fileName).name;
|
37
|
+
|
38
|
+
matches = fileContent.match(/^\/\*\*[^\/]+\//gm);
|
39
|
+
const comment = matches[0];
|
40
|
+
|
41
|
+
const propsCode = typeData.map(item => {
|
42
|
+
return `${item.comment}\n get ${item.key}() { return "${item.value}"; }`;
|
43
|
+
}).join("\n");
|
44
|
+
|
45
|
+
const newClassCode = `
|
46
|
+
${comment}
|
47
|
+
class ${typeName} {
|
48
|
+
${propsCode}
|
49
|
+
};
|
50
|
+
|
51
|
+
export default ${typeName};`;
|
52
|
+
|
53
|
+
fileContent = newClassCode;
|
54
|
+
|
55
|
+
return fs.writeFile(fileName, fileContent);
|
56
|
+
};
|
57
|
+
|
58
|
+
preprocess().then(() => {
|
59
|
+
console.log("JSDoc preprocess ready.");
|
60
|
+
});
|