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

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 (64) hide show
  1. package/CHANGELOG.md +1700 -0
  2. package/README.md +3 -5
  3. package/assets-meta.js +12 -11
  4. package/components-package/eslint.js +59 -29
  5. package/components-package/nps.js +77 -48
  6. package/components-package/postcss.components.js +1 -21
  7. package/components-package/postcss.themes.js +1 -26
  8. package/components-package/vite.config.js +7 -11
  9. package/components-package/wdio.js +415 -393
  10. package/icons-collection/nps.js +9 -7
  11. package/lib/amd-to-es6/index.js +102 -0
  12. package/lib/amd-to-es6/no-remaining-require.js +33 -0
  13. package/lib/cem/custom-elements-manifest.config.mjs +530 -0
  14. package/lib/cem/event.mjs +168 -0
  15. package/lib/cem/schema-internal.json +1422 -0
  16. package/lib/cem/schema.json +1098 -0
  17. package/lib/cem/types-internal.d.ts +808 -0
  18. package/lib/cem/types.d.ts +736 -0
  19. package/lib/cem/utils.mjs +423 -0
  20. package/lib/cem/validate.js +67 -0
  21. package/lib/create-icons/index.js +13 -10
  22. package/lib/create-illustrations/index.js +70 -31
  23. package/lib/create-new-component/{tsFileContentTemplate.js → Component.js} +15 -25
  24. package/lib/create-new-component/ComponentTemplate.js +12 -0
  25. package/lib/create-new-component/index.js +35 -73
  26. package/lib/css-processors/css-processor-components.mjs +78 -0
  27. package/lib/css-processors/css-processor-themes.mjs +74 -0
  28. package/lib/css-processors/scope-variables.mjs +49 -0
  29. package/lib/css-processors/shared.mjs +56 -0
  30. package/lib/dev-server/custom-hot-update-plugin.js +39 -0
  31. package/lib/dev-server/{dev-server.js → dev-server.mjs} +4 -4
  32. package/lib/dev-server/virtual-index-html-plugin.js +24 -20
  33. package/lib/generate-js-imports/illustrations.js +78 -64
  34. package/lib/generate-json-imports/i18n.js +51 -62
  35. package/lib/generate-json-imports/themes.js +23 -37
  36. package/lib/hbs2lit/src/compiler.js +9 -6
  37. package/lib/hbs2lit/src/litVisitor2.js +42 -17
  38. package/lib/hbs2lit/src/svgProcessor.js +12 -5
  39. package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +39 -6
  40. package/lib/hbs2ui5/index.js +23 -6
  41. package/lib/i18n/defaults.js +3 -2
  42. package/lib/i18n/toJSON.js +1 -1
  43. package/lib/postcss-combine-duplicated-selectors/index.js +12 -5
  44. package/lib/remove-dev-mode/remove-dev-mode.mjs +37 -0
  45. package/lib/scoping/get-all-tags.js +10 -3
  46. package/lib/scoping/lint-src.js +8 -7
  47. package/lib/scoping/scope-test-pages.js +2 -1
  48. package/lib/test-runner/test-runner.js +2 -2
  49. package/package.json +17 -13
  50. package/tsconfig.json +18 -0
  51. package/components-package/wdio.sync.js +0 -360
  52. package/lib/create-new-component/jsFileContentTemplate.js +0 -77
  53. package/lib/esm-abs-to-rel/index.js +0 -58
  54. package/lib/generate-custom-elements-manifest/index.js +0 -327
  55. package/lib/jsdoc/config.json +0 -29
  56. package/lib/jsdoc/configTypescript.json +0 -29
  57. package/lib/jsdoc/plugin.js +0 -2468
  58. package/lib/jsdoc/preprocess.js +0 -146
  59. package/lib/jsdoc/template/publish.js +0 -4120
  60. package/lib/postcss-css-to-esm/index.js +0 -90
  61. package/lib/postcss-css-to-json/index.js +0 -47
  62. package/lib/postcss-new-files/index.js +0 -36
  63. package/lib/postcss-p/postcss-p.mjs +0 -14
  64. package/lib/replace-global-core/index.js +0 -25
