@ui5/webcomponents-tools 0.0.0-d0bcf47c7 → 0.0.0-d160e83dd
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 +1915 -1
- package/README.md +6 -9
- package/assets-meta.js +154 -0
- package/bin/dev.js +12 -1
- package/components-package/eslint.js +66 -2
- package/components-package/nps.js +142 -45
- package/components-package/postcss.components.js +1 -21
- package/components-package/postcss.themes.js +1 -23
- package/components-package/vite.config.js +9 -0
- package/components-package/wdio.js +153 -65
- package/icons-collection/nps.js +71 -28
- 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 +547 -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/copy-and-watch/index.js +145 -0
- package/lib/copy-list/index.js +28 -0
- package/lib/create-icons/index.js +127 -0
- package/lib/create-illustrations/index.js +182 -0
- package/lib/create-new-component/Component.js +74 -0
- package/lib/create-new-component/ComponentTemplate.js +12 -0
- package/lib/create-new-component/index.js +113 -0
- package/lib/css-processors/css-processor-components.mjs +77 -0
- package/lib/css-processors/css-processor-themes.mjs +74 -0
- package/lib/css-processors/scope-variables.mjs +49 -0
- package/lib/css-processors/shared.mjs +56 -0
- package/lib/dev-server/custom-hot-update-plugin.js +39 -0
- package/lib/dev-server/dev-server.mjs +66 -0
- package/lib/dev-server/virtual-index-html-plugin.js +56 -0
- package/lib/generate-js-imports/illustrations.js +86 -0
- package/lib/generate-json-imports/i18n.js +82 -0
- package/lib/generate-json-imports/themes.js +63 -0
- package/lib/hbs2lit/index.js +3 -0
- package/lib/hbs2lit/src/compiler.js +60 -0
- package/lib/hbs2lit/src/extendedAttributeMapping.js +12 -0
- package/lib/hbs2lit/src/includesReplacer.js +31 -0
- package/lib/hbs2lit/src/litVisitor2.js +278 -0
- package/lib/hbs2lit/src/partials2.js +51 -0
- package/lib/hbs2lit/src/partialsVisitor.js +187 -0
- package/lib/hbs2lit/src/svgProcessor.js +76 -0
- package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +45 -0
- package/lib/hbs2ui5/index.js +119 -0
- package/lib/i18n/defaults.js +83 -0
- package/lib/i18n/toJSON.js +43 -0
- package/lib/postcss-combine-duplicated-selectors/index.js +185 -0
- package/lib/remove-dev-mode/remove-dev-mode.mjs +37 -0
- package/lib/scoping/get-all-tags.js +44 -0
- package/lib/scoping/lint-src.js +32 -0
- package/lib/scoping/missing-dependencies.js +65 -0
- package/lib/scoping/report-tags-usage.js +28 -0
- package/lib/scoping/scope-test-pages.js +41 -0
- package/lib/test-runner/test-runner.js +71 -0
- package/package.json +58 -55
- package/tsconfig.json +18 -0
- package/bin/init-ui5-package.js +0 -3
- package/package-lock.json +0 -9994
@@ -0,0 +1,127 @@
|
|
1
|
+
const fs = require("fs").promises;
|
2
|
+
const path = require("path");
|
3
|
+
|
4
|
+
const collectionName = process.argv[2] || "SAP-icons-v4";
|
5
|
+
const collectionVersion = process.argv[3];
|
6
|
+
const srcFile = collectionVersion ? path.normalize(`src/${collectionVersion}/${collectionName}.json`) : path.normalize(`src/${collectionName}.json`);
|
7
|
+
const destDir = collectionVersion ? path.normalize(`dist/${collectionVersion}/`) : path.normalize("dist/");
|
8
|
+
|
9
|
+
const iconTemplate = (name, pathData, ltr, collection, packageName) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
|
10
|
+
|
11
|
+
const name = "${name}";
|
12
|
+
const pathData = "${pathData}";
|
13
|
+
const ltr = ${ltr};
|
14
|
+
const accData = null;
|
15
|
+
const collection = "${collection}";
|
16
|
+
const packageName = "${packageName}";
|
17
|
+
|
18
|
+
registerIcon(name, { pathData, ltr, collection, packageName });
|
19
|
+
|
20
|
+
export default "${collection}/${name}";
|
21
|
+
export { pathData, ltr, accData };`;
|
22
|
+
|
23
|
+
|
24
|
+
const iconAccTemplate = (name, pathData, ltr, accData, collection, packageName, versioned) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
|
25
|
+
import { ${accData.key} } from "${versioned ? "../" : "./"}generated/i18n/i18n-defaults.js";
|
26
|
+
|
27
|
+
const name = "${name}";
|
28
|
+
const pathData = "${pathData}";
|
29
|
+
const ltr = ${ltr};
|
30
|
+
const accData = ${accData.key};
|
31
|
+
const collection = "${collection}";
|
32
|
+
const packageName = "${packageName}";
|
33
|
+
|
34
|
+
registerIcon(name, { pathData, ltr, accData, collection, packageName });
|
35
|
+
|
36
|
+
export default "${collection}/${name}";
|
37
|
+
export { pathData, ltr, accData };`;
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
const collectionTemplate = (name, versions, fullName) => `import { isLegacyThemeFamilyAsync } from "@ui5/webcomponents-base/dist/config/Theme.js";
|
42
|
+
import { pathData as pathData${versions[0]}, ltr, accData } from "./${versions[0]}/${name}.js";
|
43
|
+
import { pathData as pathData${versions[1]} } from "./${versions[1]}/${name}.js";
|
44
|
+
|
45
|
+
const getPathData = async() => {
|
46
|
+
return await isLegacyThemeFamilyAsync() ? pathDatav4 : pathDatav5;
|
47
|
+
};
|
48
|
+
|
49
|
+
export default "${fullName}";
|
50
|
+
export { getPathData, ltr, accData };`;
|
51
|
+
|
52
|
+
|
53
|
+
const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
|
54
|
+
declare const ltr: boolean;
|
55
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
56
|
+
declare const _default: "${collection}/${name}";
|
57
|
+
|
58
|
+
export default _default;
|
59
|
+
export { pathData, ltr, accData };`
|
60
|
+
|
61
|
+
const collectionTypeDefinitionTemplate = (name, accData) => `declare const getPathData: () => Promise<string>;
|
62
|
+
declare const ltr: boolean;
|
63
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
64
|
+
declare const _default: "${name}";
|
65
|
+
|
66
|
+
export default _default;
|
67
|
+
export { getPathData, ltr, accData };`
|
68
|
+
|
69
|
+
|
70
|
+
const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
|
71
|
+
<path d="${pathData}"/>
|
72
|
+
</svg>`;
|
73
|
+
|
74
|
+
const createIcons = async (file) => {
|
75
|
+
await fs.mkdir(destDir, { recursive: true });
|
76
|
+
|
77
|
+
const json = JSON.parse(await fs.readFile(file));
|
78
|
+
|
79
|
+
const promises = [];
|
80
|
+
for (let name in json.data) {
|
81
|
+
const iconData = json.data[name];
|
82
|
+
const pathData = iconData.path;
|
83
|
+
const ltr = !!iconData.ltr;
|
84
|
+
const acc = iconData.acc;
|
85
|
+
const packageName = json.packageName;
|
86
|
+
const collection = json.collection;
|
87
|
+
const versioned = json.version;
|
88
|
+
|
89
|
+
const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName, versioned) : iconTemplate(name, pathData, ltr, collection, packageName);
|
90
|
+
|
91
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
|
92
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
|
93
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
|
94
|
+
|
95
|
+
// For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
|
96
|
+
// For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
|
97
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
|
98
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
|
99
|
+
|
100
|
+
if (versioned) {
|
101
|
+
// The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
|
102
|
+
// to add or not the collection name to the exported value:
|
103
|
+
// For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
|
104
|
+
// For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
|
105
|
+
const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
|
106
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
|
107
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
|
108
|
+
}
|
109
|
+
}
|
110
|
+
|
111
|
+
return Promise.all(promises);
|
112
|
+
};
|
113
|
+
|
114
|
+
const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
|
115
|
+
const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
|
116
|
+
const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
|
117
|
+
|
118
|
+
const CollectionVersionedToUnversionedMap = {
|
119
|
+
"tnt-v2": "tnt",
|
120
|
+
"tnt-v3": "tnt",
|
121
|
+
"business-suite-v1": "business-suite",
|
122
|
+
"business-suite-v2": "business-suite",
|
123
|
+
};
|
124
|
+
|
125
|
+
createIcons(srcFile).then(() => {
|
126
|
+
console.log("Icons created.");
|
127
|
+
});
|
@@ -0,0 +1,182 @@
|
|
1
|
+
const fs = require("fs").promises;
|
2
|
+
const path = require("path");
|
3
|
+
|
4
|
+
if (process.argv.length < 7) {
|
5
|
+
throw new Error("Not enough arguments");
|
6
|
+
}
|
7
|
+
|
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 collection = process.argv[7];
|
61
|
+
const fileNamePattern = new RegExp(`${illustrationsPrefix}-.+-(.+).svg`);
|
62
|
+
// collect each illustration name because each one should have Sample.js file
|
63
|
+
const fileNames = new Set();
|
64
|
+
|
65
|
+
let dotIllustrationNames = [];
|
66
|
+
|
67
|
+
try {
|
68
|
+
await fs.access(srcPath);
|
69
|
+
} catch (error) {
|
70
|
+
console.log(`The path ${srcPath} does not exist.`);
|
71
|
+
return Promise.resolve(null);
|
72
|
+
}
|
73
|
+
|
74
|
+
console.log(`Generating illustrations from ${srcPath} to ${destPath}`)
|
75
|
+
|
76
|
+
const svgImportTemplate = svgContent => {
|
77
|
+
return `export default \`${svgContent}\`;`
|
78
|
+
};
|
79
|
+
const svgToJs = async fileName => {
|
80
|
+
const svg = await fs.readFile(path.join(srcPath, fileName), { encoding: "utf-8" });
|
81
|
+
const fileContent = svgImportTemplate(svg);
|
82
|
+
const fileNameSplitArr = fileName.split('-');
|
83
|
+
fileName = fileName.replace(/\.svg$/, ".js");
|
84
|
+
|
85
|
+
if (fileNameSplitArr[1] === 'Dot') {
|
86
|
+
// we keep the Dot illustration names to import them later. If no Dot is present, Spot will be used
|
87
|
+
dotIllustrationNames.push(fileNameSplitArr[2].split('.')[0]);
|
88
|
+
}
|
89
|
+
|
90
|
+
return fs.writeFile(path.join(destPath, fileName), fileContent);
|
91
|
+
};
|
92
|
+
const illustrationImportTemplate = illustrationName => {
|
93
|
+
let illustrationNameForTranslation = illustrationName;
|
94
|
+
|
95
|
+
if (defaultText) {
|
96
|
+
if (FALLBACK_TEXTS[illustrationNameForTranslation]) {
|
97
|
+
illustrationNameForTranslation = FALLBACK_TEXTS[illustrationNameForTranslation];
|
98
|
+
} else if (illustrationName.indexOf("_v") !== -1) {
|
99
|
+
illustrationNameForTranslation = illustrationNameForTranslation.substr(0, illustrationNameForTranslation.indexOf('_v'));
|
100
|
+
}
|
101
|
+
}
|
102
|
+
|
103
|
+
const illustrationNameUpperCase = illustrationNameForTranslation.toUpperCase();
|
104
|
+
// If no Dot is present, Spot will be imported as Dot
|
105
|
+
const hasDot = dotIllustrationNames.indexOf(illustrationName) !== -1 ? 'Dot' : 'Spot';
|
106
|
+
|
107
|
+
return `import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
|
108
|
+
import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
|
109
|
+
import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
|
110
|
+
import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
|
111
|
+
import dotSvg from "./${illustrationsPrefix}-${hasDot}-${illustrationName}.js";${
|
112
|
+
defaultText ? `import {
|
113
|
+
IM_TITLE_${illustrationNameUpperCase},
|
114
|
+
IM_SUBTITLE_${illustrationNameUpperCase},
|
115
|
+
} from "../generated/i18n/i18n-defaults.js";` : ``}
|
116
|
+
|
117
|
+
const name = "${illustrationName}";
|
118
|
+
const set = "${illustrationSet}";
|
119
|
+
const collection = "${collection}";${defaultText ? `
|
120
|
+
const title = IM_TITLE_${illustrationNameUpperCase};
|
121
|
+
const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};` : ``}
|
122
|
+
|
123
|
+
registerIllustration(name, {
|
124
|
+
dialogSvg,
|
125
|
+
sceneSvg,
|
126
|
+
spotSvg,
|
127
|
+
dotSvg,${defaultText ? `
|
128
|
+
title,
|
129
|
+
subtitle,` : ``}
|
130
|
+
set,
|
131
|
+
collection,
|
132
|
+
});
|
133
|
+
|
134
|
+
export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
|
135
|
+
export {
|
136
|
+
dialogSvg,
|
137
|
+
sceneSvg,
|
138
|
+
spotSvg,
|
139
|
+
dotSvg,
|
140
|
+
};`
|
141
|
+
};
|
142
|
+
|
143
|
+
const illustrationTypeDefinition = illustrationName => {
|
144
|
+
return `declare const dialogSvg: string;
|
145
|
+
declare const sceneSvg: string;
|
146
|
+
declare const spotSvg: string;
|
147
|
+
declare const dotSvg: string;
|
148
|
+
declare const _default: "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
|
149
|
+
|
150
|
+
export default _default;
|
151
|
+
export { dialogSvg, sceneSvg, spotSvg, dotSvg };`
|
152
|
+
};
|
153
|
+
|
154
|
+
await fs.mkdir(destPath, { recursive: true });
|
155
|
+
|
156
|
+
const illustrationFileNames = await fs.readdir(path.normalize(srcPath));
|
157
|
+
|
158
|
+
// convert SVG to JS imports
|
159
|
+
const promises = [];
|
160
|
+
illustrationFileNames.forEach(illustration => {
|
161
|
+
if (fileNamePattern.test(illustration)) {
|
162
|
+
let [fileName, illustrationName] = illustration.match(fileNamePattern);
|
163
|
+
|
164
|
+
promises.push(svgToJs(fileName));
|
165
|
+
fileNames.add(illustrationName);
|
166
|
+
}
|
167
|
+
});
|
168
|
+
|
169
|
+
return Promise.all(promises).then(() => {
|
170
|
+
const nestedPromises = [];
|
171
|
+
for (let illustrationName of fileNames) {
|
172
|
+
nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName)));
|
173
|
+
nestedPromises.push(fs.writeFile(path.join(destPath, `${illustrationName}.d.ts`), illustrationTypeDefinition(illustrationName)));
|
174
|
+
}
|
175
|
+
|
176
|
+
return Promise.all(nestedPromises);
|
177
|
+
});
|
178
|
+
};
|
179
|
+
|
180
|
+
generate().then(() => {
|
181
|
+
console.log("Illustrations generated.");
|
182
|
+
});
|
@@ -0,0 +1,74 @@
|
|
1
|
+
const Component = (componentName, tagName, library, packageName) => {
|
2
|
+
return `import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
|
3
|
+
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
|
4
|
+
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
|
5
|
+
import slot from "@ui5/webcomponents-base/dist/decorators/slot.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
|
+
|
9
|
+
import ${componentName}Template from "./${componentName}Template.js";
|
10
|
+
|
11
|
+
// Styles
|
12
|
+
import ${componentName}Css from "./generated/themes/${componentName}.css.js";
|
13
|
+
|
14
|
+
/**
|
15
|
+
* @class
|
16
|
+
*
|
17
|
+
* <h3 class="comment-api-title">Overview</h3>
|
18
|
+
*
|
19
|
+
*
|
20
|
+
* <h3>Usage</h3>
|
21
|
+
*
|
22
|
+
* For the <code>${tagName}</code>
|
23
|
+
* <h3>ES6 Module Import</h3>
|
24
|
+
*
|
25
|
+
* <code>import "${packageName}/dist/${componentName}.js";</code>
|
26
|
+
*
|
27
|
+
* @constructor
|
28
|
+
* @extends UI5Element
|
29
|
+
* @public
|
30
|
+
*/
|
31
|
+
@customElement({
|
32
|
+
tag: "${tagName}",
|
33
|
+
renderer: jsxRenderer,
|
34
|
+
styles: ${componentName}Css,
|
35
|
+
template: ${componentName}Template,
|
36
|
+
})
|
37
|
+
|
38
|
+
/**
|
39
|
+
* Example custom event.
|
40
|
+
* Please keep in mind that all public events should be documented in the API Reference as shown below.
|
41
|
+
*
|
42
|
+
* @public
|
43
|
+
*/
|
44
|
+
@event("interact")
|
45
|
+
class ${componentName} extends UI5Element {
|
46
|
+
eventDetails!: {
|
47
|
+
"interact": void,
|
48
|
+
};
|
49
|
+
|
50
|
+
/**
|
51
|
+
* Defines the value of the component.
|
52
|
+
*
|
53
|
+
* @default ""
|
54
|
+
* @public
|
55
|
+
*/
|
56
|
+
@property()
|
57
|
+
value?: string;
|
58
|
+
|
59
|
+
/**
|
60
|
+
* Defines the text of the component.
|
61
|
+
*
|
62
|
+
* @public
|
63
|
+
*/
|
64
|
+
@slot({ type: Node, "default": true })
|
65
|
+
text!: Array<Node>;
|
66
|
+
}
|
67
|
+
|
68
|
+
${componentName}.define();
|
69
|
+
|
70
|
+
export default ${componentName};
|
71
|
+
`;
|
72
|
+
};
|
73
|
+
|
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;
|
@@ -0,0 +1,113 @@
|
|
1
|
+
const fs = require("fs");
|
2
|
+
const prompts = require("prompts");
|
3
|
+
const Component = require("./Component.js");
|
4
|
+
const ComponentTemplate= require("./ComponentTemplate.js");
|
5
|
+
|
6
|
+
/**
|
7
|
+
* Hyphanates the given PascalCase string, f.e.:
|
8
|
+
* Foo -> "my-foo" (adds preffix)
|
9
|
+
* FooBar -> "foo-bar"
|
10
|
+
*/
|
11
|
+
const hyphaneteComponentName = (componentName) => {
|
12
|
+
const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
|
13
|
+
|
14
|
+
return result.includes("-") ? result : `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);
|
27
|
+
|
28
|
+
const getPackageName = () => {
|
29
|
+
if (!fs.existsSync("./package.json")) {
|
30
|
+
throw("The current directory doesn't contain package.json file.");
|
31
|
+
}
|
32
|
+
|
33
|
+
const packageJSON = JSON.parse(fs.readFileSync("./package.json"));
|
34
|
+
|
35
|
+
if (!packageJSON.name) {
|
36
|
+
throw("The package.json file in the current directory doesn't have a name property");
|
37
|
+
}
|
38
|
+
|
39
|
+
return packageJSON.name;
|
40
|
+
};
|
41
|
+
|
42
|
+
const getLibraryName = packageName => {
|
43
|
+
if (!packageName.includes("/")) {
|
44
|
+
return packageName;
|
45
|
+
}
|
46
|
+
|
47
|
+
if (packageName === "@ui5/webcomponents") {
|
48
|
+
return `main`;
|
49
|
+
}
|
50
|
+
|
51
|
+
packageName = packageName.split("/").pop();
|
52
|
+
|
53
|
+
if (!packageName.startsWith("webcomponents-")) {
|
54
|
+
return packageName;
|
55
|
+
}
|
56
|
+
|
57
|
+
return packageName.substr("webcomponents-".length);
|
58
|
+
};
|
59
|
+
|
60
|
+
const generateFiles = (componentName, tagName, library, packageName) => {
|
61
|
+
componentName = capitalizeFirstLetter(componentName);
|
62
|
+
const filePaths = {
|
63
|
+
"main": `./src/${componentName}.ts`,
|
64
|
+
"css": `./src/themes/${componentName}.css`,
|
65
|
+
"template": `./src/${componentName}Template.tsx`,
|
66
|
+
};
|
67
|
+
|
68
|
+
fs.writeFileSync(filePaths.main, Component(componentName, tagName, library, packageName), { flag: "wx+" });
|
69
|
+
fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
|
70
|
+
fs.writeFileSync(filePaths.template, ComponentTemplate(componentName), { flag: "wx+" });
|
71
|
+
|
72
|
+
console.log(`Successfully generated ${filePaths.main}`);
|
73
|
+
console.log(`Successfully generated ${filePaths.css}`);
|
74
|
+
console.log(`Successfully generated ${filePaths.template}`);
|
75
|
+
|
76
|
+
// Change the color of the output
|
77
|
+
console.warn('\x1b[33m%s\x1b[0m', `
|
78
|
+
Now, import the component via: "import ${componentName} from ./${componentName}.js";
|
79
|
+
And, add it to your HTML: <${tagName}></${tagName}>.`);
|
80
|
+
}
|
81
|
+
|
82
|
+
// Main function
|
83
|
+
const createWebComponent = async () => {
|
84
|
+
const packageName = getPackageName();
|
85
|
+
const library = getLibraryName(packageName);
|
86
|
+
|
87
|
+
const consoleArguments = process.argv.slice(2);
|
88
|
+
let componentName = consoleArguments[0];
|
89
|
+
|
90
|
+
if (componentName && !isNameValid(componentName)) {
|
91
|
+
throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
|
92
|
+
}
|
93
|
+
|
94
|
+
if (!componentName) {
|
95
|
+
const response = await prompts({
|
96
|
+
type: "text",
|
97
|
+
name: "componentName",
|
98
|
+
message: "Please enter a component name:",
|
99
|
+
validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
|
100
|
+
});
|
101
|
+
componentName = response.componentName;
|
102
|
+
|
103
|
+
if (!componentName) {
|
104
|
+
process.exit();
|
105
|
+
}
|
106
|
+
}
|
107
|
+
|
108
|
+
const tagName = hyphaneteComponentName(componentName);
|
109
|
+
|
110
|
+
generateFiles(componentName, tagName, library, packageName);
|
111
|
+
};
|
112
|
+
|
113
|
+
createWebComponent();
|
@@ -0,0 +1,77 @@
|
|
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
|
+
const newText = scopeVariables(f.text, packageJSON);
|
26
|
+
await mkdir(path.dirname(f.path), {recursive: true});
|
27
|
+
writeFile(f.path, newText);
|
28
|
+
|
29
|
+
// JS/TS
|
30
|
+
const jsPath = f.path.replace(/dist[\/\\]css/, "src/generated/").replace(".css", extension);
|
31
|
+
const jsContent = getFileContent(packageJSON.name, "\`" + newText + "\`", true);
|
32
|
+
writeFileIfChanged(jsPath, jsContent);
|
33
|
+
});
|
34
|
+
})
|
35
|
+
},
|
36
|
+
}
|
37
|
+
|
38
|
+
const getConfig = async () => {
|
39
|
+
const config = {
|
40
|
+
entryPoints: await globby(inputFilesGlob),
|
41
|
+
bundle: true,
|
42
|
+
minify: true,
|
43
|
+
outdir: 'dist/css',
|
44
|
+
outbase: 'src',
|
45
|
+
plugins: [
|
46
|
+
customPlugin,
|
47
|
+
]
|
48
|
+
};
|
49
|
+
return config;
|
50
|
+
}
|
51
|
+
|
52
|
+
if (restArgs.includes("-w")) {
|
53
|
+
let ready;
|
54
|
+
let config = await getConfig();
|
55
|
+
let ctx = await esbuild.context(config);
|
56
|
+
await ctx.watch()
|
57
|
+
console.log('watching...')
|
58
|
+
|
59
|
+
// when new component css files are added, they do not trigger a build as no one directly imports them
|
60
|
+
// restart the watch mode with the new entry points if a css file is added.
|
61
|
+
const watcher = chokidar.watch(inputFilesGlob);
|
62
|
+
watcher.on("ready", () => {
|
63
|
+
ready = true; // Initial scan is over -> waiting for new files
|
64
|
+
});
|
65
|
+
watcher.on("add", async path => {
|
66
|
+
if (ready) {
|
67
|
+
// new file
|
68
|
+
ctx.dispose();
|
69
|
+
config = await getConfig();
|
70
|
+
ctx = await esbuild.context(config);
|
71
|
+
ctx.watch();
|
72
|
+
}
|
73
|
+
});
|
74
|
+
} else {
|
75
|
+
const config = await getConfig();
|
76
|
+
const result = await esbuild.build(config);
|
77
|
+
}
|
@@ -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
|
+
}
|