@ui5/webcomponents-tools 0.0.0-2c7615fe9 → 0.0.0-3236d56be

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 (70) hide show
  1. package/CHANGELOG.md +126 -0
  2. package/README.md +1 -1
  3. package/assets-meta.js +7 -1
  4. package/components-package/nps.js +16 -25
  5. package/components-package/postcss.themes.js +6 -3
  6. package/components-package/rollup-plugins/empty-module.js +15 -0
  7. package/components-package/rollup.js +25 -91
  8. package/components-package/wdio.js +50 -25
  9. package/components-package/wdio.sync.js +360 -0
  10. package/icons-collection/nps.js +41 -13
  11. package/lib/copy-and-watch/index.js +24 -0
  12. package/lib/copy-list/index.js +16 -16
  13. package/lib/create-icons/index.js +76 -58
  14. package/lib/create-illustrations/index.js +129 -38
  15. package/lib/documentation/index.js +119 -116
  16. package/lib/documentation/templates/api-properties-section.js +3 -1
  17. package/lib/documentation/templates/template.js +2 -1
  18. package/lib/esm-abs-to-rel/index.js +13 -9
  19. package/lib/generate-json-imports/i18n.js +38 -31
  20. package/lib/generate-json-imports/themes.js +28 -21
  21. package/lib/hbs2lit/src/compiler.js +12 -3
  22. package/lib/hbs2lit/src/includesReplacer.js +5 -5
  23. package/lib/hbs2lit/src/litVisitor2.js +10 -2
  24. package/lib/hbs2ui5/index.js +37 -21
  25. package/lib/i18n/defaults.js +49 -57
  26. package/lib/i18n/toJSON.js +12 -11
  27. package/lib/jsdoc/plugin.js +9 -0
  28. package/lib/jsdoc/template/publish.js +13 -2
  29. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  30. package/lib/postcss-css-to-esm/index.js +4 -4
  31. package/lib/postcss-css-to-json/index.js +7 -2
  32. package/lib/postcss-p/postcss-p.mjs +11 -0
  33. package/lib/replace-global-core/index.js +13 -8
  34. package/lib/scoping/missing-dependencies.js +65 -0
  35. package/lib/scoping/report-tags-usage.js +28 -0
  36. package/lib/serve/index.js +1 -1
  37. package/package.json +23 -32
  38. package/bin/init-ui5-package.js +0 -3
  39. package/lib/hash/config.js +0 -10
  40. package/lib/hash/generate.js +0 -19
  41. package/lib/hash/upToDate.js +0 -31
  42. package/lib/init-package/index.js +0 -136
  43. package/lib/init-package/resources/.eslintignore +0 -3
  44. package/lib/init-package/resources/bundle.es5.js +0 -25
  45. package/lib/init-package/resources/bundle.esm.js +0 -31
  46. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  47. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  48. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  49. package/lib/init-package/resources/config/rollup.config.js +0 -1
  50. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  51. package/lib/init-package/resources/package-scripts.js +0 -11
  52. package/lib/init-package/resources/src/Assets.js +0 -5
  53. package/lib/init-package/resources/src/MyFirstComponent.hbs +0 -1
  54. package/lib/init-package/resources/src/MyFirstComponent.js +0 -56
  55. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  56. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  57. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  58. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  59. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  60. package/lib/init-package/resources/src/themes/MyFirstComponent.css +0 -11
  61. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  62. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  63. package/lib/init-package/resources/src/themes/sap_belize_hcw/parameters-bundle.css +0 -3
  64. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  65. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  66. package/lib/init-package/resources/src/themes/sap_fiori_3_hcb/parameters-bundle.css +0 -3
  67. package/lib/init-package/resources/src/themes/sap_fiori_3_hcw/parameters-bundle.css +0 -3
  68. package/lib/init-package/resources/test/pages/index.html +0 -56
  69. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
  70. package/lib/polyfill-placeholder/index.js +0 -5
@@ -1,33 +1,102 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require("path");
3
- const mkdirp = require("mkdirp");
4
3
 
