@ui5/webcomponents-tools 0.0.0-1e08ebdef → 0.0.0-1f45608ac
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 +306 -0
- package/README.md +5 -6
- package/assets-meta.js +4 -0
- package/bin/dev.js +1 -5
- package/components-package/eslint.js +28 -0
- package/components-package/nps.js +80 -57
- package/components-package/postcss.components.js +13 -13
- package/components-package/postcss.themes.js +16 -16
- package/components-package/vite.config.js +12 -0
- package/components-package/wdio.js +44 -4
- package/components-package/wdio.sync.js +17 -1
- package/icons-collection/nps.js +6 -9
- package/lib/copy-and-watch/index.js +24 -1
- package/lib/copy-list/index.js +17 -17
- package/lib/create-icons/index.js +124 -72
- package/lib/create-illustrations/index.js +107 -41
- package/lib/create-new-component/index.js +105 -108
- package/lib/create-new-component/jsFileContentTemplate.js +77 -0
- package/lib/create-new-component/tsFileContentTemplate.js +84 -0
- package/lib/dev-server/dev-server.js +66 -0
- package/lib/dev-server/virtual-index-html-plugin.js +53 -0
- package/lib/esm-abs-to-rel/index.js +13 -9
- package/lib/generate-custom-elements-manifest/index.js +327 -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 +46 -8
- package/lib/hbs2ui5/index.js +37 -21
- package/lib/i18n/defaults.js +65 -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 +146 -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 +51 -6
- package/lib/postcss-css-to-json/index.js +12 -1
- package/lib/postcss-p/postcss-p.mjs +14 -0
- package/lib/replace-global-core/index.js +13 -8
- package/lib/scoping/get-all-tags.js +1 -8
- 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 +21 -28
- package/components-package/rollup-plugins/empty-module.js +0 -15
- package/components-package/rollup.js +0 -245
- 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/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,32 +1,32 @@
|
|
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
|
7
|
-
const
|
8
|
-
const
|
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`);
|
9
9
|
|
10
10
|
// All supported optional themes
|
11
|
-
const allThemes = assets.themes.all;
|
11
|
+
const allThemes = assets.themes.all;
|
12
12
|
|
13
13
|
// All themes present in the file system
|
14
|
-
const dirs = fs.
|
15
|
-
const themesOnFileSystem = dirs.map(dir => {
|
16
|
-
|
17
|
-
|
18
|
-
}).filter(key => !!key && allThemes.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));
|
19
19
|
|
20
|
-
const packageName = JSON.parse(fs.
|
20
|
+
const packageName = JSON.parse(await fs.readFile("package.json")).name;
|
21
21
|
|
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");
|
22
|
+
const importLines = themesOnFileSystem.map(theme => `import ${theme} from "../assets/themes/${theme}/parameters-bundle.css.json";`).join("\n");
|
23
|
+
const themeUrlsByName = "{\n" + themesOnFileSystem.join(",\n") + "\n}";
|
24
|
+
const availableThemesArray = `[${themesOnFileSystem.map(theme => `"${theme}"`).join(", ")}]`;
|
25
|
+
const dynamicImportLines = themesOnFileSystem.map(theme => `\t\tcase "${theme}": return (await import("../assets/themes/${theme}/parameters-bundle.css.json")).default;`).join("\n");
|
26
26
|
|
27
27
|
|
28
28
|
// static imports file content
|
29
|
-
const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
|
29
|
+
const contentStatic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
|
30
30
|
|
31
31
|
${importLines}
|
32
32
|
|
@@ -39,7 +39,7 @@ const loadThemeProperties = async (themeName) => {
|
|
39
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
40
|
}
|
41
41
|
return (await fetch(themeUrlsByName[themeName])).json();
|
42
|
-
}
|
42
|
+
};
|
43
43
|
|
44
44
|
${availableThemesArray}
|
45
45
|
.forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadThemeProperties));
|
@@ -47,14 +47,14 @@ ${availableThemesArray}
|
|
47
47
|
|
48
48
|
|
49
49
|
// dynamic imports file content
|
50
|
-
const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
|
50
|
+
const contentDynamic = `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
|
51
51
|
|
52
52
|
const loadThemeProperties = async (themeName) => {
|
53
53
|
switch (themeName) {
|
54
54
|
${dynamicImportLines}
|
55
55
|
default: throw "unknown theme"
|
56
56
|
}
|
57
|
-
}
|
57
|
+
};
|
58
58
|
|
59
59
|
const loadAndCheck = async (themeName) => {
|
60
60
|
const data = await loadThemeProperties(themeName);
|
@@ -62,12 +62,19 @@ const loadAndCheck = async (themeName) => {
|
|
62
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
63
|
}
|
64
64
|
return data;
|
65
|
-
}
|
65
|
+
};
|
66
66
|
|
67
67
|
${availableThemesArray}
|
68
68
|
.forEach(themeName => registerThemePropertiesLoader("${packageName}", themeName, loadAndCheck));
|
69
69
|
`;
|
70
70
|
|
71
|
-
|
72
|
-
|
73
|
-
fs.
|
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
|
-
|
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
|
-
|
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
|
@@ -34,7 +34,7 @@ function HTMLLitVisitor(debug) {
|
|
34
34
|
this.blocks = {};
|
35
35
|
this.result = "";
|
36
36
|
this.mainBlock = "";
|
37
|
-
this.
|
37
|
+
this.blockLevel = 0;
|
38
38
|
this.blockParameters = ["context", "tags", "suffix"];
|
39
39
|
this.paths = []; //contains all normalized relative paths
|
40
40
|
this.debug = debug;
|
@@ -57,7 +57,6 @@ HTMLLitVisitor.prototype.Program = function(program) {
|
|
57
57
|
this.blocks[this.prevKey()] += this.currentKey() + "(" + this.blockParameters.join(", ") + ")";
|
58
58
|
} else {
|
59
59
|
this.mainBlock = this.currentKey();
|
60
|
-
this.paths.push(this.blockPath);
|
61
60
|
}
|
62
61
|
|
63
62
|
this.blocks[this.currentKey()] += "html`";
|
@@ -173,7 +172,7 @@ function visitEachBlock(block) {
|
|
173
172
|
|
174
173
|
this.blocks[this.currentKey()] += "${ repeat(" + normalizePath.call(this, block.params[0].original) + ", (item, index) => item._id || index, (item, index) => ";
|
175
174
|
this.paths.push(normalizePath.call(this, block.params[0].original));
|
176
|
-
this.
|
175
|
+
this.blockLevel++;
|
177
176
|
|
178
177
|
if (this.blockParameters.indexOf("item") === -1) {
|
179
178
|
bParamAdded = true;
|
@@ -185,8 +184,7 @@ function visitEachBlock(block) {
|
|
185
184
|
this.blockParameters.shift("item");
|
186
185
|
this.blockParameters.shift("index");
|
187
186
|
}
|
188
|
-
this.
|
189
|
-
|
187
|
+
this.blockLevel--;
|
190
188
|
this.blocks[this.currentKey()] += ") }";
|
191
189
|
}
|
192
190
|
|
@@ -195,12 +193,52 @@ function normalizePath(sPath) {
|
|
195
193
|
|
196
194
|
//read carefully - https://github.com/wycats/handlebars.js/issues/1028
|
197
195
|
//kpdecker commented on May 20, 2015
|
198
|
-
|
199
|
-
|
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
|
+
|
200
220
|
result = replaceAll(path.normalize(absolutePath), path.sep, ".");
|
221
|
+
|
201
222
|
} else {
|
202
|
-
|
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;
|
203
240
|
}
|
241
|
+
|
204
242
|
return result;
|
205
243
|
}
|
206
244
|
|
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,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
|
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
|
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
|
-
|
14
|
-
return;
|
15
|
-
}
|
13
|
+
const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.${tsMode ? "ts": "js"}`);
|
16
14
|
|
17
|
-
|
15
|
+
if (!messageBundle || !outputFile) {
|
16
|
+
return;
|
17
|
+
}
|
18
18
|
|
19
|
-
|
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
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
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
|
-
|
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
|
-
|
44
|
-
|
45
|
-
|
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
|
-
|
57
|
-
|
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
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
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
|
-
|
70
|
-
|
76
|
+
await fs.mkdir(path.dirname(outputFile), { recursive: true });
|
77
|
+
await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
|
71
78
|
};
|
72
79
|
|
73
|
-
|
74
|
-
|
80
|
+
generate().then(() => {
|
81
|
+
console.log("i18n default file generated.");
|
82
|
+
});
|
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 = {
|