@ui5/webcomponents-tools 0.0.0-fa45f79f6 → 0.0.0-fc993d8cd

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 (89) hide show
  1. package/CHANGELOG.md +464 -1
  2. package/README.md +5 -6
  3. package/assets-meta.js +153 -0
  4. package/bin/dev.js +12 -1
  5. package/components-package/eslint.js +34 -0
  6. package/components-package/nps.js +112 -44
  7. package/components-package/postcss.components.js +13 -13
  8. package/components-package/postcss.themes.js +19 -16
  9. package/components-package/vite.config.js +13 -0
  10. package/components-package/wdio.js +393 -333
  11. package/components-package/wdio.sync.js +360 -0
  12. package/icons-collection/nps.js +69 -28
  13. package/lib/copy-and-watch/index.js +145 -0
  14. package/lib/copy-list/index.js +28 -0
  15. package/lib/create-icons/index.js +124 -50
  16. package/lib/create-illustrations/index.js +161 -0
  17. package/lib/create-new-component/index.js +108 -99
  18. package/lib/create-new-component/jsFileContentTemplate.js +77 -0
  19. package/lib/create-new-component/tsFileContentTemplate.js +84 -0
  20. package/lib/dev-server/dev-server.js +66 -0
  21. package/lib/dev-server/virtual-index-html-plugin.js +52 -0
  22. package/lib/esm-abs-to-rel/index.js +58 -0
  23. package/lib/generate-custom-elements-manifest/index.js +327 -0
  24. package/lib/generate-js-imports/illustrations.js +72 -0
  25. package/lib/generate-json-imports/i18n.js +98 -47
  26. package/lib/generate-json-imports/themes.js +71 -16
  27. package/lib/hbs2lit/index.js +2 -4
  28. package/lib/hbs2lit/src/compiler.js +26 -8
  29. package/lib/hbs2lit/src/includesReplacer.js +23 -17
  30. package/lib/hbs2lit/src/litVisitor2.js +103 -19
  31. package/lib/hbs2lit/src/svgProcessor.js +3 -3
  32. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +5 -5
  33. package/lib/hbs2ui5/index.js +52 -30
  34. package/lib/i18n/defaults.js +77 -50
  35. package/lib/i18n/toJSON.js +25 -13
  36. package/lib/jsdoc/config.json +1 -1
  37. package/lib/jsdoc/configTypescript.json +29 -0
  38. package/lib/jsdoc/plugin.js +65 -4
  39. package/lib/jsdoc/preprocess.js +146 -0
  40. package/lib/jsdoc/template/publish.js +32 -4
  41. package/lib/postcss-combine-duplicated-selectors/index.js +178 -0
  42. package/lib/postcss-css-to-esm/index.js +74 -17
  43. package/lib/postcss-css-to-json/index.js +38 -11
  44. package/lib/postcss-new-files/index.js +36 -0
  45. package/lib/postcss-p/postcss-p.mjs +14 -0
  46. package/lib/replace-global-core/index.js +25 -0
  47. package/lib/scoping/get-all-tags.js +37 -0
  48. package/lib/scoping/lint-src.js +31 -0
  49. package/lib/scoping/missing-dependencies.js +65 -0
  50. package/lib/scoping/report-tags-usage.js +28 -0
  51. package/lib/scoping/scope-test-pages.js +40 -0
  52. package/lib/test-runner/test-runner.js +71 -0
  53. package/package.json +54 -55
  54. package/bin/init-ui5-package.js +0 -3
  55. package/components-package/rollup.js +0 -134
  56. package/components-package/serve.json +0 -3
  57. package/lib/documentation/index.js +0 -143
  58. package/lib/documentation/templates/api-component-since.js +0 -3
  59. package/lib/documentation/templates/api-css-variables-section.js +0 -24
  60. package/lib/documentation/templates/api-events-section.js +0 -35
  61. package/lib/documentation/templates/api-methods-section.js +0 -26
  62. package/lib/documentation/templates/api-properties-section.js +0 -40
  63. package/lib/documentation/templates/api-slots-section.js +0 -28
  64. package/lib/documentation/templates/template.js +0 -38
  65. package/lib/init-package/index.js +0 -119
  66. package/lib/init-package/resources/.eslintignore +0 -3
  67. package/lib/init-package/resources/bundle.es5.js +0 -25
  68. package/lib/init-package/resources/bundle.esm.js +0 -34
  69. package/lib/init-package/resources/config/.eslintrc.js +0 -1
  70. package/lib/init-package/resources/config/postcss.components/postcss.config.js +0 -1
  71. package/lib/init-package/resources/config/postcss.themes/postcss.config.js +0 -1
  72. package/lib/init-package/resources/config/rollup.config.js +0 -1
  73. package/lib/init-package/resources/config/wdio.conf.js +0 -1
  74. package/lib/init-package/resources/package-scripts.js +0 -11
  75. package/lib/init-package/resources/src/Assets.js +0 -6
  76. package/lib/init-package/resources/src/Demo.hbs +0 -1
  77. package/lib/init-package/resources/src/Demo.js +0 -57
  78. package/lib/init-package/resources/src/i18n/messagebundle.properties +0 -2
  79. package/lib/init-package/resources/src/i18n/messagebundle_de.properties +0 -1
  80. package/lib/init-package/resources/src/i18n/messagebundle_en.properties +0 -1
  81. package/lib/init-package/resources/src/i18n/messagebundle_es.properties +0 -1
  82. package/lib/init-package/resources/src/i18n/messagebundle_fr.properties +0 -1
  83. package/lib/init-package/resources/src/themes/Demo.css +0 -11
  84. package/lib/init-package/resources/src/themes/sap_belize/parameters-bundle.css +0 -3
  85. package/lib/init-package/resources/src/themes/sap_belize_hcb/parameters-bundle.css +0 -3
  86. package/lib/init-package/resources/src/themes/sap_fiori_3/parameters-bundle.css +0 -3
  87. package/lib/init-package/resources/src/themes/sap_fiori_3_dark/parameters-bundle.css +0 -3
  88. package/lib/init-package/resources/test/pages/index.html +0 -51
  89. package/lib/init-package/resources/test/specs/Demo.spec.js +0 -12
