@ui5/webcomponents-tools 0.0.0-1b5f0ec39 → 0.0.0-1c3388f4d
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 +1676 -0
- package/README.md +3 -5
- package/assets-meta.js +12 -11
- package/components-package/eslint.js +59 -29
- package/components-package/nps.js +77 -48
- package/components-package/postcss.components.js +1 -21
- package/components-package/postcss.themes.js +1 -26
- package/components-package/vite.config.js +7 -11
- package/components-package/wdio.js +415 -393
- package/icons-collection/nps.js +9 -7
- package/lib/amd-to-es6/index.js +102 -0
- package/lib/amd-to-es6/no-remaining-require.js +33 -0
- package/lib/cem/custom-elements-manifest.config.mjs +530 -0
- package/lib/cem/event.mjs +168 -0
- package/lib/cem/schema-internal.json +1422 -0
- package/lib/cem/schema.json +1098 -0
- package/lib/cem/types-internal.d.ts +808 -0
- package/lib/cem/types.d.ts +736 -0
- package/lib/cem/utils.mjs +423 -0
- package/lib/cem/validate.js +67 -0
- package/lib/create-icons/index.js +13 -10
- package/lib/create-illustrations/index.js +70 -31
- package/lib/create-new-component/{tsFileContentTemplate.js → Component.js} +15 -25
- package/lib/create-new-component/ComponentTemplate.js +12 -0
- package/lib/create-new-component/index.js +37 -49
- package/lib/css-processors/css-processor-components.mjs +78 -0
- package/lib/css-processors/css-processor-themes.mjs +88 -0
- package/lib/css-processors/scope-variables.mjs +49 -0
- package/lib/css-processors/shared.mjs +46 -0
- package/lib/dev-server/custom-hot-update-plugin.js +39 -0
- package/lib/dev-server/{dev-server.js → dev-server.mjs} +4 -4
- package/lib/dev-server/virtual-index-html-plugin.js +24 -20
- package/lib/generate-js-imports/illustrations.js +78 -64
- package/lib/generate-json-imports/i18n.js +51 -62
- package/lib/generate-json-imports/themes.js +23 -37
- package/lib/hbs2lit/src/compiler.js +9 -6
- package/lib/hbs2lit/src/litVisitor2.js +42 -17
- package/lib/hbs2lit/src/svgProcessor.js +12 -5
- package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +39 -6
- package/lib/hbs2ui5/index.js +23 -6
- package/lib/i18n/defaults.js +3 -2
- package/lib/postcss-combine-duplicated-selectors/index.js +12 -5
- package/lib/remove-dev-mode/remove-dev-mode.mjs +37 -0
- package/lib/scoping/get-all-tags.js +10 -3
- package/lib/scoping/lint-src.js +8 -7
- package/lib/scoping/scope-test-pages.js +2 -1
- package/package.json +17 -13
- package/tsconfig.json +18 -0
- package/components-package/wdio.sync.js +0 -360
- package/lib/create-new-component/jsFileContentTemplate.js +0 -77
- package/lib/esm-abs-to-rel/index.js +0 -58
- package/lib/generate-custom-elements-manifest/index.js +0 -327
- package/lib/jsdoc/config.json +0 -29
- package/lib/jsdoc/configTypescript.json +0 -29
- package/lib/jsdoc/plugin.js +0 -2468
- package/lib/jsdoc/preprocess.js +0 -146
- package/lib/jsdoc/template/publish.js +0 -4120
- package/lib/postcss-css-to-esm/index.js +0 -90
- package/lib/postcss-css-to-json/index.js +0 -47
- package/lib/postcss-new-files/index.js +0 -36
- package/lib/postcss-p/postcss-p.mjs +0 -14
- 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
|
|
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
|
-
|
|
116
|
-
|
|
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
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
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
|
-
|
|
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
|
-
|
|
153
|
-
|
|
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
|
-
|
|
194
|
+
return Promise.all(nestedPromises);
|
|
195
|
+
});
|
|
157
196
|
};
|
|
158
197
|
|
|
159
198
|
generate().then(() => {
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
const
|
|
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
|
|
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 "
|
|
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
|
-
* @
|
|
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:
|
|
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"
|
|
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
|
-
* @
|
|
55
|
-
* @name sap.ui.webc.${library}.${componentName}.prototype.value
|
|
56
|
-
* @defaultvalue ""
|
|
53
|
+
* @default ""
|
|
57
54
|
* @public
|
|
58
55
|
*/
|
|
59
56
|
@property()
|
|
60
|
-
value
|
|
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 =
|
|
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,9 +1,31 @@
|
|
|
1
|
-
console.log("Creating new web component...")
|
|
2
|
-
|
|
3
1
|
const fs = require("fs");
|
|
4
2
|
const prompts = require("prompts");
|
|
5
|
-
const
|
|
6
|
-
const
|
|
3
|
+
const Component = require("./Component.js");
|
|
4
|
+
const ComponentTemplate= require("./ComponentTemplate.js");
|
|
5
|
+
const dotenv = require('dotenv');
|
|
6
|
+
dotenv.config();
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Hyphanates the given PascalCase string and adds prefix, f.e.:
|
|
10
|
+
* Foo -> "my-foo"
|
|
11
|
+
* FooBar -> "my-foo-bar"
|
|
12
|
+
*/
|
|
13
|
+
const hyphaneteComponentName = (componentName) => {
|
|
14
|
+
const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
|
|
15
|
+
|
|
16
|
+
return `${process.env.UI5_TAG_NAME_PREFIX ?? "my"}-${result}`;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Capitalizes first letter of string.
|
|
21
|
+
*/
|
|
22
|
+
const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Validates component name, enforcing PascalCase pattern - Button, MyButton.
|
|
26
|
+
*/
|
|
27
|
+
const PascalCasePattern = /^[A-Z][A-Za-z0-9]+$/;
|
|
28
|
+
const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
|
|
7
29
|
|
|
8
30
|
const getPackageName = () => {
|
|
9
31
|
if (!fs.existsSync("./package.json")) {
|
|
@@ -37,30 +59,17 @@ const getLibraryName = packageName => {
|
|
|
37
59
|
return packageName.substr("webcomponents-".length);
|
|
38
60
|
};
|
|
39
61
|
|
|
40
|
-
|
|
41
|
-
const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
|
|
42
|
-
|
|
43
|
-
// Validation of user input
|
|
44
|
-
const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z][a-zA-Z0-9_-]*$/);
|
|
45
|
-
const isTagNameValid = tagName => tagName.match(/^([a-z][a-z0-9]*-)([a-z0-9]+(-[a-z0-9]+)*)$/);
|
|
46
|
-
|
|
47
|
-
const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
|
|
62
|
+
const generateFiles = (componentName, tagName, library, packageName) => {
|
|
48
63
|
componentName = capitalizeFirstLetter(componentName);
|
|
49
64
|
const filePaths = {
|
|
50
|
-
"main":
|
|
51
|
-
? `./src/${componentName}.ts`
|
|
52
|
-
: `./src/${componentName}.js`,
|
|
65
|
+
"main": `./src/${componentName}.ts`,
|
|
53
66
|
"css": `./src/themes/${componentName}.css`,
|
|
54
|
-
"template": `./src/${componentName}.
|
|
67
|
+
"template": `./src/${componentName}${process.env.UI5_TEMPLATE_FILENAME_SUFFIX ?? "Template"}.tsx`,
|
|
55
68
|
};
|
|
56
69
|
|
|
57
|
-
|
|
58
|
-
? tsFileContentTemplate(componentName, tagName, library, packageName)
|
|
59
|
-
: jsFileContentTemplate(componentName, tagName, library, packageName);
|
|
60
|
-
|
|
61
|
-
fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
|
|
70
|
+
fs.writeFileSync(filePaths.main, Component(componentName, tagName, library, packageName), { flag: "wx+" });
|
|
62
71
|
fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
|
|
63
|
-
fs.writeFileSync(filePaths.template,
|
|
72
|
+
fs.writeFileSync(filePaths.template, ComponentTemplate(componentName), { flag: "wx+" });
|
|
64
73
|
|
|
65
74
|
console.log(`Successfully generated ${filePaths.main}`);
|
|
66
75
|
console.log(`Successfully generated ${filePaths.css}`);
|
|
@@ -68,8 +77,8 @@ const generateFiles = (componentName, tagName, library, packageName, isTypeScrip
|
|
|
68
77
|
|
|
69
78
|
// Change the color of the output
|
|
70
79
|
console.warn('\x1b[33m%s\x1b[0m', `
|
|
71
|
-
|
|
72
|
-
|
|
80
|
+
Now, import the component in "src/bundle.esm.ts" via: import "./${componentName}.js";
|
|
81
|
+
And, add it to your HTML: <${tagName}></${tagName}>.`);
|
|
73
82
|
}
|
|
74
83
|
|
|
75
84
|
// Main function
|
|
@@ -79,14 +88,9 @@ const createWebComponent = async () => {
|
|
|
79
88
|
|
|
80
89
|
const consoleArguments = process.argv.slice(2);
|
|
81
90
|
let componentName = consoleArguments[0];
|
|
82
|
-
let tagName = consoleArguments[1];
|
|
83
91
|
|
|
84
92
|
if (componentName && !isNameValid(componentName)) {
|
|
85
|
-
throw new Error(
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
if (tagName && !isTagNameValid(tagName)) {
|
|
89
|
-
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'.");
|
|
93
|
+
throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
|
|
90
94
|
}
|
|
91
95
|
|
|
92
96
|
if (!componentName) {
|
|
@@ -94,7 +98,7 @@ const createWebComponent = async () => {
|
|
|
94
98
|
type: "text",
|
|
95
99
|
name: "componentName",
|
|
96
100
|
message: "Please enter a component name:",
|
|
97
|
-
validate: (value) => isNameValid(value),
|
|
101
|
+
validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
|
|
98
102
|
});
|
|
99
103
|
componentName = response.componentName;
|
|
100
104
|
|
|
@@ -103,25 +107,9 @@ const createWebComponent = async () => {
|
|
|
103
107
|
}
|
|
104
108
|
}
|
|
105
109
|
|
|
106
|
-
|
|
107
|
-
const response = await prompts({
|
|
108
|
-
type: "text",
|
|
109
|
-
name: "tagName",
|
|
110
|
-
message: "Please enter a tag name:",
|
|
111
|
-
validate: (value) => isTagNameValid(value),
|
|
112
|
-
});
|
|
113
|
-
tagName = response.tagName;
|
|
114
|
-
|
|
115
|
-
if (!tagName) {
|
|
116
|
-
process.exit();
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
const isTypeScript = fs.existsSync(path.join(process.cwd(), "tsconfig.json"));
|
|
121
|
-
console.log({ isTypeScript })
|
|
122
|
-
|
|
110
|
+
const tagName = hyphaneteComponentName(componentName);
|
|
123
111
|
|
|
124
|
-
generateFiles(componentName, tagName, library, packageName
|
|
112
|
+
generateFiles(componentName, tagName, library, packageName);
|
|
125
113
|
};
|
|
126
114
|
|
|
127
115
|
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,88 @@
|
|
|
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, 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
|
+
const inputFiles = await globby([
|
|
17
|
+
"src/**/parameters-bundle.css",
|
|
18
|
+
]);
|
|
19
|
+
const restArgs = process.argv.slice(2);
|
|
20
|
+
|
|
21
|
+
const processThemingPackageFile = async (f) => {
|
|
22
|
+
const selector = ':root';
|
|
23
|
+
const result = await postcss().process(f.text);
|
|
24
|
+
|
|
25
|
+
const newRule = postcss.rule({ selector });
|
|
26
|
+
|
|
27
|
+
result.root.walkRules(selector, rule => {
|
|
28
|
+
rule.walkDecls(decl => {
|
|
29
|
+
if (!decl.prop.startsWith('--sapFontUrl')) {
|
|
30
|
+
newRule.append(decl.clone());
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
return newRule.toString();
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
const processComponentPackageFile = async (f) => {
|
|
39
|
+
const result = await postcss(combineDuplicatedSelectors).process(f.text);
|
|
40
|
+
|
|
41
|
+
return scopeVariables(result.css, packageJSON, f.path);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
let scopingPlugin = {
|
|
45
|
+
name: 'scoping',
|
|
46
|
+
setup(build) {
|
|
47
|
+
build.initialOptions.write = false;
|
|
48
|
+
|
|
49
|
+
build.onEnd(result => {
|
|
50
|
+
result.outputFiles.forEach(async f => {
|
|
51
|
+
let newText = f.path.includes("packages/theming") ? await processThemingPackageFile(f) : await processComponentPackageFile(f);
|
|
52
|
+
|
|
53
|
+
await mkdir(path.dirname(f.path), { recursive: true });
|
|
54
|
+
writeFile(f.path, newText);
|
|
55
|
+
|
|
56
|
+
// JSON
|
|
57
|
+
const jsonPath = f.path.replace(/dist[\/\\]css/, "dist/generated/assets").replace(".css", ".css.json");
|
|
58
|
+
await mkdir(path.dirname(jsonPath), { recursive: true });
|
|
59
|
+
writeFileIfChanged(jsonPath, JSON.stringify(newText));
|
|
60
|
+
|
|
61
|
+
// JS/TS
|
|
62
|
+
const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
|
|
63
|
+
const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`");
|
|
64
|
+
writeFileIfChanged(jsPath, jsContent);
|
|
65
|
+
});
|
|
66
|
+
})
|
|
67
|
+
},
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const config = {
|
|
71
|
+
entryPoints: inputFiles,
|
|
72
|
+
bundle: true,
|
|
73
|
+
minify: true,
|
|
74
|
+
outdir: 'dist/css',
|
|
75
|
+
outbase: 'src',
|
|
76
|
+
plugins: [
|
|
77
|
+
scopingPlugin,
|
|
78
|
+
],
|
|
79
|
+
external: ["*.ttf", "*.woff", "*.woff2"],
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
if (restArgs.includes("-w")) {
|
|
83
|
+
let ctx = await esbuild.context(config);
|
|
84
|
+
await ctx.watch()
|
|
85
|
+
console.log('watching...')
|
|
86
|
+
} else {
|
|
87
|
+
const result = await esbuild.build(config);
|
|
88
|
+
}
|
|
@@ -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
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { writeFile, readFile, mkdir } from "fs/promises";
|
|
2
|
+
import * as path from "path";
|
|
3
|
+
import assets from "../../assets-meta.js";
|
|
4
|
+
|
|
5
|
+
const readOldContent = async (fileName) => {
|
|
6
|
+
// it seems slower to read the old content, but writing the same content with no real changes
|
|
7
|
+
// (as in initial build and then watch mode) will cause an unnecessary dev server refresh
|
|
8
|
+
let oldContent = "";
|
|
9
|
+
try {
|
|
10
|
+
oldContent = (await readFile(fileName)).toString();
|
|
11
|
+
} catch (e) {
|
|
12
|
+
// file not found
|
|
13
|
+
}
|
|
14
|
+
return oldContent;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const writeFileIfChanged = async (fileName, content) => {
|
|
18
|
+
const oldContent = await readOldContent(fileName);
|
|
19
|
+
if (content !== oldContent) {
|
|
20
|
+
if (!oldContent) {
|
|
21
|
+
await mkdir(path.dirname(fileName), {recursive: true});
|
|
22
|
+
}
|
|
23
|
+
return writeFile(fileName, content);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const DEFAULT_THEME = assets.themes.default;
|
|
28
|
+
|
|
29
|
+
const getDefaultThemeCode = packageName => {
|
|
30
|
+
return `import { registerThemePropertiesLoader } from "@ui5/webcomponents-base/dist/asset-registries/Themes.js";
|
|
31
|
+
|
|
32
|
+
import defaultThemeBase from "@ui5/webcomponents-theming/dist/generated/themes/${DEFAULT_THEME}/parameters-bundle.css.js";
|
|
33
|
+
import defaultTheme from "./${DEFAULT_THEME}/parameters-bundle.css.js";
|
|
34
|
+
|
|
35
|
+
registerThemePropertiesLoader("@" + "ui5" + "/" + "webcomponents-theming", "${DEFAULT_THEME}", async () => defaultThemeBase);
|
|
36
|
+
registerThemePropertiesLoader(${ packageName.split("").map(c => `"${c}"`).join (" + ") }, "${DEFAULT_THEME}", async () => defaultTheme);
|
|
37
|
+
`;
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
const getFileContent = (packageName, css, includeDefaultTheme) => {
|
|
41
|
+
const defaultTheme = includeDefaultTheme ? getDefaultThemeCode(packageName) : "";
|
|
42
|
+
return `${defaultTheme}export default ${css.trim()}`
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
export { writeFileIfChanged, getFileContent}
|