@ui5/create-webcomponents-package 1.13.0-rc.3 → 1.13.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.13.0](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.4...v1.13.0) (2023-05-05)
+
+
+### Bug Fixes
+
+* **create-webcomponents-package:** fix package creation issues with test and lint ([#6976](https://github.com/SAP/ui5-webcomponents/issues/6976)) ([dd70f3a](https://github.com/SAP/ui5-webcomponents/commit/dd70f3aa8ef70b592f1d4e0f3f9894c6280fb1bf))
+
+
+
+
+
+# [1.13.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.3...v1.13.0-rc.4) (2023-05-04)
+
+
+### Features
+
+* generate TS from HBS templates ([#6558](https://github.com/SAP/ui5-webcomponents/issues/6558)) ([02611b2](https://github.com/SAP/ui5-webcomponents/commit/02611b2e24b2c2a06129b8e60a8bc680d9501e39))
+
+
+
+
+
 # [1.13.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.2...v1.13.0-rc.3) (2023-04-27)
 
 **Note:** Version bump only for package @ui5/create-webcomponents-package

package/README.md

@@ -18,7 +18,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
+    --componentName <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. 
     --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
 ```

package/create-package.js

@@ -37,9 +37,22 @@ const isNPMRC = sourcePath => {
 };
 
 // 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 isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z][a-zA-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) {
@@ -92,14 +105,14 @@ const copyFiles = (vars, sourcePath, destPath) => {
 	}
 };
 
-const generateFilesContent = (name, tag, typescript) => {
-	const className = capitalizeFirst(kebabToCamelCase(tag));
+const generateFilesContent = (name, componentName, typescript, 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_TAG: tagName,
+		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
 		INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
 	};
 
@@ -141,7 +154,7 @@ const generateFilesContent = (name, tag, typescript) => {
 	}
 
 	// Update package.json
-	const destDir = path.join(`./`, name);
+	const destDir = skipSubfolder ? path.join("./") : path.join("./", name);
 	mkdirp.sync(destDir);
 	fs.writeFileSync(path.join(destDir, "package.json"), JSON.stringify(packageContent, null, 2));
 	// Copy files
@@ -170,19 +183,24 @@ const generateFilesContent = (name, tag, typescript) => {
 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).");
+		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 componentName = argv.componentName || "MyComponent";
 	let typescriptSupport = !!argv.enableTypescript;
+	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(name, tag, typescriptSupport);
+		return generateFilesContent(name, componentName, typescriptSupport, skipSubfolder);
 	}
 
 	if (!argv.name) {
@@ -190,7 +208,7 @@ const createWebcomponentsPackage = async () => {
 			type: "text",
 			name: "name",
 			message: "Package name:",
-			validate: isNameValid,
+			validate: (value) => isNameValid(value) ? true : "Package name should be a string, starting with a letter and containing the following symbols [a-z, A-Z ,0-9, _, -].",
 		});
 		name = response.name;
 	}
@@ -214,18 +232,18 @@ const createWebcomponentsPackage = async () => {
 		typescriptSupport = response.language;
 	}
 
-	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(name, componentName, typescriptSupport, skipSubfolder);
 };
 
 createWebcomponentsPackage();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "1.13.0-rc.3",
+  "version": "1.13.0",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -24,5 +24,5 @@
     "prompts": "^2.4.1",
     "yargs": "^17.5.1"
   },
-  "gitHead": "61c17ec60eb103e9b98d0acee1256be98430fbaf"
+  "gitHead": "c85ff70d47ba8f5e8c906066f2f4d36d432d2f6a"
 }

package/template/.eslintignore

@@ -2,4 +2,5 @@
 dist
 test
 src/generated
-jsdoc-dist
+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/src/themes/sap_horizon_dark/parameters-bundle.css

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

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

@@ -0,0 +1,3 @@
+:root {
+    --my-component-border-color: white;
+}

package/template/test/pages/index.html

@@ -28,13 +28,14 @@
 		<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_belize">Belize</a></li>
-		<li><a href="?sap-ui-theme=sap_belize_hcb">Belize High Contrast Black</a></li>
-		<li><a href="?sap-ui-theme=sap_belize_hcw">Belize 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_belize_hcb")</code>
+    <code>window['sap-ui-webcomponents-bundle'].configuration.setTheme("sap_horizon_hcb")</code>
 
     <br><br>
 

package/template/tsconfig.json

@@ -9,7 +9,8 @@
       "sourceMap": true,
       "inlineSources": true,
       "strict": true,
-      "moduleResolution": "node",
+      "module": "node16",
+      "moduleResolution": "node16",
       "experimentalDecorators": true,
     },
 }

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/themes/sap_belize_hcw/parameters-bundle.css

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