@@ -1,8 +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
+ const recursiveReadDir = require("recursive-readdir");
6
7
 
7
8
  const args = getopts(process.argv.slice(2), {
8
9
  alias: {
@@ -18,55 +19,74 @@ const args = getopts(process.argv.slice(2), {
18
19
 
19
20
  const onError = (place) => {
20
21
  console.log(`A problem occoured when reading ${place}. Please recheck passed parameters.`);
21
- }
22
+ };
23
+
22
24
  const isHandlebars = (fileName) => fileName.indexOf('.hbs') !== -1;
23
- const parseFile = (filePath, inputDir, outputDir) => {
24
- fs.readFile(filePath, 'utf-8', (err, content) => {
25
25
 
26
- if (err) {
27
- onError('file');
28
- }
26
+ const processFile = async (file, outputDir) => {
27
+ const litCode = await hbs2lit(file);
28
+ const absoluteOutputDir = composeAbsoluteOutputDir(file, outputDir);
29
+ const componentNameMatcher = /(\w+)(\.hbs)/gim;
30
+ const componentName = componentNameMatcher.exec(file)[1];
29
31
 
30
- hbs2lit.compileString(content, {
31
- templatesPath: inputDir,
32
- compiledTemplatesPath: outputDir
33
- }).then((litCode) => {
34
- const componentNameMatcher = /(\w+)(\.hbs)/gim;
35
- const componentName = componentNameMatcher.exec(filePath)[1];
32
+ return writeRenderers(absoluteOutputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
33
+ };
36
34
 
37
- writeRenderers(outputDir, componentName, litRenderer.generateTemplate(componentName, litCode));
38
- });
39
- });
40
- }
35
+ const composeAbsoluteOutputDir = (file, outputDir) => {
36
+ // (1) Extract the dir structure from the source file path - "src/lvl1/lvl2/MyCompBadge.hbs"
37
+ // - remove the filename - "src/lvl1/lvl2"
38
+ // - remove the leading dir - "lvl1/lvl2"
39
+ const fileDir = file.split(path.sep).slice(1, -1).join(path.sep);
40
+
41
+ // (2) Compose full output dir - "dist/generated/templates/lvl1/lvl2"
42
+ return `${outputDir}${path.sep}${fileDir}`;
43
+ };
41
44
 
42
45
  const wrapDirectory = (directory, outputDir) => {
43
46
  directory = path.normalize(directory);
44
47
  outputDir = path.normalize(outputDir);
45
48
 
46
- fs.readdir(directory, (err, files) => {
49
+ return new Promise((resolve, reject) => {
50
+ recursiveReadDir(directory, (err, files) => {
47
51
 
48
- if (err) {
49
- onError('directory');
50
- }
52
+ if (err) {
53
+ onError('directory');
54
+ reject();
55
+ }
51
56
 
52
- files.forEach(fileName => {
53
- if (isHandlebars(fileName)) {
57
+ const promises = files.map(fileName => {
58
+ if (isHandlebars(fileName)) {
59
+ return processFile(fileName, outputDir);
60
+ }
61
+ }).filter(x => !!x);
54
62
 
55
- // could be refactored a bit
56
- parseFile(directory + fileName, directory, outputDir);
57
- }
63
+ resolve(Promise.all(promises));
58
64
  });
59
- })
65
+ });
60
66
  };
61
67
 
62
- const writeRenderers = (outputDir, controlName, fileContent) => {
68
+ const writeRenderers = async (outputDir, controlName, fileContent) => {
63
69
  try {
70
+
71
+ await fs.mkdir(outputDir, { recursive: true });
72
+
64
73
  const compiledFilePath = `${outputDir}${path.sep}${controlName}Template.lit.js`;
65
74
 
66
75
  // strip DOS line endings because the break the source maps
67
76
  let fileContentUnix = fileContent.replace(/\r\n/g, "\n");
68
77
  fileContentUnix = fileContentUnix.replace(/\r/g, "\n");
69
- fs.writeFileSync(compiledFilePath, fileContentUnix);
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
+ }
70
90
 
71
91
  } catch (e) {
72
92
  console.log(e);
@@ -76,5 +96,7 @@ const writeRenderers = (outputDir, controlName, fileContent) => {
76
96
  if (!args['d'] || !args['o']) {
77
97
  console.log('Please provide an input and output directory (-d and -o)');
78
98
  } else {
79
- wrapDirectory(args['d'], args['o']);
99
+ wrapDirectory(args['d'], args['o']).then(() => {
100
+ console.log("Templates generated");
101
+ });
80
102
  }
@@ -1,55 +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 messageBundle = path.normalize(`${process.argv[2]}/messagebundle.properties`);
5
- const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.js`);
6
-
7
- if (!messageBundle || !outputFile) {
8
- return;
9
- }
10
-
11
- const properties = PropertiesReader(messageBundle)._properties;
12
-
13
- /*
14
- * Returns the single text object to enable single export.
15
- *
16
- * Example:
17
- * const ARIA_LABEL_CARD_CONTENT = {
18
- * key: "ARIA_LABEL_CARD_CONTENT",
19
- * defaultText: "Card Content",
20
- * };
21
- */
22
- const getTextInfo = (key, value) => `const ${key} = {key: "${key}", defaultText: "${value}"};`;
23
-
24
- /*
25
- * Returns the complete content of i18n-defaults.js file:
26
- * (1) the single text objects
27
- * (2) the export statement at the end of the file
28
- *
29
- * Example:
30
- * export {
31
- * ARIA_LABEL_CARD_CONTENT,
32
- * }
33
- */
34
- const getOutputFileContent = (properties) => {
35
- const textKeys = Object.keys(properties);
36
- const texts = textKeys.map(prop => getTextInfo(prop, properties[prop])).join('');
37
-
38
- return `${texts}
39
- export {${textKeys.join()}};`;
40
- }
41
-
42
- /*
43
- * Writes the i18n-defaults.js.
44
- */
45
- const writeI18nDefaultsFile = (file, content) => {
46
- fs.writeFile(file, content, (err) => {
47
- if (err) {
48
- return console.log(err);
4
+ const assets = require('../../assets-meta.js');
5
+
6
+ const generate = async () => {
7
+ const defaultLanguage = assets.languages.default;
8
+
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
+
13
+ const outputFile = path.normalize(`${process.argv[3]}/i18n-defaults.${tsMode ? "ts": "js"}`);
14
+
15
+ if (!messageBundle || !outputFile) {
16
+ return;
17
+ }
18
+
19
+ const properties = PropertiesReader(messageBundle)._properties;
20
+
21
+ let defaultLanguageProperties;
22
+ try {
23
+ defaultLanguageProperties = PropertiesReader(messageBundleDefaultLanguage)._properties;
24
+ } catch (e) {
25
+ }
26
+
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
+ }
36
+
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
49
+
50
+ if (tsMode) {
51
+ return `const ${key}: I18nText = {key: "${key}", defaultText: "${effectiveValue}"};`;
49
52
  }
53
+ return `const ${key} = {key: "${key}", defaultText: "${effectiveValue}"};`;
54
+ };
55
+
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('');
69
+
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
+ };
50
75
 
51
- console.log(`[i18n]: "${file}" file has been created`);
52
- });
53
- }
76
+ await fs.mkdir(path.dirname(outputFile), { recursive: true });
77
+ await fs.writeFile(outputFile, getOutputFileContent(properties, defaultLanguageProperties));
78
+ };
54
79
 
55
- writeI18nDefaultsFile(outputFile, getOutputFileContent(properties));
80
+ generate().then(() => {
81
+ console.log("i18n default file generated.");
82
+ });
@@ -3,29 +3,41 @@
3
3
  *
4
4
  * Execution (note: the paths depends on the the execution context)
5
5
  * node toJSON.js ../../src/assets/i18n ../../dist/generated/assets/i18n
6
- *
6
+ *
7
7
  * The 1st param '../../src/assets/i18n' is the location of messagebundle_*.properties files
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;
13
+ const assets = require('../../assets-meta.js');
14
+
15
+ const allLanguages = assets.languages.all;
16
+
14
17
  const messagesBundles = path.normalize(`${process.argv[2]}/messagebundle_*.properties`);
15
18
  const messagesJSONDist = path.normalize(`${process.argv[3]}`);
16
19
 
17
- const convertToJSON = (file) => {
20
+ const convertToJSON = async (file) => {
18
21
  const properties = PropertiesReader(file)._properties;
19
22
  const filename = path.basename(file, path.extname(file));
23
+ const language = filename.match(/^messagebundle_(.*?)$/)[1];
24
+ if (!allLanguages.includes(language)) {
25
+ console.log("Not supported language: ", language);
26
+ return;
27
+ }
20
28
  const outputFile = path.normalize(`${messagesJSONDist}/${filename}.json`);
21
29
 
22
- fs.writeFileSync(outputFile, JSON.stringify(properties));
23
- console.log(`[i18n]: "${filename}.json" has been generated!`);
24
- }
30
+ return fs.writeFile(outputFile, JSON.stringify(properties));
31
+ // console.log(`[i18n]: "${filename}.json" has been generated!`);
32
+ };
25
33
 
26
- glob(messagesBundles, {}, (err, files) => {
27
- if (err) {
28
- return console.log("No messagebundle files found!");
29
- }
30
- files.forEach(convertToJSON);
31
- });
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.");
43
+ });
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "source": {
3
3
  "include": "src",
4
- "excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js"
4
+ "excludePattern": "(/|\\\\)library-all\\.js|(/|\\\\).*-preload\\.js|^jquery-.*\\.js|^sap-.*\\.js|.+Renderer\\.lit\\.js|.*library\\.js|thirdparty"
5
5
  },
6
6
  "opts" : {
7
7
  "recurse": true,
@@ -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
+ }
@@ -29,7 +29,17 @@
29
29
  *
30
30
  * appenddocs
31
31
  *
32
- * customtag
32
+ * tagname
33
+ *
34
+ * native
35
+ *
36
+ * noattribute
37
+ *
38
+ * formEvents
39
+ *
40
+ * formProperty
41
+ *
42
+ * allowPreventDefault
33
43
  *
34
44
  * It furthermore listens to the following JSDoc3 events to implement additional functionality
35
45
  *
@@ -2060,9 +2070,11 @@ exports.defineTags = function(dictionary) {
2060
2070
  });
2061
2071
 
2062
2072
  dictionary.defineTag('slot', {
2063
- mustNotHaveValue: true,
2064
2073
  onTagged: function(doclet, tag) {
2065
2074
  doclet.slot = true;
2075
+ if (tag.value) {
2076
+ doclet.propertyName = tag.value;
2077
+ }
2066
2078
  }
2067
2079
  });
2068
2080
 
@@ -2073,10 +2085,59 @@ exports.defineTags = function(dictionary) {
2073
2085
  }
2074
2086
  });
2075
2087
 
2076
- dictionary.defineTag('customtag', {
2088
+ dictionary.defineTag('tagname', {
2077
2089
  mustHaveValue: true,
2078
2090
  onTagged: function(doclet, tag) {
2079
- doclet.customtag = tag.value;
2091
+ doclet.tagname = tag.value;
2092
+ }
2093
+ });
2094
+
2095
+ dictionary.defineTag('allowPreventDefault', {
2096
+ mustHaveValue: false,
2097
+ onTagged: function(doclet, tag) {
2098
+ doclet.allowPreventDefault = true;
2099
+ }
2100
+ });
2101
+
2102
+ dictionary.defineTag('native', {
2103
+ mustHaveValue: false,
2104
+ onTagged: function(doclet, tag) {
2105
+ doclet.native = true;
2106
+ }
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;
2080
2141
  }
2081
2142
  });
2082
2143
  };
@@ -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
+
@@ -2651,8 +2651,8 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
2651
2651
 
2652
2652
  attrib("name", symbol.longname);
2653
2653
  attrib("basename", symbol.name);
2654
- if (symbol.customtag) {
2655
- attrib("customTag", symbol.customtag);
2654
+ if (symbol.tagname) {
2655
+ attrib("tagname", symbol.tagname);
2656
2656
  }
2657
2657
  if (symbol.appenddocs) {
2658
2658
  attrib("appenddocs", symbol.appenddocs);
@@ -2804,6 +2804,10 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
2804
2804
  attrib("export", undefined, '', true);
2805
2805
  }
2806
2806
 
2807
+ if (member.noattribute) {
2808
+ attrib("noattribute", true);
2809
+ }
2810
+
2807
2811
  if (member.readonly) {
2808
2812
  attrib("readonly", member.readonly, null);
2809
2813
  }
@@ -2815,7 +2819,22 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
2815
2819
  if ( member.since ) {
2816
2820
  attrib("since", extractVersion(member.since));
2817
2821
  }
2818
- attrib("type", listTypes(member.type));
2822
+
2823
+ if ( member.formEvents ) {
2824
+ attrib("formEvents", member.formEvents);
2825
+ }
2826
+
2827
+ if ( member.formEvents ) {
2828
+ attrib("formProperty", member.formProperty);
2829
+ }
2830
+
2831
+ var type = listTypes(member.type);
2832
+ attrib("type", type);
2833
+
2834
+ if ((type === "object" || type === "Object") && visibility(member) === "public") {
2835
+ attrib("noattribute", true);
2836
+ }
2837
+
2819
2838
  tag("description", normalizeWS(member.description), true);
2820
2839
  if (member.defaultvalue) {
2821
2840
  attrib("defaultValue", member.defaultvalue);
@@ -2838,6 +2857,9 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
2838
2857
  if (member.slot) {
2839
2858
  tag("property");
2840
2859
  attrib("name", member.name);
2860
+ if (member.propertyName) {
2861
+ attrib("propertyName", member.propertyName);
2862
+ }
2841
2863
  if (member.__ui5.module && member.__ui5.module !== symbol.__ui5.module) {
2842
2864
  attrib("module", member.__ui5.module);
2843
2865
  attrib("export", undefined, '', true);
@@ -2879,6 +2901,12 @@ function createAPIJSON4Symbol(symbol, omitDefaults) {
2879
2901
  attrib("module", member.__ui5.module);
2880
2902
  attrib("export", undefined, '', true);
2881
2903
  }
2904
+ if (member.allowPreventDefault) {
2905
+ attrib("allowPreventDefault", true);
2906
+ }
2907
+ if (member.native) {
2908
+ attrib("native", true);
2909
+ }
2882
2910
  attrib("visibility", visibility(member), 'public');
2883
2911
  if ( member.scope === 'static' ) {
2884
2912
  attrib("static", true, false, /* raw = */true);
@@ -3845,7 +3873,7 @@ function createAPIJS(symbols, filename) {
3845
3873
 
3846
3874
  var output = [];
3847
3875
 
3848
- 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|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)$/;
3849
3877
 
3850
3878
  function isNoKeyword($) { return !rkeywords.test($.name); }
3851
3879