5
- if (process.argv.length < 4) {
6
- return;
4
+ if (process.argv.length < 7) {
5
+ throw new Error("Not enough arguments");
7
6
  }
8
7
 
9
- const fileNamePattern = /sapIllus-.+-(.+).svg/;
10
- const srcPath = process.argv[2];
11
- const destPath = process.argv[3];
8
+ const generate = async () => {
9
+
10
+ const ORIGINAL_TEXTS = {
11
+ UnableToLoad: "UnableToLoad",
12
+ UnableToUpload: "UnableToUpload",
13
+ NoActivities: "NoActivities",
14
+ BeforeSearch: "BeforeSearch",
15
+ NoSearchResults: "NoSearchResults",
16
+ NoEntries: "NoEntries",
17
+ NoData: "NoData",
18
+ NoNotifications: "NoNotifications",
19
+ BalloonSky: "BalloonSky",
20
+ SuccessScreen: "SuccessScreen",
21
+ NoMail: "NoMail",
22
+ NoSavedItems: "NoSavedItems",
23
+ NoTasks: "NoTasks"
24
+ };
25
+
26
+ const FALLBACK_TEXTS = {
27
+ ReloadScreen: ORIGINAL_TEXTS.UnableToLoad,
28
+ Connection: ORIGINAL_TEXTS.UnableToLoad,
29
+ ErrorScreen: ORIGINAL_TEXTS.UnableToUpload,
30
+ EmptyCalendar: ORIGINAL_TEXTS.NoActivities,
31
+ SearchEarth: ORIGINAL_TEXTS.BeforeSearch,
32
+ SearchFolder: ORIGINAL_TEXTS.NoSearchResults,
33
+ EmptyList: ORIGINAL_TEXTS.NoEntries,
34
+ Tent: ORIGINAL_TEXTS.NoData,
35
+ SleepingBell: ORIGINAL_TEXTS.NoNotifications,
36
+ SimpleBalloon: ORIGINAL_TEXTS.BalloonSky,
37
+ SimpleBell: ORIGINAL_TEXTS.NoNotifications,
38
+ SimpleCalendar: ORIGINAL_TEXTS.NoActivities,
39
+ SimpleCheckMark: ORIGINAL_TEXTS.SuccessScreen,
40
+ SimpleConnection: ORIGINAL_TEXTS.UnableToLoad,
41
+ SimpleEmptyDoc: ORIGINAL_TEXTS.NoData,
42
+ SimpleEmptyList: ORIGINAL_TEXTS.NoEntries,
43
+ SimpleError: ORIGINAL_TEXTS.UnableToUpload,
44
+ SimpleMagnifier: ORIGINAL_TEXTS.BeforeSearch,
45
+ SimpleMail: ORIGINAL_TEXTS.NoMail,
46
+ SimpleNoSavedItems: ORIGINAL_TEXTS.NoSavedItems,
47
+ SimpleNotFoundMagnifier: ORIGINAL_TEXTS.NoSearchResults,
48
+ SimpleReload: ORIGINAL_TEXTS.UnableToLoad,
49
+ SimpleTask: ORIGINAL_TEXTS.NoTasks,
50
+ SuccessBalloon: ORIGINAL_TEXTS.BalloonSky,
51
+ SuccessCheckMark: ORIGINAL_TEXTS.SuccessScreen,
52
+ SuccessHighFive: ORIGINAL_TEXTS.BalloonSky
53
+ };
54
+
55
+ const srcPath = process.argv[2];
56
+ const defaultText = process.argv[3] === "true";
57
+ const illustrationsPrefix = process.argv[4];
58
+ const illustrationSet = process.argv[5];
59
+ const destPath = process.argv[6];
60
+ const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
12
61
  // collect each illustration name because each one should have Sample.js file
13
- const fileNames = new Set();
62
+ const fileNames = new Set();
63
+
64
+ const svgImportTemplate = svgContent => {
65
+ return `export default \`${svgContent}\`;`
66
+ };
67
+ const svgToJs = async fileName => {
68
+ const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
69
+ const fileContent = svgImportTemplate(svg);
70
+ fileName = fileName.replace(/\.svg$/, ".js");
71
+
72
+ return fs.writeFile(path.join(destPath, fileName), fileContent);
73
+ };
74
+ const illustrationImportTemplate = illustrationName => {
75
+ let illustrationNameForTranslation = illustrationName;
76
+
77
+ if (defaultText) {
78
+ if (FALLBACK_TEXTS[illustrationNameForTranslation]) {
79
+ illustrationNameForTranslation = FALLBACK_TEXTS[illustrationNameForTranslation];
80
+ } else if (illustrationName.indexOf("_v") !== -1) {
81
+ illustrationNameForTranslation = illustrationNameForTranslation.substr(0, illustrationNameForTranslation.indexOf('_v'));
82
+ }
83
+ }
14
84
 
15
- const svgImportTemplate = svgContent => { return `export default \`${svgContent}\`;`};
16
- const illustrationImportTemplate = illustrationName => {
17
- const illustationNameUpperCase = illustrationName.toUpperCase();
85
+ const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
18
86
 
19
- return `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
20
- import dialogSvg from "./sapIllus-Dialog-${illustrationName}.js";
21
- import sceneSvg from "./sapIllus-Scene-${illustrationName}.js";
22
- import spotSvg from "./sapIllus-Spot-${illustrationName}.js";
87
+ return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
88
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
89
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
90
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
23
91
  import {
24
- IM_TITLE_${illustationNameUpperCase},
25
- IM_SUBTITLE_${illustationNameUpperCase},
92
+ IM_TITLE_${illustrationNameUpperCase},
93
+ IM_SUBTITLE_${illustrationNameUpperCase},
26
94
  } from "../generated/i18n/i18n-defaults.js";
27
95
 
28
96
  const name = "${illustrationName}";
29
- const title = IM_TITLE_${illustationNameUpperCase};
30
- const subtitle = IM_SUBTITLE_${illustationNameUpperCase};
97
+ const set = "${illustrationSet}";
98
+ const title = IM_TITLE_${illustrationNameUpperCase};
99
+ const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
31
100
 
32
101
  registerIllustration(name, {
33
102
  dialogSvg,
@@ -35,36 +104,58 @@ registerIllustration(name, {
35
104
  spotSvg,
36
105
  title,
37
106
  subtitle,
107
+ set,
38
108
  });
39
109
 
40
110
  export {
41
111
  dialogSvg,
42
112
  sceneSvg,
43
113
  spotSvg,
44
- };`};
114
+ };` :
115
+ `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
116
+ import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
117
+ import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
118
+ import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
45
119
 
46
- const svgToJs = fileName => {
47
- const svg = fs.readFileSync(path.join(srcPath, fileName), { encoding: "utf-8" });
48
- const fileContent = svgImportTemplate(svg);
49
- fileName = fileName.replace(/\.svg$/, ".js");
120
+ const name = "${illustrationName}";
121
+ const set = "${illustrationSet}";
50
122
 
51
- fs.writeFileSync(path.join(destPath, fileName), fileContent);
52
- }
123
+ registerIllustration(name, {
124
+ dialogSvg,
125
+ sceneSvg,
126
+ spotSvg,
127
+ set,
128
+ });
129
+
130
+ export {
131
+ dialogSvg,
132
+ sceneSvg,
133
+ spotSvg,
134
+ };`
135
+ };
53
136
 
54
- mkdirp.sync(destPath);
137
+ await fs.mkdir(destPath, { recursive: true });
55
138
 
56
- const illustrationFileNames = fs.readdirSync(path.normalize(srcPath));
139
+ const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
57
140
 
58
- // convert SVG to JS imports
59
- illustrationFileNames.forEach(illustration => {
60
- if (fileNamePattern.test(illustration)) {
61
- let [fileName, illustrationName] = illustration.match(fileNamePattern);
141
+ // convert SVG to JS imports
142
+ const promises = [];
143
+ illustrationFileNames.forEach(illustration => {
144
+ if (fileNamePattern.test(illustration)) {
145
+ let [fileName, illustrationName] = illustration.match(fileNamePattern);
62
146
 
63
- svgToJs(fileName);
64
- fileNames.add(illustrationName);
147
+ promises.push(svgToJs(fileName));
148
+ fileNames.add(illustrationName);
149
+ }
150
+ });
151
+
152
+ for (let illustrationName of fileNames) {
153
+ promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
65
154
  }
66
- });
67
155
 
68
- for (let illustrationName of fileNames) {
69
- fs.writeFileSync(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName));
70
- }
156
+ return Promise.all(promises);
157
+ };
158
+
159
+ generate().then(() => {
160
+ console.log("Illustrations generated.");
161
+ });
@@ -7,159 +7,162 @@ const eventsTemplate = require('./templates/api-events-section').template;
7
7
  const methodsTemplate = require('./templates/api-methods-section').template;
8
8
  const cssVariablesTemplate = require('./templates/api-css-variables-section').template;
9
9
  const Handlebars = require('handlebars/dist/handlebars.min.js');
10
- const fs = require('fs');
10
+ const fs = require('fs').promises;
11
11
  const path = require('path');
12
- const mkdirp = require('mkdirp');
13
12
  const beautify = require("json-beautify");
14
13
 
14
+ const generate = async () => {
15
15
 
16
- const apiJSONPath = path.normalize(process.argv[2]);
17
- const api = JSON.parse(fs.readFileSync(apiJSONPath));
16
+ const apiJSONPath = path.normalize(process.argv[2]);
17
+ const api = JSON.parse(await fs.readFile(apiJSONPath));
18
18
 
19
- fs.writeFileSync(apiJSONPath, beautify(api, null, 2, 100));
19
+ await fs.writeFile(apiJSONPath, beautify(api, null, 2, 100));
20
20
 
21
- const entries = api['symbols'];
22
- const compiledHandlebars = Handlebars.compile(template);
23
- const compiledSinceTemplate = Handlebars.compile(sinceTemplate);
24
- const linkMatcher = /{@link(\s)(\w+)\s*}/gi;
25
- const sinceMarker = "<!--since_tag_marker-->";
21
+ const entries = api['symbols'];
22
+ const compiledHandlebars = Handlebars.compile(template);
23
+ const compiledSinceTemplate = Handlebars.compile(sinceTemplate);
24
+ const linkMatcher = /{@link(\s)(\w+)\s*}/gi;
25
+ const sinceMarker = "<!--since_tag_marker-->";
26
26
 
27
- const getComponentByName = name => {
28
- return entries.find(element => {
29
- return element.basename === name;
30
- })
31
- };
27
+ const getComponentByName = name => {
28
+ return entries.find(element => {
29
+ return element.basename === name;
30
+ })
31
+ };
32
32
 
33
- const getCSSVarsByName = name => {
34
- return cssVariables[name] || [];
35
- };
33
+ const getCSSVarsByName = name => {
34
+ return cssVariables[name] || [];
35
+ };
36
36
 
37
- const capitalize = str => {
38
- return str.replace(/^./, str => str.toUpperCase());
39
- };
40
-
41
- Handlebars.registerHelper('toLowerCase', function (str) {
42
- return str ? str.toLowerCase() : "";
43
- });
37
+ const capitalize = str => {
38
+ return str.replace(/^./, str => str.toUpperCase());
39
+ };
44
40
 
45
- Handlebars.registerHelper('toKebabCase', function (str) {
46
- const kebab = str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
47
- return kebab !== str ? kebab : undefined;
48
- });
49
-
50
- Handlebars.registerHelper('checkEven', function (iIndex) {
51
- return (iIndex % 2 === 0) ? "api-table-roll-even" : "api-table-roll-odd";
52
- });
41
+ Handlebars.registerHelper('toLowerCase', function (str) {
42
+ return str ? str.toLowerCase() : "";
43
+ });
53
44
 
54
- Handlebars.registerPartial('properties', propertiesTemplate);
55
- Handlebars.registerPartial('slots', slotsTemplate);
56
- Handlebars.registerPartial('events', eventsTemplate);
57
- Handlebars.registerPartial('methods', methodsTemplate);
58
- Handlebars.registerPartial('cssVariables', cssVariablesTemplate);
45
+ Handlebars.registerHelper('toKebabCase', function (str) {
46
+ const kebab = str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
47
+ return kebab !== str ? kebab : undefined;
48
+ });
59
49
 
60
- mkdirp.sync(`dist/test-resources/api`);
50
+ Handlebars.registerHelper('checkEven', function (iIndex) {
51
+ return (iIndex % 2 === 0) ? "api-table-roll-even" : "api-table-roll-odd";
52
+ });
61
53
 
62
- let entriesAPI = [];
54
+ Handlebars.registerPartial('properties', propertiesTemplate);
55
+ Handlebars.registerPartial('slots', slotsTemplate);
56
+ Handlebars.registerPartial('events', eventsTemplate);
57
+ Handlebars.registerPartial('methods', methodsTemplate);
58
+ Handlebars.registerPartial('cssVariables', cssVariablesTemplate);
63
59
 
64
- const appendCSSVarsAPI = entry => {
65
- entry.cssVariables = getCSSVarsByName(entry.basename);
66
- return entry;
67
- }
60
+ await fs.mkdir(`dist/test-resources/api`, { recursive: true });
68
61
 
69
- const componentHasEntityItem = (component, entity, name) => {
70
- return component[entity].some(x => x && x.name === name);
71
- };
72
- const removeEmpty = arr => arr.filter(x => x);
62
+ let entriesAPI = [];
73
63
 
74
- const calculateAPI = component => {
75
- if (entriesAPI.indexOf(component.basename) !== -1) {
76
- return component;
64
+ const appendCSSVarsAPI = entry => {
65
+ entry.cssVariables = getCSSVarsByName(entry.basename);
66
+ return entry;
77
67
  }
78
- const entities = ["properties", "slots", "events", "methods", "cssVariables"];
79
68
 
80
- // Initialize all entities with [] if necessary, and remove undefined things, and only leave public things
81
- entities.forEach(entity => {
82
- component[entity] = removeEmpty(component[entity] || []).filter(x => x.visibility === "public");
83
- });
69
+ const componentHasEntityItem = (component, entity, name) => {
70
+ return component[entity].some(x => x && x.name === name);
71
+ };
72
+ const removeEmpty = arr => arr.filter(x => x);
84
73
 
85
- component = appendCSSVarsAPI(component);
74
+ const calculateAPI = component => {
75
+ if (entriesAPI.indexOf(component.basename) !== -1) {
76
+ return component;
77
+ }
78
+ const entities = ["properties", "slots", "events", "methods", "cssVariables"];
86
79
 
87
- let parent = getComponentByName(component.extends);
88
- if (parent) {
89
- let parentComponent = calculateAPI(parent);
80
+ // Initialize all entities with [] if necessary, and remove undefined things, and only leave public things
90
81
  entities.forEach(entity => {
91
- parentComponent[entity].forEach( x => {
92
- if (!componentHasEntityItem(component, entity, x.name)) {
93
- component[entity].push(x);
94
- }
95
- });
82
+ component[entity] = removeEmpty(component[entity] || []).filter(x => x.visibility === "public");
96
83
  });
97
- }
98
84
 
99
- entriesAPI.push(component.basename);
85
+ component = appendCSSVarsAPI(component);
86
+
87
+ let parent = getComponentByName(component.extends);
88
+ if (parent) {
89
+ let parentComponent = calculateAPI(parent);
90
+ entities.forEach(entity => {
91
+ parentComponent[entity].forEach(x => {
92
+ if (!componentHasEntityItem(component, entity, x.name)) {
93
+ component[entity].push(x);
94
+ }
95
+ });
96
+ });
97
+ }
100
98
 
101
- return component;
102
- };
99
+ entriesAPI.push(component.basename);
103
100
 
104
- const appendAdditionalEntriesAPI = entry => {
105
- if (entry.appenddocs) {
106
- const additionalEntries = entry.appenddocs.split(" ");
107
- entry.additionalDocs = [];
101
+ return component;
102
+ };
108
103
 
109
- additionalEntries.forEach(entryName => {
110
- let additionalEntry = getComponentByName(entryName);
111
- additionalEntry = calculateAPI(additionalEntry);
112
- entry.additionalDocs.push(additionalEntry);
113
- });
114
- }
104
+ const appendAdditionalEntriesAPI = entry => {
105
+ if (entry.appenddocs) {
106
+ const additionalEntries = entry.appenddocs.split(" ");
107
+ entry.additionalDocs = [];
115
108
 
116
- return entry;
117
- }
109
+ additionalEntries.forEach(entryName => {
110
+ let additionalEntry = getComponentByName(entryName);
111
+ additionalEntry = calculateAPI(additionalEntry);
112
+ entry.additionalDocs.push(additionalEntry);
113
+ });
114
+ }
118
115
 
119
- const generateSamplePage = entry => {
120
- let content = "";
116
+ return entry;
117
+ }
121
118
 
122
- try {
123
- content = fs.readFileSync(`dist/test-resources/samples/${capitalize(entry.basename)}.sample.html`, 'utf8');
124
- } catch (err) { }
119
+ const generateSamplePage = async entry => {
120
+ let content = "";
125
121
 
126
- if (content) {
127
- entry.slots.forEach(slotData => {
128
- if (!slotData.type.startsWith("Node") && !slotData.type.startsWith("HTMLElement")) { // interface -> don't show in documentation
129
- slotData.type = "HTMLElement" + (slotData.type.endsWith("[]") ? "[]" : "");
130
- }
131
- });
132
- const APIReference = compiledHandlebars(entry).replace(/\[\]/g, " [0..n]");
133
- const EntitySince = compiledSinceTemplate(entry).replace(/\[\]/g, " [0..n]");
122
+ try {
123
+ content = await fs.readFile(`dist/test-resources/samples/${capitalize(entry.basename)}.sample.html`, 'utf8');
124
+ } catch (err) {
125
+ }
134
126
 
135
- content = content.replace('<!-- JSDoc marker -->', APIReference);
136
- content = content.replace(sinceMarker, EntitySince);
127
+ if (content) {
128
+ entry.slots.forEach(slotData => {
129
+ if (!slotData.type.startsWith("Node") && !slotData.type.startsWith("HTMLElement")) { // interface -> don't show in documentation
130
+ slotData.type = "HTMLElement" + (slotData.type.endsWith("[]") ? "[]" : "");
131
+ }
132
+ });
133
+ const APIReference = compiledHandlebars(entry).replace(/\[\]/g, " [0..n]");
134
+ const EntitySince = compiledSinceTemplate(entry).replace(/\[\]/g, " [0..n]");
137
135
 
138
- content = content.replace(linkMatcher, match => {
139
- const component = linkMatcher.exec(match)[2];
136
+ content = content.replace('<!-- JSDoc marker -->', APIReference);
137
+ content = content.replace(sinceMarker, EntitySince);
140
138
 
141
- // reset the regex
142
- linkMatcher.lastIndex = 0;
139
+ content = content.replace(linkMatcher, match => {
140
+ const component = linkMatcher.exec(match)[2];
143
141
 
144
- return `<a href="#" onclick="redirect(event, '${component}')">${component}</a>`;
145
- });
142
+ // reset the regex
143
+ linkMatcher.lastIndex = 0;
146
144
 
147
- fs.writeFile(`dist/test-resources/api/${entry.basename}.sample.html`, content, (err) => {
148
- // console.log(err);
149
- });
145
+ return `<a href="#" onclick="redirect(event, '${component}')">${component}</a>`;
146
+ });
147
+
148
+ return fs.writeFile(`dist/test-resources/api/${entry.basename}.sample.html`, content);
149
+ }
150
150
  }
151
- }
152
151
 
153
- const generateComponentAPI = entry => {
154
- // (1) calculate the API
155
- entry = calculateAPI(entry);
152
+ const generateComponentAPI = entry => {
153
+ // (1) calculate the API
154
+ entry = calculateAPI(entry);
156
155
 
157
- // (2) append additional API for composition components - List -> ListIems, TabContainer -> Tabs, Table -> TableRow/Column/Cell
158
- entry = appendAdditionalEntriesAPI(entry);
156
+ // (2) append additional API for composition components - List -> ListIems, TabContainer -> Tabs, Table -> TableRow/Column/Cell
157
+ entry = appendAdditionalEntriesAPI(entry);
159
158
 
160
- // (3) generate sample page
161
- generateSamplePage(entry);
162
- }
159
+ // (3) generate sample page
160
+ return generateSamplePage(entry);
161
+ }
162
+
163
+ return Promise.all(entries.map(generateComponentAPI));
164
+ };
163
165
 
164
- entries.forEach(generateComponentAPI);
165
- entriesAPI = [];
166
+ generate().then(() => {
167
+ console.log("Documentation generated.");
168
+ });
@@ -21,7 +21,9 @@ module.exports = {
21
21
  {{/if}}
22
22
  <br>
23
23
  {{#if (toKebabCase this.name)}}
24
- <code>{{toKebabCase this.name}}</code>
24
+ {{#unless this.noattribute}}
25
+ <code>{{toKebabCase this.name}}</code>
26
+ {{/unless}}
25
27
  {{/if}}
26
28
  </div>
27
29
  <div class="cell api-table-content-cell">{{this.type}}</div>
@@ -23,6 +23,7 @@ module.exports = {
23
23
  {{> properties this}}
24
24
  {{> slots this}}
25
25
  {{> events this}}
26
+ {{> methods this}}
26
27
  {{> cssVariables this}}
27
28
  </section>
28
29
  </section>
@@ -33,6 +34,6 @@ module.exports = {
33
34
  <a class="separator" href="https://www.sap.com/about/legal/privacy.html" target="_blank">Privacy Policy</a>
34
35
  <a href="https://www.sap.com/about/legal/impressum.html" target="_blank">Legal</a>
35
36
  </div>
36
- <img src="../../../../../../assets/images/sap-logo-svg.svg" alt="Sap Logo" />
37
+ <img src="../../../assets/images/sap-logo-svg.svg" alt="Sap Logo" />
37
38
  </footer>`
38
39
  };
@@ -1,15 +1,14 @@
1
1
  const esprima = require("esprima");
2
2
  const escodegen = require("escodegen");
3
3
 
4
- const fs = require("fs");
4
+ const fs = require("fs").promises;
5
5
  const path = require("path");
6
- const glob = require("glob");
7
6
  const basePath = process.argv[2];
8
7
 
9
- const convertImports = (srcPath) => {
8
+ const convertImports = async (srcPath) => {
10
9
  let changed = false;
11
10
  // console.log("scanning imports of", srcPath);
12
- let code = fs.readFileSync(srcPath).toString();
11
+ let code = (await fs.readFile(srcPath)).toString();
13
12
  const tree = esprima.parseModule(code);
14
13
  const importer = srcPath.replace(basePath, "");
15
14
  const importerDir = path.dirname(importer);
@@ -44,11 +43,16 @@ const convertImports = (srcPath) => {
44
43
  });
45
44
 
46
45
  if (changed) {
47
- fs.writeFileSync(srcPath, escodegen.generate(tree));
46
+ return fs.writeFile(srcPath, escodegen.generate(tree));
48
47
  }
49
48
  }
50
49
 
51
- const fileNames = glob.sync(basePath + "**/*.js");
52
- // console.log(fileNames);
53
- fileNames.forEach(convertImports);
54
- console.log("Success: Converted absolute imports to relative for files in:", basePath)
50
+ const generate = async () => {
51
+ const { globby } = await import("globby");
52
+ const fileNames = await globby(basePath + "**/*.js");
53
+ return Promise.all(fileNames.map(convertImports).filter(x => !!x));
54
+ };
55
+
56
+ generate().then(() => {
57
+ console.log("Success: Converted absolute imports to relative for files in:", basePath);
58
+ });
@@ -1,37 +1,38 @@
1
- const fs = require("fs");
1
+ const fs = require("fs").promises;
2
2
  const path = require('path');
3
- const mkdirp = require("mkdirp");
4
3
 
5
- const packageName = JSON.parse(fs.readFileSync("package.json")).name;
4
+ const generate = async () => {
6
5
 
7
- const inputFolder = path.normalize(process.argv[2]);
8
- const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
9
- const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
6
+ const packageName = JSON.parse(await fs.readFile("package.json")).name;
7
+
8
+ const inputFolder = path.normalize(process.argv[2]);
9
+ const outputFile = path.normalize(`${process.argv[3]}/i18n-static.js`);
10
+ const outputFileDynamic = path.normalize(`${process.argv[3]}/i18n.js`);
10
11
 
11
12
  // All languages present in the file system
12
- const files = fs.readdirSync(inputFolder);
13
- const languages = files.map(file => {
14
- const matches = file.match(/messagebundle_(.+?).json$/);
15
- return matches ? matches[1] : undefined;
16
- }).filter(key => !!key);
13
+ const files = await fs.readdir(inputFolder);
14
+ const languages = files.map(file => {
15
+ const matches = file.match(/messagebundle_(.+?).json$/);
16
+ return matches ? matches[1] : undefined;
17
+ }).filter(key => !!key);
17
18
 
18
- let contentStatic, contentDynamic;
19
+ let contentStatic, contentDynamic;
19
20
 
20
21
  // No i18n - just import dependencies, if any
21
- if (languages.length === 0) {
22
- contentStatic = "";
23
- contentDynamic = "";
22
+ if (languages.length === 0) {
23
+ contentStatic = "";
24
+ contentDynamic = "";
24
25
  // There is i18n - generate the full file
25
- } else {
26
- // Keys for the array
27
- const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
28
- const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
26
+ } else {
27
+ // Keys for the array
28
+ const languagesKeysString = languages.map(key => `"${key}": _${key},`).join("\n\t");
29
+ const languagesKeysStringArray = languages.map(key => `"${key}",`).join("\n\t");
29
30
 
30
- // Actual imports for json assets
31
- const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
31
+ // Actual imports for json assets
32
+ const assetsImportsString = languages.map(key => `import _${key} from "../assets/i18n/messagebundle_${key}.json";`).join("\n");
32
33
 
33
- // static imports
34
- contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
34
+ // static imports
35
+ contentStatic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
35
36
 
36
37
  ${assetsImportsString}
37
38
 
@@ -54,11 +55,11 @@ localeIds.forEach(localeId => {
54
55
  });
55
56
  `;
56
57
 
57
- // Actual imports for json assets
58
- const dynamicImportsString = languages.map(key => ` case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
58
+ // Actual imports for json assets
59
+ const dynamicImportsString = languages.map(key => ` case "${key}": return (await import("../assets/i18n/messagebundle_${key}.json")).default;`).join("\n");
59
60
 
60
- // Resulting file content
61
- contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
61
+ // Resulting file content
62
+ contentDynamic = `import { registerI18nLoader } from "@ui5/webcomponents-base/dist/asset-registries/i18n.js";
62
63
 
63
64
  const importMessageBundle = async (localeId) => {
64
65
  switch (localeId) {
@@ -83,9 +84,15 @@ localeIds.forEach(localeId => {
83
84
  `;
84
85
 
85
86
 
86
- }
87
+ }
87
88
 
89
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
90
+ return Promise.all([
91
+ fs.writeFile(outputFile, contentStatic),
92
+ fs.writeFile(outputFileDynamic, contentDynamic),
93
+ ]);
94
+ }
88
95
 
89
- mkdirp.sync(path.dirname(outputFile));
90
- fs.writeFileSync(outputFile, contentStatic);
91
- fs.writeFileSync(outputFileDynamic, contentDynamic);
96
+ generate().then(() => {
97
+ console.log("Generated i18n JSON imports.");
98
+ });