@@ -20,7 +20,15 @@ const generate = async () => {
20
20
  SuccessScreen: "SuccessScreen",
21
21
  NoMail: "NoMail",
22
22
  NoSavedItems: "NoSavedItems",
23
- NoTasks: "NoTasks"
23
+ NoTasks: "NoTasks",
24
+ NoDimensionsSet: "NoDimensionsSet",
25
+ AddPeople: "AddPeople",
26
+ AddColumn: "AddColumn",
27
+ SortColumn: "SortColumn",
28
+ FilterTable: "FilterTable",
29
+ ResizeColumn: "ResizeColumn",
30
+ GroupTable: "GroupTable",
31
+ UploadCollection: "UploadCollection"
24
32
  };
25
33
 
26
34
  const FALLBACK_TEXTS = {
@@ -47,6 +55,16 @@ const generate = async () => {
47
55
  SimpleNotFoundMagnifier: ORIGINAL_TEXTS.NoSearchResults,
48
56
  SimpleReload: ORIGINAL_TEXTS.UnableToLoad,
49
57
  SimpleTask: ORIGINAL_TEXTS.NoTasks,
58
+ NoChartData: ORIGINAL_TEXTS.NoDimensionsSet,
59
+ AddingColumns: ORIGINAL_TEXTS.AddColumn,
60
+ SortingColumns: ORIGINAL_TEXTS.SortColumn,
61
+ FilteringColumns: ORIGINAL_TEXTS.FilterTable,
62
+ ResizingColumns: ORIGINAL_TEXTS.ResizeColumn,
63
+ GroupingColumns: ORIGINAL_TEXTS.GroupTable,
64
+ AddPeopleToCalendar: ORIGINAL_TEXTS.AddPeople,
65
+ DragFilesToUpload: ORIGINAL_TEXTS.UploadCollection,
66
+ KeyTask: ORIGINAL_TEXTS.SuccessScreen,
67
+ ReceiveAppreciation: ORIGINAL_TEXTS.BalloonSky,
50
68
  SuccessBalloon: ORIGINAL_TEXTS.BalloonSky,
51
69
  SuccessCheckMark: ORIGINAL_TEXTS.SuccessScreen,
52
70
  SuccessHighFive: ORIGINAL_TEXTS.BalloonSky
@@ -57,18 +75,36 @@ const generate = async () => {
57
75
  const illustrationsPrefix = process.argv[4];
58
76
  const illustrationSet = process.argv[5];
59
77
  const destPath = process.argv[6];
78
+ const collection = process.argv[7];
60
79
  const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
61
- // collect each illustration name because each one should have Sample.js file
80
+ // collect each illustration name because each one should have Sample.js file
62
81
  const fileNames = new Set();
63
82
 
83
+ let dotIllustrationNames = [];
84
+
85
+ try {
86
+ await fs.access(srcPath);
87
+ } catch (error) {
88
+ console.log(`The path ${srcPath} does not exist.`);
89
+ return Promise.resolve(null);
90
+ }
91
+
92
+ console.log(`Generating illustrations from ${srcPath} to ${destPath}`)
93
+
64
94
  const svgImportTemplate = svgContent => {
65
95
  return `export default \`${svgContent}\`;`
66
96
  };
67
97
  const svgToJs = async fileName => {
68
- const svg = await fs.readFile(path.join(srcPath, fileName), {encoding: "utf-8"});
98
+ const svg = await fs.readFile(path.join(srcPath, fileName), { encoding: "utf-8" });
69
99
  const fileContent = svgImportTemplate(svg);
100
+ const fileNameSplitArr = fileName.split('-');
70
101
  fileName = fileName.replace(/\.svg$/, ".js");
71
102
 
103
+ if (fileNameSplitArr[1] === 'Dot') {
104
+ // we keep the Dot illustration names to import them later. If no Dot is present, Spot will be used
105
+ dotIllustrationNames.push(fileNameSplitArr[2].split('.')[0]);
106
+ }
107
+
72
108
  return fs.writeFile(path.join(destPath, fileName), fileContent);
73
109
  };
74
110
  const illustrationImportTemplate = illustrationName => {
@@ -83,55 +119,54 @@ const generate = async () => {
83
119
  }
84
120
 
85
121
  const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
122
+ // If no Dot is present, Spot will be imported as Dot
123
+ const hasDot = dotIllustrationNames.indexOf(illustrationName) !== -1 ? 'Dot' : 'Spot';
86
124
 
87
- return defaultText ? `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
125
+ return `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
88
126
  import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
89
127
  import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
90
128
  import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
91
- import {
129
+ import dotSvg from "./${illustrationsPrefix}-${hasDot}-${illustrationName}.js";${
130
+ defaultText ? `import {
92
131
  IM_TITLE_${illustrationNameUpperCase},
93
132
  IM_SUBTITLE_${illustrationNameUpperCase},
94
- } from "../generated/i18n/i18n-defaults.js";
133
+ } from "../generated/i18n/i18n-defaults.js";` : ``}
95
134
 
96
135
  const name = "${illustrationName}";
97
136
  const set = "${illustrationSet}";
137
+ const collection = "${collection}";${defaultText ? `
98
138
  const title = IM_TITLE_${illustrationNameUpperCase};
99
- const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};
139
+ const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};` : ``}
100
140
 
101
141
  registerIllustration(name, {
102
142
  dialogSvg,
103
143
  sceneSvg,
104
144
  spotSvg,
145
+ dotSvg,${defaultText ? `
105
146
  title,
106
- subtitle,
147
+ subtitle,` : ``}
107
148
  set,
149
+ collection,
108
150
  });
109
151
 
152
+ export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
110
153
  export {
111
154
  dialogSvg,
112
155
  sceneSvg,
113
156
  spotSvg,
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";
119
-
120
- const name = "${illustrationName}";
121
- const set = "${illustrationSet}";
157
+ dotSvg,
158
+ };`
159
+ };
122
160
 
123
- registerIllustration(name, {
124
- dialogSvg,
125
- sceneSvg,
126
- spotSvg,
127
- set,
128
- });
161
+ const illustrationTypeDefinition = illustrationName => {
162
+ return `declare const dialogSvg: string;
163
+ declare const sceneSvg: string;
164
+ declare const spotSvg: string;
165
+ declare const dotSvg: string;
166
+ declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
129
167
 
130
- export {
131
- dialogSvg,
132
- sceneSvg,
133
- spotSvg,
134
- };`
168
+ export default _default;
169
+ export { dialogSvg, sceneSvg, spotSvg, dotSvg };`
135
170
  };
136
171
 
137
172
  await fs.mkdir(destPath, { recursive: true });
@@ -149,11 +184,15 @@ export {
149
184
  }
150
185
  });
151
186
 
152
- for (let illustrationName of fileNames) {
153
- promises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
154
- }
187
+ return Promise.all(promises).then(() => {
188
+ const nestedPromises = [];
189
+ for (let illustrationName of fileNames) {
190
+ nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
191
+ nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.d.ts`), illustrationTypeDefinition(illustrationName)));
192
+ }
155
193
 
156
- return Promise.all(promises);
194
+ return Promise.all(nestedPromises);
195
+ });
157
196
  };
158
197
 
159
198
  generate().then(() => {
@@ -1,12 +1,12 @@
1
- const tsFileContentTemplate = (componentName, tagName, library, packageName) => {
1
+ const Component = (componentName, tagName, library, packageName) => {
2
2
  return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
3
3
  import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
4
4
  import property from "@ui5/webcomponents-base/dist/decorators/property.js";
5
5
  import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
6
- import event from "@ui5/webcomponents-base/dist/decorators/event.js";
7
- import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
6
+ import event from "@ui5/webcomponents-base/dist/decorators/event-strict.js";
7
+ import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
8
8
 
9
- import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
9
+ import ${componentName}Template from "./${componentName}Template.js";
10
10
 
11
11
  // Styles
12
12
  import ${componentName}Css from "./generated/themes/${componentName}.css.js";
@@ -22,57 +22,47 @@ import ${componentName}Css from "./generated/themes/${componentName}.css.js";
22
22
  * For the <code>${tagName}</code>
23
23
  * <h3>ES6 Module Import</h3>
24
24
  *
25
- * <code>import ${packageName}/dist/${componentName}.js";</code>
25
+ * <code>import "${packageName}/dist/${componentName}.js";</code>
26
26
  *
27
27
  * @constructor
28
- * @author SAP SE
29
- * @alias sap.ui.webc.${library}.${componentName}
30
- * @extends sap.ui.webc.base.UI5Element
31
- * @tagname ${tagName}
28
+ * @extends UI5Element
32
29
  * @public
33
30
  */
34
31
  @customElement({
35
32
  tag: "${tagName}",
36
- renderer: litRender,
33
+ renderer: jsxRenderer,
37
34
  styles: ${componentName}Css,
38
35
  template: ${componentName}Template,
39
- dependencies: [],
40
36
  })
41
37
 
42
38
  /**
43
39
  * Example custom event.
44
40
  * Please keep in mind that all public events should be documented in the API Reference as shown below.
45
41
  *
46
- * @event sap.ui.webc.${library}.${componentName}#interact
47
42
  * @public
48
43
  */
49
- @event("interact", { detail: { /* event payload ( optional ) */ } })
44
+ @event("interact")
50
45
  class ${componentName} extends UI5Element {
46
+ eventDetails!: {
47
+ "interact": void,
48
+ };
49
+
51
50
  /**
52
51
  * Defines the value of the component.
53
52
  *
54
- * @type {string}
55
- * @name sap.ui.webc.${library}.${componentName}.prototype.value
56
- * @defaultvalue ""
53
+ * @default ""
57
54
  * @public
58
55
  */
59
56
  @property()
60
- value!: string;
57
+ value?: string;
61
58
 
62
59
  /**
63
60
  * Defines the text of the component.
64
61
  *
65
- * @type {Node[]}
66
- * @name sap.ui.webc.${library}.${componentName}.prototype.default
67
- * @slot
68
62
  * @public
69
63
  */
70
64
  @slot({ type: Node, "default": true })
71
65
  text!: Array<Node>;
72
-
73
- static async onDefine() {
74
-
75
- }
76
66
  }
77
67
 
78
68
  ${componentName}.define();
@@ -81,4 +71,4 @@ export default ${componentName};
81
71
  `;
82
72
  };
83
73
 
84
- module.exports = tsFileContentTemplate;
74
+ module.exports = Component;
@@ -0,0 +1,12 @@
1
+ const ComponentTemplate = (componentName) => {
2
+ return `import type ${componentName} from "./${componentName}.js";
3
+
4
+ export default function ${componentName}Template(this: ${componentName}) {
5
+ return (
6
+ <div>Hello World!</div>
7
+ );
8
+ }
9
+ `;
10
+ };
11
+
12
+ module.exports = ComponentTemplate;
@@ -1,7 +1,29 @@
1
1
  const fs = require("fs");
2
2
  const prompts = require("prompts");
3
- const jsFileContentTemplate = require("./jsFileContentTemplate.js");
4
- const tsFileContentTemplate = require("./tsFileContentTemplate.js");
3
+ const Component = require("./Component.js");
4
+ const ComponentTemplate= require("./ComponentTemplate.js");
5
+
6
+ /**
7
+ * Hyphanates the given PascalCase string and adds prefix, f.e.:
8
+ * Foo -> "my-foo"
9
+ * FooBar -> "my-foo-bar"
10
+ */
11
+ const hyphaneteComponentName = (componentName) => {
12
+ const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
13
+
14
+ return `my-${result}`;
15
+ };
16
+
17
+ /**
18
+ * Capitalizes first letter of string.
19
+ */
20
+ const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
21
+
22
+ /**
23
+ * Validates component name, enforcing PascalCase pattern - Button, MyButton.
24
+ */
25
+ const PascalCasePattern = /^[A-Z][A-Za-z0-9]+$/;
26
+ const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
5
27
 
6
28
  const getPackageName = () => {
7
29
  if (!fs.existsSync("./package.json")) {
@@ -35,30 +57,17 @@ const getLibraryName = packageName => {
35
57
  return packageName.substr("webcomponents-".length);
36
58
  };
37
59
 
38
- // String manipulation
39
- const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
40
-
41
- // Validation of user input
42
- const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z][a-zA-Z0-9_-]*$/);
43
- const isTagNameValid = tagName => tagName.match(/^([a-z][a-z0-9]*-)([a-z0-9]+(-[a-z0-9]+)*)$/);
44
-
45
- const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
60
+ const generateFiles = (componentName, tagName, library, packageName) => {
46
61
  componentName = capitalizeFirstLetter(componentName);
47
62
  const filePaths = {
48
- "main": isTypeScript
49
- ? `./src/${componentName}.ts`
50
- : `./src/${componentName}.js`,
63
+ "main": `./src/${componentName}.ts`,
51
64
  "css": `./src/themes/${componentName}.css`,
52
- "template": `./src/${componentName}.hbs`,
65
+ "template": `./src/${componentName}Template.tsx`,
53
66
  };
54
67
 
55
- const FileContentTemplate = isTypeScript
56
- ? tsFileContentTemplate(componentName, tagName, library, packageName)
57
- : jsFileContentTemplate(componentName, tagName, library, packageName);
58
-
59
- fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
68
+ fs.writeFileSync(filePaths.main, Component(componentName, tagName, library, packageName), { flag: "wx+" });
60
69
  fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
61
- fs.writeFileSync(filePaths.template, "<div>Hello World</div>", { flag: "wx+" });
70
+ fs.writeFileSync(filePaths.template, ComponentTemplate(componentName), { flag: "wx+" });
62
71
 
63
72
  console.log(`Successfully generated ${filePaths.main}`);
64
73
  console.log(`Successfully generated ${filePaths.css}`);
@@ -66,8 +75,8 @@ const generateFiles = (componentName, tagName, library, packageName, isTypeScrip
66
75
 
67
76
  // Change the color of the output
68
77
  console.warn('\x1b[33m%s\x1b[0m', `
69
- Make sure to import the component in your bundle by using:
70
- import ${componentName} from "./dist/${componentName}.js";`);
78
+ Now, import the component in "src/bundle.esm.ts" via: import "./${componentName}.js";
79
+ And, add it to your HTML: <${tagName}></${tagName}>.`);
71
80
  }
72
81
 
73
82
  // Main function
@@ -77,21 +86,9 @@ const createWebComponent = async () => {
77
86
 
78
87
  const consoleArguments = process.argv.slice(2);
79
88
  let componentName = consoleArguments[0];
80
- let tagName = consoleArguments[1];
81
- let language = consoleArguments[2];
82
- let isTypeScript;
83
-
84
89
 
85
90
  if (componentName && !isNameValid(componentName)) {
86
- throw new Error("Invalid component name. Please use only letters, numbers, dashes and underscores. The first character must be a letter.");
87
- }
88
-
89
- if (tagName && !isTagNameValid(tagName)) {
90
- throw new Error("Invalid tag name. The tag name should only contain lowercase letters, numbers, dashes, and underscores. The first character must be a letter, and it should follow the pattern 'tag-name'.");
91
- }
92
-
93
- if (language && language !== "typescript" && language !== "ts" && language !== "javascript" && language !== "js") {
94
- throw new Error("Invalid language. Please use 'typescript','javascript' or their respective 'ts','js'.");
91
+ throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
95
92
  }
96
93
 
97
94
  if (!componentName) {
@@ -99,7 +96,7 @@ const createWebComponent = async () => {
99
96
  type: "text",
100
97
  name: "componentName",
101
98
  message: "Please enter a component name:",
102
- validate: (value) => isNameValid(value),
99
+ validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
103
100
  });
104
101
  componentName = response.componentName;
105
102
 
@@ -108,44 +105,9 @@ const createWebComponent = async () => {
108
105
  }
109
106
  }
110
107
 
111
- if (!tagName) {
112
- const response = await prompts({
113
- type: "text",
114
- name: "tagName",
115
- message: "Please enter a tag name:",
116
- validate: (value) => isTagNameValid(value),
117
- });
118
- tagName = response.tagName;
119
-
120
- if (!tagName) {
121
- process.exit();
122
- }
123
- }
124
-
125
- if (!language) {
126
- const response = await prompts({
127
- type: "select",
128
- name: "isTypeScript",
129
- message: "Please select a language:",
130
- choices: [
131
- {
132
- title: "TypeScript (recommended)",
133
- value: true,
134
- },
135
- {
136
- title: "JavaScript",
137
- value: false,
138
- },
139
- ],
140
- });
141
- isTypeScript = response.isTypeScript;
142
- } else if (language === "typescript" || language === "ts") {
143
- isTypeScript = true;
144
- } else {
145
- isTypeScript = false;
146
- }
108
+ const tagName = hyphaneteComponentName(componentName);
147
109
 
148
- generateFiles(componentName, tagName, library, packageName, isTypeScript);
110
+ generateFiles(componentName, tagName, library, packageName);
149
111
  };
150
112
 
151
113
  createWebComponent();
@@ -0,0 +1,78 @@
1
+ import { globby } from "globby";
2
+ import * as esbuild from 'esbuild'
3
+ import * as fs from "fs";
4
+ import * as path from "path";
5
+ import { writeFile, mkdir } from "fs/promises";
6
+ import chokidar from "chokidar";
7
+ import scopeVariables from "./scope-variables.mjs";
8
+ import { writeFileIfChanged, getFileContent } from "./shared.mjs";
9
+
10
+ const tsMode = process.env.UI5_TS === "true";
11
+ const extension = tsMode ? ".css.ts" : ".css.js";
12
+
13
+ const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
14
+ const inputFilesGlob = "src/themes/*.css";
15
+ const restArgs = process.argv.slice(2);
16
+
17
+ let customPlugin = {
18
+ name: 'ui5-tools',
19
+ setup(build) {
20
+ build.initialOptions.write = false;
21
+
22
+ build.onEnd(result => {
23
+ result.outputFiles.forEach(async f => {
24
+ // scoping
25
+ let newText = scopeVariables(f.text, packageJSON);
26
+ newText = newText.replaceAll(/\\/g, "\\\\"); // Escape backslashes as they might appear in css rules
27
+ await mkdir(path.dirname(f.path), {recursive: true});
28
+ writeFile(f.path, newText);
29
+
30
+ // JS/TS
31
+ const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
32
+ const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`", true);
33
+ writeFileIfChanged(jsPath, jsContent);
34
+ });
35
+ })
36
+ },
37
+ }
38
+
39
+ const getConfig = async () => {
40
+ const config = {
41
+ entryPoints: await globby(inputFilesGlob),
42
+ bundle: true,
43
+ minify: true,
44
+ outdir: 'dist/css',
45
+ outbase: 'src',
46
+ plugins: [
47
+ customPlugin,
48
+ ]
49
+ };
50
+ return config;
51
+ }
52
+
53
+ if (restArgs.includes("-w")) {
54
+ let ready;
55
+ let config = await getConfig();
56
+ let ctx = await esbuild.context(config);
57
+ await ctx.watch()
58
+ console.log('watching...')
59
+
60
+ // when new component css files are added, they do not trigger a build as no one directly imports them
61
+ // restart the watch mode with the new entry points if a css file is added.
62
+ const watcher = chokidar.watch(inputFilesGlob);
63
+ watcher.on("ready", () => {
64
+ ready = true; // Initial scan is over -> waiting for new files
65
+ });
66
+ watcher.on("add", async path => {
67
+ if (ready) {
68
+ // new file
69
+ ctx.dispose();
70
+ config = await getConfig();
71
+ ctx = await esbuild.context(config);
72
+ ctx.watch();
73
+ }
74
+ });
75
+ } else {
76
+ const config = await getConfig();
77
+ const result = await esbuild.build(config);
78
+ }
@@ -0,0 +1,74 @@
1
+ import { globby } from "globby";
2
+ import * as esbuild from 'esbuild'
3
+ import * as fs from "fs";
4
+ import * as path from "path";
5
+ import { writeFile, mkdir } from "fs/promises";
6
+ import postcss from "postcss";
7
+ import combineDuplicatedSelectors from "../postcss-combine-duplicated-selectors/index.js"
8
+ import { writeFileIfChanged, stripThemingBaseContent, getFileContent } from "./shared.mjs";
9
+ import scopeVariables from "./scope-variables.mjs";
10
+
11
+ const tsMode = process.env.UI5_TS === "true";
12
+ const extension = tsMode ? ".css.ts" : ".css.js";
13
+
14
+ const packageJSON = JSON.parse(fs.readFileSync("./package.json"))
15
+
16
+ let inputFiles = await globby("src/**/parameters-bundle.css");
17
+ const restArgs = process.argv.slice(2);
18
+
19
+ const removeDuplicateSelectors = async (text) => {
20
+ const result = await postcss(combineDuplicatedSelectors).process(text);
21
+ return result.css;
22
+ }
23
+
24
+ let scopingPlugin = {
25
+ name: 'scoping',
26
+ setup(build) {
27
+ build.initialOptions.write = false;
28
+
29
+ build.onEnd(result => {
30
+ result.outputFiles.forEach(async f => {
31
+ // remove duplicate selectors
32
+ let newText = await removeDuplicateSelectors(f.text);
33
+
34
+ // strip unnecessary theming-base-content
35
+ newText = stripThemingBaseContent(newText);
36
+
37
+ // scoping
38
+ newText = scopeVariables(newText, packageJSON, f.path);
39
+ await mkdir(path.dirname(f.path), {recursive: true});
40
+ writeFile(f.path, newText);
41
+
42
+ // JSON
43
+ const jsonPath = f.path.replace(/dist[\/\\]css/, "dist/generated/assets").replace(".css", ".css.json");
44
+ await mkdir(path.dirname(jsonPath), {recursive: true});
45
+ writeFileIfChanged(jsonPath, JSON.stringify(newText));
46
+
47
+ // JS/TS
48
+ const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
49
+ const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`");
50
+ writeFileIfChanged(jsPath, jsContent);
51
+ });
52
+ })
53
+ },
54
+ }
55
+
56
+ const config = {
57
+ entryPoints: inputFiles,
58
+ bundle: true,
59
+ minify: true,
60
+ outdir: 'dist/css',
61
+ outbase: 'src',
62
+ plugins: [
63
+ scopingPlugin,
64
+ ],
65
+ external: ["*.ttf", "*.woff", "*.woff2"],
66
+ };
67
+
68
+ if (restArgs.includes("-w")) {
69
+ let ctx = await esbuild.context(config);
70
+ await ctx.watch()
71
+ console.log('watching...')
72
+ } else {
73
+ const result = await esbuild.build(config);
74
+ }
@@ -0,0 +1,49 @@
1
+ import * as path from "path";
2
+ import { createRequire } from 'node:module';
3
+
4
+ const require = createRequire(import.meta.url);
5
+
6
+ /**
7
+ * Tries to detect an override for a package
8
+ * @param {*} filePath For example: /my_project/src/themes/overrides/@ui5/webcomponents/my_custom_theme/parameters-bundle.css
9
+ * @returns
10
+ */
11
+ const getOverrideVersion = filePath => {
12
+ if (!filePath) {
13
+ return;
14
+ }
15
+
16
+ if (!filePath.includes(`overrides${path.sep}`)) {
17
+ return; // The "overrides/" directory is the marker
18
+ }
19
+ const override = filePath.split(`overrides${path.sep}`)[1]; // For example, this will be: @ui5/webcomponents/my_custom_theme/parameters-bundle.css
20
+ if (!override) {
21
+ return; // There must be other directories after overrides/, the path can't end with it
22
+ }
23
+ const parts = override.split(path.sep);
24
+ if (parts.length < 3) {
25
+ return; // There must be at least a directory for the theme that is being overridden (my_custom_theme) and the name of the CSS file after the name of the package that is overridden
26
+ }
27
+ const packageName = parts.slice(0, -2).join(path.sep); // After the last 2 parts are removed (my_custom_theme and parameters-bundle.css from the example), the rest is the package
28
+
29
+ let overrideVersion;
30
+ try {
31
+ overrideVersion = require(`${packageName}${path.sep}package.json`).version;
32
+ } catch (e) {
33
+ console.log(`Error requiring package ${packageName}: ${e.message}`);
34
+ }
35
+
36
+ return overrideVersion;
37
+ }
38
+
39
+ const scopeVariables = (cssText, packageJSON, inputFile) => {
40
+ const escapeVersion = version => "v" + version?.replaceAll(/[^0-9A-Za-z\-_]/g, "-");
41
+ const versionStr = escapeVersion(getOverrideVersion(inputFile) || packageJSON.version);
42
+
43
+ const expr = /(--_?ui5)([^\,\:\)\s]+)/g;
44
+
45
+ return cssText.replaceAll(expr, `$1-${versionStr}$2`);
46
+ }
47
+
48
+ export default scopeVariables;
49
+