@ui5/create-webcomponents-package 0.0.0-d010d8832 → 0.0.0-d473b9686

package/README.md

@@ -1,5 +1,6 @@
 ![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-webcomponents/main/docs/images/UI5_logo_wide.png)
 
+
 # UI5 Web Components - Create Package
 
 [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fwebcomponents.svg)](https://www.npmjs.com/package/@ui5/webcomponents)
@@ -18,8 +19,8 @@ Usage:
 
 Options:
     --name <string>     - defines the package name
-    --tag <string>      - defines the tag name of the sample web component that will be created in your new package
-    --enable-typescript - enables TypeScript support for the package
+    --component-name <string>      - defines the component class name that will be created in your new package
+    --tag <string>      - defines the tag name of the sample web component that will be created in your new package. The tag will be derived from the component name if not provided.
     --skip              - skips configuration and generates package with a default value for each parameter that wasn't passed
 ```
 
@@ -33,8 +34,8 @@ Usage:
     yarn create @ui5/webcomponents-package [OPTIONS]
 Options:
     --name <string>     - defines the package name
+    --component-name <string>      - defines the component class name that will be created in your new package
     --tag <string>      - defines the tag name of the sample web component that will be created in your new package
-    --enable-typescript - enables TypeScript support for the package
     --skip              - skips configuration and generates package with a default value for each parameter that wasn't passed
 ```
 
@@ -47,7 +48,7 @@ components package.
 - [UI5 Web Components - Playground and API Reference](https://sap.github.io/ui5-webcomponents/playground/)
 
 ## Support
-We welcome all comments, suggestions, questions, and bug reports. Please follow our [Support Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/SUPPORT.md#-content) on how to report an issue, or chat with us in the `#webcomponents` channel of the [OpenUI5 Community Slack](https://join-ui5-slack.herokuapp.com/).
+We welcome all comments, suggestions, questions, and bug reports. Please follow our [Support Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/SUPPORT.md#-content) on how to report an issue, or chat with us in the `#webcomponents` channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
 
 ## Contribute
 Please check our [Contribution Guidelines](https://github.com/SAP/ui5-webcomponents/blob/main/docs/6-contributing/02-conventions-and-guidelines.md).

package/create-package.js

@@ -15,31 +15,33 @@ const version = JSON.parse(fs.readFileSync(path.join(__dirname, "package.json"))
 // from where all the files will be copied
 const TEMPLATE_DIR = path.join(`${__dirname}`, `template/`);
 
-// String utils
-const capitalizeFirst = str => str.substr(0,1).toUpperCase() + str.substr(1);
-const kebabToCamelCase = string => toCamelCase(string.split("-"));
-const toCamelCase = parts => {
-	return parts.map((string, index) => {
-		return index === 0 ? string.toLowerCase() : string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();
-	}).join("");
-};
-const isTSRelatedFile = sourcePath => {
-	return ["Assets.ts", "MyFirstComponent.ts", "tsconfig.json", "global.d.ts"].some(fileName => sourcePath.includes(fileName));
-};
-const isJSRelatedFile = sourcePath => {
-	return ["Assets.js", "MyFirstComponent.js"].some(fileName => sourcePath.includes(fileName));
-};
 const isGitIgnore = sourcePath => {
 	return sourcePath.includes("gitignore");
 };
+const isLogo = sourcePath => {
+	return sourcePath.includes("logo");
+};
 const isNPMRC = sourcePath => {
 	return sourcePath.includes("npmrc");
 };
 
 // Validation of user input
-const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z0-9\-_]+$/);
+const ComponentNamePattern = /^[A-Z][A-Za-z0-9]+$/;
+const isPackageNameValid = name => typeof name === "string" && name.match(/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/);
+const isComponentNameValid = name => typeof name === "string" && ComponentNamePattern.test(name);
 const isTagValid = tag => typeof tag === "string" && tag.match(/^[a-z0-9]+?-[a-zA-Z0-9\-_]+?[a-z0-9]$/);
 
+/**
+ * Hyphanates the given PascalCase string, f.e.:
+ * Foo -> "my-foo" (adds preffix)
+ * FooBar -> "foo-bar"
+ */
+const hyphaneteComponentName = (componentName) => {
+	const result = componentName.replace(/([a-z])([A-Z])/g, '$1-$2' ).toLowerCase();
+
+	return result.includes("-") ? result : `my-${result}`;
+};
+
 // Utils for building the file structure
 const replaceVarsInFileContent = (vars, content) => {
 	for (let key in vars) {
@@ -54,10 +56,8 @@ const replaceVarsInFileName = (vars, fileName) => {
 };
 
 const copyFile = (vars, sourcePath, destPath) => {
-	const ignoreJsRelated = vars.INIT_PACKAGE_VAR_TYPESCRIPT && isJSRelatedFile(sourcePath);
-	const ignoreTsRelated = !vars.INIT_PACKAGE_VAR_TYPESCRIPT && isTSRelatedFile(sourcePath);
-
-	if (ignoreJsRelated || ignoreTsRelated) {
+	if (isLogo(sourcePath)) {
+		fs.copyFileSync(sourcePath, destPath);
 		return;
 	}
 
@@ -92,19 +92,18 @@ const copyFiles = (vars, sourcePath, destPath) => {
 	}
 };
 
-const generateFilesContent = (name, tag, typescript) => {
-	const className = capitalizeFirst(kebabToCamelCase(tag));
+const generateFilesContent = (packageName, componentName, skipSubfolder) => {
+	const tagName = argv.tag || hyphaneteComponentName(componentName);
 
 	// All variables that will be replaced in the content of the resources/
 	const vars = {
-		INIT_PACKAGE_VAR_NAME: name,
-		INIT_PACKAGE_VAR_TAG: tag,
-		INIT_PACKAGE_VAR_CLASS_NAME: className,
-		INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
+		INIT_PACKAGE_VAR_NAME: packageName,
+		INIT_PACKAGE_VAR_TAG: tagName,
+		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
 	};
 
 	const packageContent = {
-		name,
+		name: packageName,
 		version: "0.0.1",
 		ui5: {
 			webComponentsPackage: true,
@@ -133,22 +132,21 @@ const generateFilesContent = (name, tag, typescript) => {
 		"devDependencies": {
 			"@ui5/webcomponents-tools": version,
 			"chromedriver": "*",
+			"typescript": "^5.2.2"
 		},
 	};
 
-	if (typescript) {
-		packageContent.devDependencies.typescript = "^4.9.4";
-	}
-
 	// Update package.json
-	const destDir = path.join(`./`, name);
+	let destDir = packageName.includes("@") ? packageName.slice(packageName.lastIndexOf("/") + 1) : packageName;
+
+	destDir = skipSubfolder ? path.join("./") : path.join("./", destDir);
 	mkdirp.sync(destDir);
 	fs.writeFileSync(path.join(destDir, "package.json"), JSON.stringify(packageContent, null, 2));
 	// Copy files
 	copyFiles(vars, TEMPLATE_DIR, destDir);
 
 	console.log("\nPackage successfully created!\nNext steps:\n");
-	console.log(`$ cd ${name}`);
+	console.log(`$ cd ${destDir}`);
 
 	let userAgentInfo;
 	try {
@@ -169,20 +167,24 @@ const generateFilesContent = (name, tag, typescript) => {
 // Main function
 const createWebcomponentsPackage = async () => {
 	let response;
-	if (argv.name && !isNameValid(argv.name)) {
-		throw new Error("The package name should be a string (a-z, A-Z, 0-9).");
+	if (argv.name && !isPackageNameValid(argv.name)) {
+		throw new Error("The package name should be a string, starting with letter and containing the following symbols [a-z, A-Z, 0-9].");
+	}
+
+	if (argv.componentName && !isComponentNameValid(argv.componentName)) {
+		throw new Error("The component name should be a string, starting with a capital letter [A-Z][a-z], for example: Button, MyButton, etc.");
 	}
 
 	if (argv.tag && !isTagValid(argv.tag) ) {
-		throw new Error("The tag should be in kebab-case (my-first-component f.e) and it can't be a single word.");
+		throw new Error("The tag should be in kebab-case (f.e my-component) and it can't be a single word.");
 	}
 
-	let name = argv.name || "my-package";
-	let tag = argv.tag || "my-first-component";
-	let typescriptSupport = !!argv.enableTypescript;
+	let packageName = argv.name || "my-package";
+	let componentName = argv.componentName || "MyComponent";
+	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(name, tag, typescriptSupport);
+		return generateFilesContent(packageName, componentName, skipSubfolder);
 	}
 
 	if (!argv.name) {
@@ -190,42 +192,23 @@ const createWebcomponentsPackage = async () => {
 			type: "text",
 			name: "name",
 			message: "Package name:",
-			validate: isNameValid,
-		});
-		name = response.name;
-	}
-
-	if (!typescriptSupport) {
-		response = await prompts({
-			type: "select",
-			name: "language",
-			message: "Project type:",
-			choices: [
-				{
-					title: "JavaScript",
-					value: false,
-				},
-				{
-					title: "TypeScript",
-					value: true,
-				},
-			],
+			validate: (value) => isPackageNameValid(value) ? true : "Package name should be a string, starting with a letter and containing the following symbols [a-z, A-Z ,0-9, _, -].",
 		});
-		typescriptSupport = response.language;
+		packageName = response.name;
 	}
 
-	if (!argv.tag) {
+	if (!argv.componentName) {
 		response = await prompts({
 			type: "text",
-			name: "tag",
+			name: "componentName",
 			message: "Component name:",
-			initial: "my-first-component",
-			validate: isTagValid,
+			initial: "MyComponent",
+			validate: (value) => isComponentNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
 		});
-		tag = response.tag;
+		componentName = response.componentName;
 	}
 
-	return generateFilesContent(name, tag, typescriptSupport);
+	return generateFilesContent(packageName, componentName, skipSubfolder);
 };
 
 createWebcomponentsPackage();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "0.0.0-d010d8832",
+  "version": "0.0.0-d473b9686",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",

package/template/.eslintignore

@@ -2,4 +2,4 @@
 dist
 test
 src/generated
-jsdoc-dist
+.eslintrc.js

package/template/.eslintrc.js

@@ -0,0 +1,5 @@
+const config = require("@ui5/webcomponents-tools/components-package/eslint.js");
+
+// This eslint config is defined @ui5/webcomponents-tools,
+// Feel free to override part of the configuration or provide entirely new config to fit your dev requirements.
+module.exports = config;

package/template/bundle.esm.js

@@ -6,7 +6,6 @@ import { getLanguage } from "@ui5/webcomponents-base/dist/config/Language.js";
 import { getCalendarType } from "@ui5/webcomponents-base/dist/config/CalendarType.js";
 import { getTheme, setTheme } from "@ui5/webcomponents-base/dist/config/Theme.js";
 import { getNoConflict, setNoConflict } from "@ui5/webcomponents-base/dist/config/NoConflict.js";
-import { getRTL } from "@ui5/webcomponents-base/dist/config/RTL.js";
 import { getFirstDayOfWeek } from "@ui5/webcomponents-base/dist/config/FormatSettings.js";
 
 // Enable additional themes and i18n texts
@@ -25,7 +24,6 @@ window["sap-ui-webcomponents-bundle"] = {
 		getNoConflict,
 		setNoConflict,
 		getCalendarType,
-		getRTL,
 		getFirstDayOfWeek,
 	},
 };

package/template/gitignore

@@ -1,4 +1,3 @@
 node_modules
 dist
-jsdoc-dist
 src/generated

package/template/package-scripts.js

@@ -2,7 +2,6 @@ const getScripts = require("@ui5/webcomponents-tools/components-package/nps.js")
 
 const options = {
 	port: 8080,
-	typescript: INIT_PACKAGE_VAR_TYPESCRIPT,
 };
 
 const scripts = getScripts(options);

package/template/src/MyFirstComponent.hbs

@@ -1 +1,6 @@
-<div>This is: INIT_PACKAGE_VAR_TAG. {{pleaseWaitText}}</div>
+<div
+    class="root"
+    @click="{{onClick}}"
+>
+    {{counterText}} :: {{count}}
+</div>

package/template/src/MyFirstComponent.ts

@@ -1,8 +1,10 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
+import property from "@ui5/webcomponents-base/dist/decorators/property.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
 
 // Template
 import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACKAGE_VAR_CLASS_NAMETemplate.lit.js";
@@ -10,7 +12,7 @@ import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./generated/templates/INIT_PACK
 // Styles
 import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_CLASS_NAME.css.js";
 
-import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
+import { COUNT } from "./generated/i18n/i18n-defaults.js";
 
 /**
  * @class
@@ -20,9 +22,7 @@ import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
  * The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
  *
  * @constructor
- * @alias demo.components.INIT_PACKAGE_VAR_CLASS_NAME
- * @extends sap.ui.webc.base.UI5Element
- * @tagname INIT_PACKAGE_VAR_TAG
+ * @extends UI5Element
  * @public
  */
 @customElement({
@@ -38,8 +38,20 @@ class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
 		INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
 	}
 
-	get pleaseWaitText() {
-		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(PLEASE_WAIT);
+	/**
+	 * Defines the component count.
+	 * @default 0
+	 * @public
+	 */
+	@property({ validator: Integer, defaultValue: 0 })
+	count!: number;
+
+	onClick() {
+		this.count++;
+	}
+
+	get counterText() {
+		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(COUNT);
 	}
 }
 

package/template/src/i18n/messagebundle.properties

@@ -1,2 +1,3 @@
-#please wait text for the sample component
-PLEASE_WAIT=wait
+# the "counter" text for the sample component
+COUNT=Count
+

package/template/src/i18n/messagebundle_de.properties

@@ -1 +1 @@
-PLEASE_WAIT=Bitte warten
+COUNT=Zählung

package/template/src/i18n/messagebundle_en.properties

@@ -1 +1 @@
-PLEASE_WAIT=Please wait
+COUNT=Count

package/template/src/i18n/messagebundle_es.properties

@@ -1 +1 @@
-PLEASE_WAIT=Espere
+COUNT=Cuenta

package/template/src/i18n/messagebundle_fr.properties

@@ -1 +1 @@
-PLEASE_WAIT=Patientez.
+COUNT=Comte

package/template/src/themes/MyFirstComponent.css

@@ -1,11 +1,17 @@
-:host {
-    border: 2px solid var(--my-component-border-color);
-    background-color: var(--sapBackgroundColor);
-    color: var(--sapTextColor);
-    display: block;
-    width: 24rem;
-    height: 3rem;
-    text-align: center;
-    vertical-align: middle;
-    line-height: 3rem;
+.root {
+	display: inline-flex;
+	align-items: center;
+	justify-content: center;
+	flex-direction: column;
+	padding: 0 2rem;
+	color: var(--sapAvatar_6_TextColor);
+	background-color: var(--sapAvatar_6_Background);
+	border: 2px solid var(--my-component-border-color);
+	border-radius: 0.5rem;
+	box-shadow: var(--sapContent_Shadow0);
+	text-align: center;
+	line-height: 3rem;
+	font-size: 1.25rem;
+	user-select: none;
+	cursor: pointer;
 }

package/template/src/themes/sap_fiori_3/parameters-bundle.css

@@ -1,3 +1,3 @@
 :root {
-    --my-component-border-color: green;
+    --my-component-border-color: blue;
 }

package/template/src/themes/sap_horizon_dark/parameters-bundle.css

@@ -1,3 +1,3 @@
 :root {
-    --my-component-border-color: blue;
+    --my-component-border-color: darkblue;
 }

package/template/src/themes/sap_horizon_hcw/parameters-bundle.css

@@ -1,3 +1,3 @@
 :root {
-    --my-component-border-color: orange;
+    --my-component-border-color: black;
 }

package/template/test/pages/css/index.css

@@ -0,0 +1,36 @@
+body {
+	color: var(--sapTextColor);
+	background-color: var(--sapBackgroundColor);
+	font-size: var(--sapFontSize);
+	font-family: var(--sapFontFamily);
+}
+
+h1 {
+	font-size: var(--sapFontHeader2Size);
+	margin-bottom: 0.5rem;
+}
+
+h2 {
+	font-size: var(--sapFontHeader3Size);
+	margin-bottom: 0.5rem;
+}
+
+.app, .app-settings, .app-docs, .app-first-component  {
+	display: flex;
+	align-items: center;
+	justify-content: center;
+	flex-direction: column;
+}
+
+.app-first-component {
+	margin-bottom: 3rem;
+}
+
+.app-docs {
+	margin-top: 3rem;
+}
+
+a {
+	margin: 0.25rem;
+	color: var(--sapLinkColor);
+}

package/template/test/pages/index.html

@@ -10,44 +10,48 @@
 
 	<script data-ui5-config type="application/json">
 		{
+			"theme": "sap_horizon_dark",
 			"language": "EN"
 		}
 	</script>
 
+	<link rel="stylesheet" type="text/css" href="./css/index.css">
 	<script src="../../bundle.esm.js" type="module"></script>
-
-    <style>
-        code { color: blue; font-size: small; }
-    </style>
-
 </head>
 
 <body>
-	<ul>
-	    <li><a href="?sap-ui-theme=sap_fiori_3">Fiori 3</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_dark">Fiori 3 Dark</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_hcb">Fiori 3 High Contrast Black</a></li>
-		<li><a href="?sap-ui-theme=sap_fiori_3_hcw">Fiori 3 High Contrast White</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon">Horizon</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_dark">Horizon Dark</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_hcb">Horizon High Contrast Black</a></li>
-		<li><a href="?sap-ui-theme=sap_horizon_hcw">Horizon High Contrast White</a></li>
-	</ul>
-    <br>
-    <span>or in the browser console, for example:</span>
-    <code>window['sap-ui-webcomponents-bundle'].configuration.setTheme("sap_horizon_hcb")</code>
-
-    <br><br>
-
-    <a href="?sap-ui-language=en">English</a> |
-    <a href="?sap-ui-language=de">German</a> |
-    <a href="?sap-ui-language=es">Spanish</a> |
-    <a href="?sap-ui-language=fr">French</a>
-
-    <br><br>
-
-    <h1>Test your web components here</h1>
-    <INIT_PACKAGE_VAR_TAG id="myFirstComponent"></INIT_PACKAGE_VAR_TAG>
+	<div class="app">
+		<a href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/docs-getting-started-first-steps--docs" target="_blank"><img src="./img/logo.png" alt="logo"/></a>
+
+		<div class="app-first-component">
+			<h1>Hooray! It's Your First Web Component!</h1>
+			<div> <pre>&lt;INIT_PACKAGE_VAR_TAG>&lt;/INIT_PACKAGE_VAR_TAG> </pre></div>
+			<INIT_PACKAGE_VAR_TAG id="myFirstComponent"></INIT_PACKAGE_VAR_TAG>
+		</div>
+
+		<div class="app-settings">
+
+			<h2>Switch themes</h2>
+			<div style="display: flex; flex-direction: row;">
+				<a class="link" href="?sap-ui-theme=sap_horizon">Horizon</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_dark">Horizon Dark</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_hcb">Horizon High Contrast Black</a>
+				<a class="link" href="?sap-ui-theme=sap_horizon_hcw">Horizon High Contrast White</a>
+			</div>
+
+			<h2>Switch language</h2>
+			<div>
+				<a class="link" href="?sap-ui-language=en">English</a>
+				<a class="link" href="?sap-ui-language=de">German</a>
+				<a class="link" href="?sap-ui-language=es">Spanish</a>
+				<a class="link" href="?sap-ui-language=fr">French</a>
+			</div>
+		</div>
+
+		<div class="app-docs">
+			<h2>Documentation</h2>
+			<a class="link" href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/docs-development-custom-ui5-web-components-packages--docs">Custom Component Development</a>
+		</div>
+	</div>
 </body>
-
 </html>

package/template/test/specs/Demo.spec.js

@@ -6,7 +6,6 @@ describe("INIT_PACKAGE_VAR_TAG rendering", async () => {
 	});
 
 	it("tests if web component is correctly rendered", async () => {
-
 		const innerContent = await browser.$("#myFirstComponent").shadow$("div");
 
 		assert.ok(innerContent, "content rendered");

package/template/tsconfig.json

@@ -2,6 +2,7 @@
     "include": ["src/**/*", "global.d.ts"],
     "compilerOptions": {
       "target": "ES2021",
+      "lib": ["DOM", "DOM.Iterable", "ES2023"],
       // Generate d.ts files
       "declaration": true,
       "outDir": "dist",

package/template/config/postcss.components/postcss.config.js

@@ -1 +0,0 @@
-module.exports = require("@ui5/webcomponents-tools/components-package/postcss.components.js"); // eslint-disable-line

package/template/config/postcss.themes/postcss.config.js

@@ -1 +0,0 @@
-module.exports = require("@ui5/webcomponents-tools/components-package/postcss.themes.js"); // eslint-disable-line

package/template/global.d.ts

@@ -1,12 +0,0 @@
-// eslint-disable-next-line
-import "@ui5/webcomponents-base/dist/global";
-import { TemplateFunction } from "@ui5/webcomponents-base/dist/renderer/executeTemplate.js";
-
-export {};
-
-declare global {
-	module "*.lit.js" {
-		const content: TemplateFunction;
-		export default content;
-	}
-}

package/template/src/Assets.js

@@ -1,5 +0,0 @@
-import "@ui5/webcomponents-theming/dist/Assets.js"; // Theming
-
-// own INIT_PACKAGE_VAR_NAME package assets
-import "./generated/json-imports/Themes.js";
-import "./generated/json-imports/i18n.js";