@ui5/webcomponents-tools 0.0.0-a3eca7ade → 0.0.0-a8e886a07
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 +155 -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 +73 -55
- package/components-package/postcss.themes.js +1 -1
- package/components-package/vite.config.js +12 -0
- package/components-package/wdio.js +28 -4
- package/components-package/wdio.sync.js +1 -1
- package/icons-collection/nps.js +2 -7
- package/lib/copy-and-watch/index.js +24 -1
- package/lib/copy-list/index.js +17 -17
- package/lib/create-icons/index.js +101 -72
- package/lib/create-illustrations/index.js +101 -90
- package/lib/create-new-component/index.js +5 -5
- 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 +373 -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 +58 -57
- package/lib/i18n/toJSON.js +12 -11
- package/lib/jsdoc/configTypescript.json +29 -0
- package/lib/jsdoc/plugin.js +32 -0
- package/lib/jsdoc/preprocess.js +146 -0
- package/lib/jsdoc/template/publish.js +9 -1
- package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
- package/lib/postcss-css-to-esm/index.js +13 -1
- 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/scope-test-pages.js +1 -1
- package/lib/test-runner/test-runner.js +63 -0
- package/package.json +18 -25
- package/components-package/rollup-plugins/empty-module.js +0 -15
- package/components-package/rollup.js +0 -239
- 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 -42
- package/lib/documentation/templates/api-slots-section.js +0 -28
- package/lib/documentation/templates/template.js +0 -39
- 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,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,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
@@ -34,6 +34,10 @@
|
|
34
34
|
* native
|
35
35
|
*
|
36
36
|
* noattribute
|
37
|
+
*
|
38
|
+
* formEvents
|
39
|
+
*
|
40
|
+
* formProperty
|
37
41
|
*
|
38
42
|
* allowPreventDefault
|
39
43
|
*
|
@@ -2108,6 +2112,34 @@ exports.defineTags = function(dictionary) {
|
|
2108
2112
|
doclet.noattribute = true;
|
2109
2113
|
}
|
2110
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
|
+
});
|
2111
2143
|
};
|
2112
2144
|
|
2113
2145
|
exports.handlers = {
|
@@ -0,0 +1,146 @@
|
|
1
|
+
const process = require("process");
|
2
|
+
const path = require("path");
|
3
|
+
const fs = require("fs/promises");
|
4
|
+
|
5
|
+
const inputDir = process.argv[2];
|
6
|
+
const sourceDir = process.argv[3];
|
7
|
+
|
8
|
+
const preprocessTypes = async () => {
|
9
|
+
try {
|
10
|
+
const { globby } = await import("globby");
|
11
|
+
const fileNames = await globby(inputDir + "**/types/*.js");
|
12
|
+
|
13
|
+
return Promise.all(fileNames.map(processTypeFile));
|
14
|
+
} catch(e) {
|
15
|
+
console.log("JSDoc types preprocess failed: ", e);
|
16
|
+
}
|
17
|
+
};
|
18
|
+
|
19
|
+
const processTypeFile = async (fileName) => {
|
20
|
+
let fileContent = `${await fs.readFile(fileName)}`;
|
21
|
+
|
22
|
+
const re = new RegExp(`(\\/\\*\\*\\s*\\n([^\\*]|(\\*(?!\\/)))*\\*\\/)\\s+[\\w\\d]+\\[\\"([\\w\\d]+)\\"\\]\\s*=\\s*\\"([\\w\\d]+)\\";`, "gm")
|
23
|
+
let matches = [...fileContent.matchAll(re)];
|
24
|
+
|
25
|
+
// Get all type values
|
26
|
+
const typeData = matches.map(match => {
|
27
|
+
return {
|
28
|
+
comment: match[1],
|
29
|
+
key: match[4],
|
30
|
+
value: match[5],
|
31
|
+
};
|
32
|
+
});
|
33
|
+
if (typeData.length === 0) {
|
34
|
+
return;
|
35
|
+
}
|
36
|
+
|
37
|
+
const typeName = path.parse(fileName).name;
|
38
|
+
|
39
|
+
matches = fileContent.match(/\/\*\*\s*\n([^\*]|(\*(?!\/)))*\*\//gm);
|
40
|
+
const comment = matches[0];
|
41
|
+
|
42
|
+
const propsCode = typeData.map(item => {
|
43
|
+
return `${item.comment}\n get ${item.key}() { return "${item.value}"; }`;
|
44
|
+
}).join("\n");
|
45
|
+
|
46
|
+
const newClassCode = `
|
47
|
+
${comment}
|
48
|
+
class ${typeName} {
|
49
|
+
${propsCode}
|
50
|
+
};
|
51
|
+
|
52
|
+
export default ${typeName};`;
|
53
|
+
|
54
|
+
fileContent = newClassCode;
|
55
|
+
|
56
|
+
return fs.writeFile(fileName, fileContent);
|
57
|
+
};
|
58
|
+
|
59
|
+
const preprocessComponents = async () => {
|
60
|
+
if (!sourceDir) {
|
61
|
+
return; // if the second param was not passed, there are no components
|
62
|
+
}
|
63
|
+
|
64
|
+
try {
|
65
|
+
const { globby } = await import("globby");
|
66
|
+
const fileNames = await globby(sourceDir + "/*.ts");
|
67
|
+
|
68
|
+
return Promise.all(fileNames.map(processComponentFile));
|
69
|
+
} catch(e) {
|
70
|
+
console.log("JSDoc components preprocess failed: ", e);
|
71
|
+
}
|
72
|
+
};
|
73
|
+
|
74
|
+
const isClass = text => {
|
75
|
+
return text.includes("@abstract") || text.includes("@class");
|
76
|
+
};
|
77
|
+
|
78
|
+
const isAnnotationComment = (comment) => {
|
79
|
+
return comment.includes("@name");
|
80
|
+
}
|
81
|
+
|
82
|
+
const processComponentFile = async (fileName) => {
|
83
|
+
// source file (src/*.ts)
|
84
|
+
let tsFileContent = `${await fs.readFile(fileName)}`;
|
85
|
+
|
86
|
+
// Skip all non-component files
|
87
|
+
if (!isClass(tsFileContent)) {
|
88
|
+
return;
|
89
|
+
}
|
90
|
+
|
91
|
+
// Gather all JSDocs from the original .ts file
|
92
|
+
const allJSDocsRegExp = new RegExp(`\\/\\*\\*(.|\\n)+?\\s+\\*\\/`, "gm");
|
93
|
+
let allJSDocs = [...tsFileContent.matchAll(allJSDocsRegExp)];
|
94
|
+
allJSDocs = allJSDocs.map(match => match[0]); // all /** ..... */ comments
|
95
|
+
|
96
|
+
// Find where the class is defined in the original file
|
97
|
+
const tsClassDefinitionRegExp = new RegExp(`^(abstract\\s)?class [\\w\\d_]+`, "gm");
|
98
|
+
let tsClassDefinitionMatch = tsFileContent.match(tsClassDefinitionRegExp);
|
99
|
+
if (!tsClassDefinitionMatch) {
|
100
|
+
return; // no class defined in this .ts file
|
101
|
+
}
|
102
|
+
const tsClassDefinition = tsClassDefinitionMatch[0];
|
103
|
+
const tsClassDefinitionIndex = tsFileContent.indexOf(tsClassDefinition);
|
104
|
+
|
105
|
+
// Gather all JSDocs that are before the class definition (except for the @class one)
|
106
|
+
const JSDocsToAppend = [];
|
107
|
+
allJSDocs.forEach(JSDoc => {
|
108
|
+
if (!isClass(JSDoc) && (tsFileContent.indexOf(JSDoc) < tsClassDefinitionIndex || isAnnotationComment(JSDoc, tsFileContent))) {
|
109
|
+
JSDocsToAppend.push(JSDoc);
|
110
|
+
}
|
111
|
+
});
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
// destination file (jsdoc-dist/*.js)
|
116
|
+
const destFileName = fileName.replace(sourceDir, inputDir).replace(/\.ts$/, ".js");
|
117
|
+
let jsFileContent = `${await fs.readFile(destFileName)}`;
|
118
|
+
|
119
|
+
const classDefinitionRegExp = new RegExp(`let.*? = class`, "gm");
|
120
|
+
let classDefinitionMatch = jsFileContent.match(classDefinitionRegExp);
|
121
|
+
if (!classDefinitionMatch) {
|
122
|
+
return; // not a file, generated by typescript, nothing to do here
|
123
|
+
}
|
124
|
+
|
125
|
+
const classDefinition = classDefinitionMatch[0];
|
126
|
+
const classDefinitionIndex = jsFileContent.indexOf(classDefinition); // classDefinitionIndex is the position in the file where the class is defined
|
127
|
+
|
128
|
+
// All comments before the class definition, except for the @class comment, must be removed
|
129
|
+
allJSDocs.forEach(JSDoc => {
|
130
|
+
if (!isClass(JSDoc) && jsFileContent.indexOf(JSDoc) < classDefinitionIndex) {
|
131
|
+
jsFileContent = jsFileContent.replace(JSDoc, "");
|
132
|
+
}
|
133
|
+
});
|
134
|
+
|
135
|
+
// Put all other comments at the end of the file
|
136
|
+
jsFileContent = jsFileContent + "\n\n" + JSDocsToAppend.join("\n\n");
|
137
|
+
return fs.writeFile(destFileName, jsFileContent);
|
138
|
+
};
|
139
|
+
|
140
|
+
Promise.all([
|
141
|
+
preprocessTypes(),
|
142
|
+
preprocessComponents(),
|
143
|
+
]).then(() => {
|
144
|
+
console.log("JSDoc preprocess ready.");
|
145
|
+
});
|
146
|
+
|
@@ -2820,6 +2820,14 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
|
|
2820
2820
|
attrib("since", extractVersion(member.since));
|
2821
2821
|
}
|
2822
2822
|
|
2823
|
+
if ( member.formEvents ) {
|
2824
|
+
attrib("formEvents", member.formEvents);
|
2825
|
+
}
|
2826
|
+
|
2827
|
+
if ( member.formEvents ) {
|
2828
|
+
attrib("formProperty", member.formProperty);
|
2829
|
+
}
|
2830
|
+
|
2823
2831
|
var type = listTypes(member.type);
|
2824
2832
|
attrib("type", type);
|
2825
2833
|
|
@@ -3865,7 +3873,7 @@ function createAPIJS(symbols, filename) {
|
|
3865
3873
|
|
3866
3874
|
var output = [];
|
3867
3875
|
|
3868
|
-
var rkeywords = /^(?:abstract|as|boolean|break|byte|case|catch|char|class|continue|const|debugger|default|delete|do|double|else|enum|export|extends|false|final|finally|float|for|function|goto|if|implements|import|in|instanceof|int|interface|is|long|namespace|native|new|null|noattribute|package|private|protected|public|return|short|static|super|switch|synchronized|this|throw|throws|transient|true|try|typeof|use|var|void|volatile|while|with)$/;
|
3876
|
+
var rkeywords = /^(?:abstract|as|boolean|break|byte|case|catch|char|class|continue|const|debugger|default|delete|do|double|else|enum|export|extends|false|final|finally|float|for|function|formEvents|formProperty|goto|if|implements|import|in|instanceof|int|interface|is|long|namespace|native|new|null|noattribute|package|private|protected|public|return|short|static|super|switch|synchronized|this|throw|throws|transient|true|try|typeof|use|var|void|volatile|while|with)$/;
|
3869
3877
|
|
3870
3878
|
function isNoKeyword($) { return !rkeywords.test($.name); }
|
3871
3879
|
|