@ui5/webcomponents-tools 0.0.0-fb61e9889 → 0.0.0-fca1107e7
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 +980 -0
- package/README.md +6 -6
- package/assets-meta.js +16 -3
- package/bin/dev.js +1 -5
- package/components-package/eslint.js +36 -0
- package/components-package/nps.js +108 -70
- package/components-package/postcss.components.js +1 -21
- package/components-package/postcss.themes.js +1 -23
- package/components-package/vite.config.js +13 -0
- package/components-package/wdio.js +405 -353
- package/components-package/wdio.sync.js +26 -2
- package/icons-collection/nps.js +51 -18
- 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 +501 -0
- package/lib/cem/event.mjs +131 -0
- package/lib/cem/schema-internal.json +1357 -0
- package/lib/cem/schema.json +1098 -0
- package/lib/cem/types-internal.d.ts +796 -0
- package/lib/cem/types.d.ts +736 -0
- package/lib/cem/utils.mjs +384 -0
- package/lib/cem/validate.js +70 -0
- package/lib/copy-and-watch/index.js +24 -1
- package/lib/copy-list/index.js +17 -17
- package/lib/create-icons/index.js +124 -58
- package/lib/create-illustrations/index.js +153 -66
- package/lib/create-new-component/index.js +71 -104
- package/lib/create-new-component/jsFileContentTemplate.js +73 -0
- package/lib/create-new-component/tsFileContentTemplate.js +71 -0
- package/lib/css-processors/css-processor-component-styles.mjs +47 -0
- package/lib/css-processors/css-processor-components.mjs +77 -0
- package/lib/css-processors/css-processor-themes.mjs +79 -0
- package/lib/css-processors/scope-variables.mjs +49 -0
- package/lib/css-processors/shared.mjs +76 -0
- package/lib/dev-server/custom-hot-update-plugin.js +39 -0
- package/lib/dev-server/dev-server.js +66 -0
- package/lib/dev-server/virtual-index-html-plugin.js +52 -0
- package/lib/generate-custom-elements-manifest/index.js +271 -0
- package/lib/generate-js-imports/illustrations.js +86 -0
- package/lib/generate-json-imports/i18n.js +43 -31
- package/lib/generate-json-imports/themes.js +36 -24
- package/lib/hbs2lit/src/compiler.js +24 -4
- package/lib/hbs2lit/src/includesReplacer.js +5 -5
- package/lib/hbs2lit/src/litVisitor2.js +95 -24
- package/lib/hbs2lit/src/svgProcessor.js +12 -5
- package/lib/hbs2ui5/RenderTemplates/LitRenderer.js +32 -4
- package/lib/hbs2ui5/index.js +56 -23
- package/lib/i18n/defaults.js +65 -57
- package/lib/i18n/toJSON.js +12 -11
- package/lib/jsdoc/configTypescript.json +29 -0
- package/lib/jsdoc/plugin.js +41 -0
- package/lib/jsdoc/preprocess.js +146 -0
- package/lib/jsdoc/template/publish.js +21 -2
- package/lib/postcss-combine-duplicated-selectors/index.js +185 -0
- package/lib/scoping/get-all-tags.js +2 -9
- package/lib/scoping/missing-dependencies.js +65 -0
- package/lib/scoping/report-tags-usage.js +28 -0
- package/lib/scoping/scope-test-pages.js +2 -1
- package/lib/test-runner/test-runner.js +71 -0
- package/package.json +32 -29
- package/components-package/rollup-plugins/empty-module.js +0 -15
- package/components-package/rollup.js +0 -237
- package/lib/documentation/index.js +0 -165
- package/lib/documentation/templates/api-component-since.js +0 -3
- package/lib/documentation/templates/api-css-variables-section.js +0 -24
- package/lib/documentation/templates/api-events-section.js +0 -35
- package/lib/documentation/templates/api-methods-section.js +0 -26
- package/lib/documentation/templates/api-properties-section.js +0 -40
- package/lib/documentation/templates/api-slots-section.js +0 -28
- package/lib/documentation/templates/template.js +0 -38
- package/lib/esm-abs-to-rel/index.js +0 -54
- package/lib/hash/config.js +0 -10
- package/lib/hash/generate.js +0 -19
- package/lib/hash/upToDate.js +0 -31
- package/lib/polyfill-placeholder/index.js +0 -5
- package/lib/postcss-css-to-esm/index.js +0 -45
- package/lib/postcss-css-to-json/index.js +0 -31
- package/lib/postcss-new-files/index.js +0 -36
- package/lib/replace-global-core/index.js +0 -20
- package/lib/serve/index.js +0 -46
- package/lib/serve/serve.json +0 -3
- package/package-lock.json +0 -48
@@ -1,58 +1,124 @@
|
|
1
|
-
const fs = require("fs");
|
2
|
-
const path = require("path");
|
3
|
-
|
4
|
-
|
5
|
-
const
|
6
|
-
const srcFile = path.normalize(`src/${collectionName}.json`);
|
7
|
-
const destDir = path.normalize("dist/");
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
const
|
12
|
-
|
13
|
-
const
|
14
|
-
const
|
15
|
-
const
|
16
|
-
const
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
export
|
22
|
-
|
23
|
-
|
24
|
-
const
|
25
|
-
import { ${accData.key} } from "
|
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 {
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
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) => `import { registerIcon } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
|
25
|
+
import { ${accData.key} } from "../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 { isLegacyThemeFamily } 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 pathData = isLegacyThemeFamily() ? pathData${versions[0]} : pathData${versions[1]};
|
46
|
+
|
47
|
+
export default "${fullName}";
|
48
|
+
export { pathData, ltr, accData };`;
|
49
|
+
|
50
|
+
|
51
|
+
const typeDefinitionTemplate = (name, accData, collection) => `declare const pathData: string;
|
52
|
+
declare const ltr: boolean;
|
53
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
54
|
+
declare const _default: "${collection}/${name}";
|
55
|
+
|
56
|
+
export default _default;
|
57
|
+
export { pathData, ltr, accData };`
|
58
|
+
|
59
|
+
const collectionTypeDefinitionTemplate = (name, accData) => `declare const pathData: string;
|
60
|
+
declare const ltr: boolean;
|
61
|
+
declare const accData: ${accData ? '{ key: string; defaultText: string; }' : null}
|
62
|
+
declare const _default: "${name}";
|
63
|
+
|
64
|
+
export default _default;
|
65
|
+
export { pathData, ltr, accData };`
|
66
|
+
|
67
|
+
|
68
|
+
const svgTemplate = (pathData) => `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
|
69
|
+
<path d="${pathData}"/>
|
70
|
+
</svg>`;
|
71
|
+
|
72
|
+
const createIcons = async (file) => {
|
73
|
+
await fs.mkdir(destDir, { recursive: true });
|
74
|
+
|
75
|
+
const json = JSON.parse(await fs.readFile(file));
|
76
|
+
|
77
|
+
const promises = [];
|
78
|
+
for (let name in json.data) {
|
79
|
+
const iconData = json.data[name];
|
80
|
+
const pathData = iconData.path;
|
81
|
+
const ltr = !!iconData.ltr;
|
82
|
+
const acc = iconData.acc;
|
83
|
+
const packageName = json.packageName;
|
84
|
+
const collection = json.collection;
|
85
|
+
|
86
|
+
const content = acc ? iconAccTemplate(name, pathData, ltr, acc, collection, packageName) : iconTemplate(name, pathData, ltr, collection, packageName);
|
87
|
+
|
88
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.js`), content));
|
89
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.svg`), svgTemplate(pathData)));
|
90
|
+
promises.push(fs.writeFile(path.join(destDir, `${name}.d.ts`), typeDefinitionTemplate(name, acc, collection)));
|
91
|
+
|
92
|
+
// For versioned icons collections, the script creates top level (unversioned) module that internally imports the versioned ones.
|
93
|
+
// For example, the top level "@ui5/ui5-webcomponents-icons/dist/accept.js" imports:
|
94
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v5/accept.js"
|
95
|
+
// - "@ui5/ui5-webcomponents-icons/dist/v4/accept.js"
|
96
|
+
|
97
|
+
if (json.version) {
|
98
|
+
// The exported value from the top level (unversioned) icon module depends on whether the collection is the default,
|
99
|
+
// to add or not the collection name to the exported value:
|
100
|
+
// For the default collection (SAPIcons) we export just the icon name - "export default { 'accept' }"
|
101
|
+
// For non-default collections (SAPTNTIcons and SAPBSIcons) we export the full name - "export default { 'tnt/actor' }"
|
102
|
+
const effectiveName = isDefaultCollection(collection) ? name : getUnversionedFullIconName(name, collection);
|
103
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.js`), collectionTemplate(name, json.versions, effectiveName)));
|
104
|
+
promises.push(fs.writeFile(path.join(path.normalize("dist/"), `${name}.d.ts`), collectionTypeDefinitionTemplate(effectiveName, acc)));
|
105
|
+
}
|
106
|
+
}
|
107
|
+
|
108
|
+
return Promise.all(promises);
|
109
|
+
};
|
110
|
+
|
111
|
+
const isDefaultCollection = collectionName => collectionName === "SAP-icons-v4" || collectionName === "SAP-icons-v5";
|
112
|
+
const getUnversionedFullIconName = (name, collection) => `${getUnversionedCollectionName(collection)}/${name}`;
|
113
|
+
const getUnversionedCollectionName = collectionName => CollectionVersionedToUnversionedMap[collectionName] || collectionName;
|
114
|
+
|
115
|
+
const CollectionVersionedToUnversionedMap = {
|
116
|
+
"tnt-v2": "tnt",
|
117
|
+
"tnt-v3": "tnt",
|
118
|
+
"business-suite-v1": "business-suite",
|
119
|
+
"business-suite-v2": "business-suite",
|
120
|
+
};
|
121
|
+
|
122
|
+
createIcons(srcFile).then(() => {
|
123
|
+
console.log("Icons created.");
|
124
|
+
});
|
@@ -1,95 +1,182 @@
|
|
1
|
-
const fs = require("fs");
|
1
|
+
const fs = require("fs").promises;
|
2
2
|
const path = require("path");
|
3
|
-
const mkdirp = require("mkdirp");
|
4
3
|
|
5
4
|
if (process.argv.length < 7) {
|
6
|
-
|
5
|
+
throw new Error("Not enough arguments");
|
7
6
|
}
|
8
7
|
|
9
|
-
const
|
10
|
-
|
11
|
-
const
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
};
|
26
|
-
|
27
|
-
const
|
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
|
+
}
|
28
73
|
|
29
|
-
|
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";
|
30
108
|
import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
|
31
109
|
import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
|
32
110
|
import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
|
33
|
-
import {
|
34
|
-
|
35
|
-
|
36
|
-
}
|
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";` : ``}
|
37
116
|
|
38
117
|
const name = "${illustrationName}";
|
39
118
|
const set = "${illustrationSet}";
|
40
|
-
const
|
41
|
-
const
|
119
|
+
const collection = "${collection}";${defaultText ? `
|
120
|
+
const title = IM_TITLE_${illustrationNameUpperCase};
|
121
|
+
const subtitle = IM_SUBTITLE_${illustrationNameUpperCase};` : ``}
|
42
122
|
|
43
123
|
registerIllustration(name, {
|
44
124
|
dialogSvg,
|
45
125
|
sceneSvg,
|
46
126
|
spotSvg,
|
127
|
+
dotSvg,${defaultText ? `
|
47
128
|
title,
|
48
|
-
subtitle
|
49
|
-
set,
|
50
|
-
});
|
51
|
-
|
52
|
-
export {
|
53
|
-
dialogSvg,
|
54
|
-
sceneSvg,
|
55
|
-
spotSvg,
|
56
|
-
};` :
|
57
|
-
`import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
|
58
|
-
import dialogSvg from "./${illustrationsPrefix}-Dialog-${illustrationName}.js";
|
59
|
-
import sceneSvg from "./${illustrationsPrefix}-Scene-${illustrationName}.js";
|
60
|
-
import spotSvg from "./${illustrationsPrefix}-Spot-${illustrationName}.js";
|
61
|
-
|
62
|
-
const name = "${illustrationName}";
|
63
|
-
const set = "${illustrationSet}";
|
64
|
-
|
65
|
-
registerIllustration(name, {
|
66
|
-
dialogSvg,
|
67
|
-
sceneSvg,
|
68
|
-
spotSvg,
|
129
|
+
subtitle,` : ``}
|
69
130
|
set,
|
131
|
+
collection,
|
70
132
|
});
|
71
133
|
|
134
|
+
export default "${illustrationSet === "fiori" ? "" : `${illustrationSet}/`}${illustrationName}";
|
72
135
|
export {
|
73
136
|
dialogSvg,
|
74
137
|
sceneSvg,
|
75
138
|
spotSvg,
|
139
|
+
dotSvg,
|
76
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
|
+
});
|
77
178
|
};
|
78
179
|
|
79
|
-
|
80
|
-
|
81
|
-
const illustrationFileNames = fs.readdirSync(path.normalize(srcPath));
|
82
|
-
|
83
|
-
// convert SVG to JS imports
|
84
|
-
illustrationFileNames.forEach(illustration => {
|
85
|
-
if (fileNamePattern.test(illustration)) {
|
86
|
-
let [fileName, illustrationName] = illustration.match(fileNamePattern);
|
87
|
-
|
88
|
-
svgToJs(fileName);
|
89
|
-
fileNames.add(illustrationName);
|
90
|
-
}
|
180
|
+
generate().then(() => {
|
181
|
+
console.log("Illustrations generated.");
|
91
182
|
});
|
92
|
-
|
93
|
-
for (let illustrationName of fileNames) {
|
94
|
-
fs.writeFileSync(path.join(destPath, `${illustrationName}.js`), illustrationImportTemplate(illustrationName));
|
95
|
-
}
|
@@ -1,80 +1,30 @@
|
|
1
1
|
const fs = require("fs");
|
2
|
-
|
3
|
-
const
|
4
|
-
|
5
|
-
|
6
|
-
import ${componentName}Template from "./generated/templates/${componentName}Template.lit.js";
|
7
|
-
|
8
|
-
// Styles
|
9
|
-
import ${componentName}Css from "./generated/themes/${componentName}.css.js";
|
2
|
+
const path = require("path");
|
3
|
+
const prompts = require("prompts");
|
4
|
+
const jsFileContentTemplate = require("./jsFileContentTemplate.js");
|
5
|
+
const tsFileContentTemplate = require("./tsFileContentTemplate.js");
|
10
6
|
|
11
7
|
/**
|
12
|
-
*
|
8
|
+
* Hyphanates the given PascalCase string, f.e.:
|
9
|
+
* Foo -> "my-foo" (adds preffix)
|
10
|
+
* FooBar -> "foo-bar"
|
13
11
|
*/
|
14
|
-
const
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
},
|
19
|
-
slots: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
|
20
|
-
//
|
21
|
-
},
|
22
|
-
events: /** @lends sap.ui.webcomponents.${library}.${componentName}.prototype */ {
|
23
|
-
//
|
24
|
-
},
|
12
|
+
const hyphaneteComponentName = (componentName) => {
|
13
|
+
const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
|
14
|
+
|
15
|
+
return result.includes("-") ? result : `my-${result}`;
|
25
16
|
};
|
26
17
|
|
27
18
|
/**
|
28
|
-
*
|
29
|
-
*
|
30
|
-
* <h3 class="comment-api-title">Overview</h3>
|
31
|
-
*
|
32
|
-
*
|
33
|
-
* <h3>Usage</h3>
|
34
|
-
*
|
35
|
-
* For the <code>${tagName}</code>
|
36
|
-
* <h3>ES6 Module Import</h3>
|
37
|
-
*
|
38
|
-
* <code>import ${packageName}/dist/${componentName}.js";</code>
|
39
|
-
*
|
40
|
-
* @constructor
|
41
|
-
* @author SAP SE
|
42
|
-
* @alias sap.ui.webcomponents.${library}.${componentName}
|
43
|
-
* @extends UI5Element
|
44
|
-
* @tagname ${tagName}
|
45
|
-
* @public
|
19
|
+
* Capitalizes first letter of string.
|
46
20
|
*/
|
47
|
-
|
48
|
-
static get metadata() {
|
49
|
-
return metadata;
|
50
|
-
}
|
51
|
-
|
52
|
-
static get render() {
|
53
|
-
return litRender;
|
54
|
-
}
|
55
|
-
|
56
|
-
static get styles() {
|
57
|
-
return ${componentName}Css;
|
58
|
-
}
|
59
|
-
|
60
|
-
static get template() {
|
61
|
-
return ${componentName}Template;
|
62
|
-
}
|
63
|
-
|
64
|
-
static get dependencies() {
|
65
|
-
return [];
|
66
|
-
}
|
67
|
-
|
68
|
-
static async onDefine() {
|
69
|
-
|
70
|
-
}
|
71
|
-
}
|
72
|
-
|
73
|
-
${componentName}.define();
|
21
|
+
const capitalizeFirstLetter = string => string.charAt(0).toUpperCase() + string.slice(1);
|
74
22
|
|
75
|
-
|
76
|
-
|
77
|
-
|
23
|
+
/**
|
24
|
+
* Validates component name, enforcing PascalCase pattern - Button, MyButton.
|
25
|
+
*/
|
26
|
+
const PascalCasePattern = /^[A-Z][A-Za-z0-9]+$/;
|
27
|
+
const isNameValid = name => typeof name === "string" && PascalCasePattern.test(name);
|
78
28
|
|
79
29
|
const getPackageName = () => {
|
80
30
|
if (!fs.existsSync("./package.json")) {
|
@@ -108,47 +58,64 @@ const getLibraryName = packageName => {
|
|
108
58
|
return packageName.substr("webcomponents-".length);
|
109
59
|
};
|
110
60
|
|
111
|
-
const
|
112
|
-
|
113
|
-
const
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
61
|
+
const generateFiles = (componentName, tagName, library, packageName, isTypeScript) => {
|
62
|
+
componentName = capitalizeFirstLetter(componentName);
|
63
|
+
const filePaths = {
|
64
|
+
"main": isTypeScript
|
65
|
+
? `./src/${componentName}.ts`
|
66
|
+
: `./src/${componentName}.js`,
|
67
|
+
"css": `./src/themes/${componentName}.css`,
|
68
|
+
"template": `./src/${componentName}.hbs`,
|
69
|
+
};
|
70
|
+
|
71
|
+
const FileContentTemplate = isTypeScript
|
72
|
+
? tsFileContentTemplate(componentName, tagName, library, packageName)
|
73
|
+
: jsFileContentTemplate(componentName, tagName, library, packageName);
|
74
|
+
|
75
|
+
fs.writeFileSync(filePaths.main, FileContentTemplate, { flag: "wx+" });
|
76
|
+
fs.writeFileSync(filePaths.css, "", { flag: "wx+" });
|
77
|
+
fs.writeFileSync(filePaths.template, "<div>Hello World</div>", { flag: "wx+" });
|
78
|
+
|
79
|
+
console.log(`Successfully generated ${filePaths.main}`);
|
80
|
+
console.log(`Successfully generated ${filePaths.css}`);
|
81
|
+
console.log(`Successfully generated ${filePaths.template}`);
|
82
|
+
|
83
|
+
// Change the color of the output
|
84
|
+
console.warn('\x1b[33m%s\x1b[0m', `
|
85
|
+
Make sure to import the component in your bundle by using:
|
86
|
+
import "./dist/${componentName}.js";`);
|
122
87
|
}
|
123
88
|
|
124
|
-
|
125
|
-
|
126
|
-
const
|
127
|
-
|
128
|
-
"css": `./src/themes/${componentName}.css`,
|
129
|
-
"hbs": `./src/${componentName}.hbs`,
|
130
|
-
};
|
131
|
-
const sJsFileContentTemplate = jsFileContentTemplate(componentName);
|
89
|
+
// Main function
|
90
|
+
const createWebComponent = async () => {
|
91
|
+
const packageName = getPackageName();
|
92
|
+
const library = getLibraryName(packageName);
|
132
93
|
|
133
|
-
|
134
|
-
|
135
|
-
fs.writeFileSync(filePaths.hbs, "<div>Hello World</div>", { flag: "wx+" });
|
94
|
+
const consoleArguments = process.argv.slice(2);
|
95
|
+
let componentName = consoleArguments[0];
|
136
96
|
|
97
|
+
if (componentName && !isNameValid(componentName)) {
|
98
|
+
throw new Error(`${componentName} is invalid component name. Use only letters (at least two) and start with capital one: Button, MyButton, etc.`);
|
99
|
+
}
|
137
100
|
|
138
|
-
|
139
|
-
|
140
|
-
|
101
|
+
if (!componentName) {
|
102
|
+
const response = await prompts({
|
103
|
+
type: "text",
|
104
|
+
name: "componentName",
|
105
|
+
message: "Please enter a component name:",
|
106
|
+
validate: (value) => isNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
|
107
|
+
});
|
108
|
+
componentName = response.componentName;
|
109
|
+
|
110
|
+
if (!componentName) {
|
111
|
+
process.exit();
|
112
|
+
}
|
113
|
+
}
|
141
114
|
|
142
|
-
const
|
143
|
-
|
144
|
-
});
|
115
|
+
const isTypeScript = fs.existsSync(path.join(process.cwd(), "tsconfig.json"));
|
116
|
+
const tagName = hyphaneteComponentName(componentName);
|
145
117
|
|
146
|
-
|
147
|
-
|
148
|
-
import ${componentName} from "./dist/${componentName}.js";`);
|
118
|
+
generateFiles(componentName, tagName, library, packageName, isTypeScript);
|
119
|
+
};
|
149
120
|
|
150
|
-
|
151
|
-
console.warn('\x1b[33m%s\x1b[0m', `
|
152
|
-
Component is imported in bundle.common.js.
|
153
|
-
Do NOT forget to sort the file in alphabeticall order.
|
154
|
-
`);
|
121
|
+
createWebComponent();
|