@ui5/create-webcomponents-package 0.0.0-e5b03d3e8 → 0.0.0-ebd9a4db3

package/CHANGELOG.md

@@ -3,6 +3,94 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.11.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v2.11.0-rc.0...v2.11.0-rc.1) (2025-05-15)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.11.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v2.10.0...v2.11.0-rc.0) (2025-05-08)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.10.0](https://github.com/SAP/ui5-webcomponents/compare/v2.10.0-rc.3...v2.10.0) (2025-05-07)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.10.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v2.10.0-rc.2...v2.10.0-rc.3) (2025-05-01)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.10.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v2.10.0-rc.1...v2.10.0-rc.2) (2025-04-24)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.10.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v2.10.0-rc.0...v2.10.0-rc.1) (2025-04-17)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.10.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v2.9.1-rc.0...v2.10.0-rc.0) (2025-04-14)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+## [2.9.1-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v2.9.0...v2.9.1-rc.0) (2025-04-10)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.9.0](https://github.com/SAP/ui5-webcomponents/compare/v2.9.0-rc.3...v2.9.0) (2025-04-04)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.9.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v2.9.0-rc.2...v2.9.0-rc.3) (2025-04-03)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [2.9.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v2.9.0-rc.1...v2.9.0-rc.2) (2025-03-27)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
 # [2.9.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v2.9.0-rc.0...v2.9.0-rc.1) (2025-03-20)
 
 **Note:** Version bump only for package @ui5/create-webcomponents-package

package/README.md

@@ -15,10 +15,9 @@ Usage:
     npm init @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. 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
+    --name <string>                      - defines the package name
+    --test-setup <"cypress" | "manual">  - defines whether the predefined test setup should be added or it will be configured manually.
+    --skip                               - skips configuration and generates package with a default value for each parameter that wasn't passed
 ```
 
 The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new
@@ -30,10 +29,9 @@ components package.
 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
-    --skip              - skips configuration and generates package with a default value for each parameter that wasn't passed
+    --name <string>                      - defines the package name
+    --test-setup <"cypress" | "manual">  - defines whether the predefined test setup should be added or it will be configured manually.
+    --skip                               - skips configuration and generates package with a default value for each parameter that wasn't passed
 ```
 
 The script creates a new directory, and fills it with a `package.json` file and all necessary source files, and resources for a new

package/create-package.js

@@ -1,191 +1,216 @@
 #!/usr/bin/env node
-
-const fs = require("fs");
-const path = require("path");
-const mkdirp = require("mkdirp");
-const prompts = require("prompts");
-const parser = require("npm-config-user-agent-parser");
-const yargs = require("yargs/yargs");
-const { hideBin } = require("yargs/helpers");
-
+import fs from "fs/promises";
+import path, { dirname } from "path";
+import prompts from "prompts";
+import parser from "npm-config-user-agent-parser";
+import yargs from "yargs/yargs";
+import { hideBin } from "yargs/helpers";
+import { fileURLToPath } from "url";
+import * as prettier from "prettier";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 const argv = yargs(hideBin(process.argv)).argv;
-
-const version = JSON.parse(fs.readFileSync(path.join(__dirname, "package.json"))).version;
-
-// from where all the files will be copied
-const TEMPLATE_DIR = path.join(`${__dirname}`, `template/`);
-
-const isGitIgnore = sourcePath => {
-	return sourcePath.includes("gitignore");
-};
-const isLogo = sourcePath => {
-	return sourcePath.includes("logo");
-};
-const isNPMRC = sourcePath => {
-	return sourcePath.includes("npmrc");
+const VERSION = JSON.parse(
+	await fs.readFile(path.join(__dirname, "package.json")),
+).version;
+
+// Constants
+const SUPPORTED_TEST_SETUPS = ["cypress", "manual"];
+const SRC_DIR = path.join(__dirname, "template");
+const DEST_DIR = process.cwd();
+
+const FILES_TO_RENAME = {
+	"eslintignore": ".eslintignore",
+	"eslintrc.cjs": ".eslintrc.cjs",
+	"npsrc.json": ".npsrc.json",
+	"npmrc": ".npmrc",
+	"env": ".env",
+	"gitignore": ".gitignore",
+	"tsconfig.template.json": "tsconfig.json",
+	"cypress/tsconfig.template.json": "cypress/tsconfig.json"
 };
+const FILES_TO_COPY = ["test/pages/img/logo.png"];
+
+// Validation Patterns
+const PackageNamePattern =
+	/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
+const TagPattern = /^[a-z0-9]+?-[a-zA-Z0-9\-_]+?[a-z0-9]$/;
+
+// Utility Functions
+const isPackageNameValid = name =>
+	typeof name === "string" && PackageNamePattern.test(name);
+const isTagValid = tag => typeof tag === "string" && TagPattern.test(tag);
+const isTestSetupValid = setup =>
+	typeof setup === "string" && SUPPORTED_TEST_SETUPS.includes(setup);
+
+async function collectFiles(dir, fileList = []) {
+	const entries = await fs.readdir(dir, { withFileTypes: true });
+
+	for (const entry of entries) {
+		const fullPath = path.join(dir, entry.name);
+		if (entry.isDirectory()) {
+			await collectFiles(fullPath, fileList);
+		} else if (entry.isFile()) {
+			fileList.push(fullPath);
+		}
+	}
 
-// Validation of user input
-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]$/);
+	return fileList;
+}
 
 /**
  * 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();
-
+const hyphenateComponentName = 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) {
-		const re = new RegExp(key, "g");
-		content = content.replace(re, vars[key]);
-	}
-	return content;
-};
-
-const replaceVarsInFileName = (vars, fileName) => {
-	return fileName.replace(/MyFirstComponent/, vars.INIT_PACKAGE_VAR_CLASS_NAME);
-};
-
-const copyFile = (vars, sourcePath, destPath) => {
-	if (isLogo(sourcePath)) {
-		fs.copyFileSync(sourcePath, destPath);
-		return;
-	}
-
-	let content = fs.readFileSync(sourcePath, { encoding: "UTF-8" });
-	content = replaceVarsInFileContent(vars, content);
-	destPath = replaceVarsInFileName(vars, destPath);
-
-	fs.writeFileSync(destPath, content);
-
-	// Rename "gitignore" to ".gitignore" (npm init won't include ".gitignore", so we add it as "gitignore" and rename it later)
-	if (isGitIgnore(sourcePath)) {
-		fs.renameSync(destPath, destPath.replace("gitignore", ".gitignore"))
-	}
-
-	// Rename "npmrc" to ".npmrc" (npm init won't include ".npmrc", so we add it as "npmrc" and rename it later)
-	if (isNPMRC(sourcePath)) {
-		fs.renameSync(destPath, destPath.replace("npmrc", ".npmrc"));
-	}
-};
+const replacePlaceholders = (content, replacements) =>
+	content.replace(/{{(.*?)}}/g, (_, key) => replacements[key.trim()] || "");
 
-const copyFiles = (vars, sourcePath, destPath) => {
-	const isDir = fs.lstatSync(sourcePath).isDirectory();
-	if (isDir) {
-		if (destPath) {
-			mkdirp.sync(destPath);
-		}
-		fs.readdirSync(sourcePath).forEach(file => {
-			copyFiles(vars, path.join(sourcePath, file), path.join(destPath, file));
-		});
-	} else {
-		copyFile(vars, sourcePath, destPath);
-	}
-};
-
-const generateFilesContent = (packageName, componentName, skipSubfolder) => {
-	const tagName = argv.tag || hyphaneteComponentName(componentName);
-
-	// All variables that will be replaced in the content of the resources/
+const generateFilesContent = async (
+	packageName,
+	componentName,
+	skipSubfolder,
+	testSetup,
+) => {
+	// All variables that will be replaced in the content of the template folder/
 	const vars = {
 		INIT_PACKAGE_VAR_NAME: packageName,
-		INIT_PACKAGE_VAR_TAG: tagName,
+		INIT_PACKAGE_VERSION: VERSION,
+		INIT_PACKAGE_VAR_TAG: argv.tag || hyphenateComponentName(componentName),
 		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
+		INIT_PACKAGE_CYPRESS_ROOT_TSCONFIG:
+			testSetup === "cypress"
+				? `"tsBuildInfoFile": "dist/.tsbuildinfo",\n"rootDir": "src",\n"composite": true,`
+				: "",
+		INIT_PACKAGE_CYPRESS_DEV_DEPS:
+			testSetup === "cypress"
+				? `"@ui5/cypress-ct-ui5-webc": "^0.0.4",\n"cypress": "^13.11.0",`
+				: "",
+		INIT_PACKAGE_CYPRESS_TEST_COMMANDS:
+			testSetup === "cypress"
+				? `"test": "cypress run --component --browser chrome",\n"test:open": "cypress open --component --browser chrome",`
+				: "",
+		INIT_PACKAGE_CYPRESS_ESLINT_IGNORES:
+			testSetup === "cypress" ? `cypress/*\ncypress.config.*` : "",
 	};
 
-	const packageContent = {
-		name: packageName,
-		version: "0.0.1",
-		ui5: {
-			webComponentsPackage: true,
-		},
-		type: "module",
-		scripts: {
-			"clean": "wc-dev clean",
-			"lint": "wc-dev lint",
-			"start": "wc-dev start",
-			"watch": "wc-dev watch",
-			"build": "wc-dev build",
-			"test": "wc-dev test",
-			"create-ui5-element": "wc-create-ui5-element",
-			"prepublishOnly": "npm run build",
-		},
-		exports: {
-			"./src/*": "./src/*",
-			"./dist/*": "./dist/*",
-			"./package.json": "./package.json",
-			"./bundle.js": "./bundle.js",
-			"./*": "./dist/*",
-		},
-		"dependencies": {
-			"@ui5/webcomponents-base": version,
-			"@ui5/webcomponents-theming": version,
-		},
-		"devDependencies": {
-			"@ui5/webcomponents-tools": version,
-			"chromedriver": "*",
-			"typescript": "^5.6.2"
-		},
-	};
-
-	// Update package.json
-	let destDir = packageName.includes("@") ? packageName.slice(packageName.lastIndexOf("/") + 1) : packageName;
+	const packageBaseName = packageName.includes("@")
+		? packageName.slice(packageName.lastIndexOf("/") + 1)
+		: packageName;
+	const destDir = skipSubfolder
+		? path.join(DEST_DIR)
+		: path.join(DEST_DIR, packageBaseName);
 
-	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);
+	await processFiles(destDir, vars, testSetup);
 
 	console.log("\nPackage successfully created!\nNext steps:\n");
 	console.log(`$ cd ${destDir}`);
 
-	let userAgentInfo;
 	try {
-		userAgentInfo = parser(process.env.npm_config_user_agent);
-	} catch (e) {}
-
-	if (userAgentInfo && userAgentInfo.yarn) {
-		console.log(`$ yarn`);
-		console.log(`$ yarn start`);
-	} else {
-		console.log(`$ npm i`);
-		console.log(`$ npm start`);
+		const userAgent = parser(process.env.npm_config_user_agent);
+		userAgent.yarn
+			? console.log(`$ yarn\n$ yarn start`)
+			: console.log(`$ npm i\n$ npm start`);
+	} catch {
+		console.log(`$ npm i\n$ npm start`);
 	}
 
 	console.log("\n");
 };
 
-// Main function
+async function processFiles(destDir, replacements, testSetup) {
+	const files = await collectFiles(SRC_DIR);
+	const FILE_PATHS_TO_SKIP = [
+		testSetup !== "cypress" ? "cypress" : undefined,
+	].filter(Boolean);
+
+	for (const file of files) {
+		const relativePath = path.relative(SRC_DIR, file);
+		let destPath = path.join(destDir, relativePath);
+
+		if (FILE_PATHS_TO_SKIP.some(filePath => file.includes(filePath))) {
+			// console.log(`Skipped: ${file} -> ${destPath}`);
+			continue;
+		}
+
+		// Component related file based on the user input
+		destPath = destPath.replace(
+			"/MyFirstComponent",
+			`/${replacements.INIT_PACKAGE_VAR_CLASS_NAME}`,
+		);
+
+		// Files that need to be renamed
+		if (FILES_TO_RENAME[relativePath]) {
+			destPath = destPath.replace(
+				relativePath,
+				FILES_TO_RENAME[relativePath],
+			);
+		}
+
+		await fs.mkdir(path.dirname(destPath), { recursive: true });
+
+		if (FILES_TO_COPY.includes(relativePath)) {
+			// Image like files that doesn't need proccessing
+			await fs.copyFile(file, destPath);
+		} else {
+			const content = await fs.readFile(file, { encoding: "utf8" });
+			const replaced = replacePlaceholders(content, replacements);
+			let formatted;
+			try {
+				formatted = await prettier.format(replaced, {
+					useTabs: true,
+					tabWidth: 4,
+					quoteProps: "consistent",
+					arrowParens: "avoid",
+					filepath: file,
+				});
+				// console.log(`Formatted: ${file} -> ${destPath}`);
+			} catch {
+				// console.log(`Not formatted: ${file} -> ${destPath}`);
+				formatted = replaced;
+			}
+
+			await fs.writeFile(destPath, formatted);
+		}
+
+		// console.log(`Processed: ${file} -> ${destPath}`);
+	}
+}
+
 const createWebcomponentsPackage = async () => {
 	let response;
 	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.");
+		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.tag && !isTagValid(argv.tag) ) {
-		throw new Error("The tag should be in kebab-case (f.e my-component) and it can't be a single word.");
+	if (argv.testSetup && !isTestSetupValid(argv.testSetup)) {
+		throw new Error(
+			`The test setup should be a string and one of the following options: ${SUPPORTED_TEST_SETUPS.join(", ")}`,
+		);
 	}
 
 	let packageName = argv.name || "my-package";
-	let componentName = argv.componentName || "MyComponent";
+	let componentName = "MyComponent";
+	let testSetup = argv.testSetup || "manual";
 	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(packageName, componentName, skipSubfolder);
+		return generateFilesContent(
+			packageName,
+			componentName,
+			skipSubfolder,
+			testSetup,
+		);
 	}
 
 	if (!argv.name) {
@@ -193,23 +218,35 @@ const createWebcomponentsPackage = async () => {
 			type: "text",
 			name: "name",
 			message: "Package name:",
-			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, _, -].",
+			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, _, -].",
 		});
 		packageName = response.name;
 	}
 
-	if (!argv.componentName) {
+	if (!argv.testSetup) {
 		response = await prompts({
-			type: "text",
-			name: "componentName",
-			message: "Component name:",
-			initial: "MyComponent",
-			validate: (value) => isComponentNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
+			type: "select",
+			name: "testSetup",
+			message: "How would you like to set up testing?",
+			choices: [
+				{ title: "Cypress", value: "cypress" },
+				{ title: "I'll set it up manually", value: "manual" },
+			],
+			initial: 0,
 		});
-		componentName = response.componentName;
+
+		testSetup = response.testSetup;
 	}
 
-	return generateFilesContent(packageName, componentName, skipSubfolder);
+	return generateFilesContent(
+		packageName,
+		componentName,
+		skipSubfolder,
+		testSetup,
+	);
 };
 
 createWebcomponentsPackage();

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "0.0.0-e5b03d3e8",
+  "version": "0.0.0-ebd9a4db3",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
+  "type": "module",
   "private": false,
   "keywords": [
     "openui5",
@@ -21,6 +22,7 @@
   "dependencies": {
     "mkdirp": "^1.0.4",
     "npm-config-user-agent-parser": "^1.0.0",
+    "prettier": "^3.5.3",
     "prompts": "^2.4.1",
     "yargs": "^17.5.1"
   }

package/template/.eslintignore

@@ -2,4 +2,6 @@
 dist
 test
 src/generated
-.eslintrc.cjs
+.eslintrc.cjs
+
+{{INIT_PACKAGE_CYPRESS_ESLINT_IGNORES}}

package/template/cypress/component/MyFirstComponent.cy.tsx

@@ -0,0 +1,13 @@
+import {{INIT_PACKAGE_VAR_CLASS_NAME}} from "../../src/{{INIT_PACKAGE_VAR_CLASS_NAME}}.js";
+
+describe('{{INIT_PACKAGE_VAR_CLASS_NAME}}.cy.tsx', () => {
+  it('playground', () => {
+    cy.mount(<{{INIT_PACKAGE_VAR_CLASS_NAME}} />)
+
+    cy.get("[{{INIT_PACKAGE_VAR_TAG}}]")
+      .click();
+
+    cy.get("[{{INIT_PACKAGE_VAR_TAG}}]")
+      .should("have.prop", "count", 1)
+  })
+})

package/template/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

package/template/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

package/template/cypress/support/component-index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <title>Components App</title>
+  </head>
+  <body>
+    <div data-cy-root></div>
+  </body>
+</html>

package/template/cypress/support/component.ts

@@ -0,0 +1,36 @@
+// ***********************************************************
+// This example support/component.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+import { mount } from '@ui5/cypress-ct-ui5-webc'
+
+// Augment the Cypress namespace to include type definitions for
+// your custom command.
+// Alternatively, can be defined in cypress/support/component.d.ts
+// with a <reference path="./component" /> at the top of your spec.
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      mount: typeof mount
+    }
+  }
+}
+
+Cypress.Commands.add('mount', mount)
+
+// Example use:
+// cy.mount(MyComponent)

package/template/cypress/tsconfig.template.json

@@ -0,0 +1,19 @@
+{
+    "include": [
+        "./**/*"
+    ],
+    "compilerOptions": {
+        "module": "NodeNext",
+        "moduleResolution": "nodenext",
+        "jsx": "react-jsx",
+        "jsxImportSource": "@ui5/webcomponents-base",
+        "types": [
+            "cypress"
+        ]
+    },
+    "references": [
+        {
+            "path": "../"
+        }
+    ]
+}

package/template/cypress.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  component: {
+    devServer: {
+      framework: "@ui5/cypress-ct-ui5-webc" as any,
+      bundler: "vite",
+    },
+  },
+});

package/template/env

@@ -0,0 +1 @@
+VITE_BUNDLE_PATH="../../dist/bundle.esm.js"

package/template/gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
-src/generated
+src/generated
+.dev-server-port

package/template/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "{{INIT_PACKAGE_VAR_NAME}}",
+    "version": "0.0.1",
+    "ui5": {
+        "webComponentsPackage": true
+    },
+    "type": "module",
+    "scripts": {
+        "clean": "wc-dev clean",
+        "lint": "wc-dev lint",
+        "start": "wc-dev start",
+        "watch": "wc-dev watch",
+        "build": "wc-dev build",
+        {{INIT_PACKAGE_CYPRESS_TEST_COMMANDS}}
+        "create-ui5-element": "wc-create-ui5-element",
+        "prepublishOnly": "npm run build"
+    },
+    "exports": {
+        "./src/*": "./src/*",
+        "./dist/*": "./dist/*",
+        "./package.json": "./package.json",
+        "./bundle.js": "./bundle.js",
+        "./*": "./dist/*"
+    },
+    "dependencies": {
+        "@ui5/webcomponents-base": "{{INIT_PACKAGE_VERSION}}",
+        "@ui5/webcomponents-theming": "{{INIT_PACKAGE_VERSION}}"
+    },
+    "devDependencies": {
+        {{INIT_PACKAGE_CYPRESS_DEV_DEPS}}
+        "@ui5/webcomponents-tools": "{{INIT_PACKAGE_VERSION}}",
+        "chromedriver": "*",
+        "typescript": "^5.6.2"
+    }
+}

package/template/src/Assets.ts

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

package/template/src/MyFirstComponent.ts

@@ -6,10 +6,10 @@ import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
 import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
 
 // Template
-import INIT_PACKAGE_VAR_CLASS_NAMETemplate from "./INIT_PACKAGE_VAR_CLASS_NAMETemplate.js";
+import {{INIT_PACKAGE_VAR_CLASS_NAME}}Template from "./{{INIT_PACKAGE_VAR_CLASS_NAME}}Template.js";
 
 // Styles
-import INIT_PACKAGE_VAR_CLASS_NAMECss from "./generated/themes/INIT_PACKAGE_VAR_CLASS_NAME.css.js";
+import {{INIT_PACKAGE_VAR_CLASS_NAME}}Css from "./generated/themes/{{INIT_PACKAGE_VAR_CLASS_NAME}}.css.js";
 
 import { COUNT } from "./generated/i18n/i18n-defaults.js";
 
@@ -18,20 +18,20 @@ import { COUNT } from "./generated/i18n/i18n-defaults.js";
  *
  * <h3 class="comment-api-title">Overview</h3>
  *
- * The <code>INIT_PACKAGE_VAR_TAG</code> component is a demo component that displays some text.
+ * The <code>{{INIT_PACKAGE_VAR_TAG}}</code> component is a demo component that displays some text.
  *
  * @constructor
  * @extends UI5Element
  * @public
  */
 @customElement({
-	tag: "INIT_PACKAGE_VAR_TAG",
+	tag: "{{INIT_PACKAGE_VAR_TAG}}",
 	renderer: jsxRenderer,
-	styles: INIT_PACKAGE_VAR_CLASS_NAMECss,
-	template: INIT_PACKAGE_VAR_CLASS_NAMETemplate,
+	styles: {{INIT_PACKAGE_VAR_CLASS_NAME}}Css,
+	template: {{INIT_PACKAGE_VAR_CLASS_NAME}}Template,
 })
-class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
-	@i18n("INIT_PACKAGE_VAR_NAME")
+class {{INIT_PACKAGE_VAR_CLASS_NAME}} extends UI5Element {
+	@i18n("{{INIT_PACKAGE_VAR_NAME}}")
 	static i18nBundle: I18nBundle;
 
 	/**
@@ -47,10 +47,10 @@ class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
 	}
 
 	get counterText() {
-		return INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle.getText(COUNT);
+		return {{INIT_PACKAGE_VAR_CLASS_NAME}}.i18nBundle.getText(COUNT);
 	}
 }
 
-INIT_PACKAGE_VAR_CLASS_NAME.define();
+{{INIT_PACKAGE_VAR_CLASS_NAME}}.define();
 
-export default INIT_PACKAGE_VAR_CLASS_NAME;
+export default {{INIT_PACKAGE_VAR_CLASS_NAME}};

package/template/src/MyFirstComponentTemplate.tsx

@@ -1,6 +1,6 @@
-import type INIT_PACKAGE_VAR_CLASS_NAME from "./INIT_PACKAGE_VAR_CLASS_NAME.js";
+import type {{INIT_PACKAGE_VAR_CLASS_NAME}} from "./{{INIT_PACKAGE_VAR_CLASS_NAME}}.js";
 
-export default function INIT_PACKAGE_VAR_CLASS_NAMETemplate(this: INIT_PACKAGE_VAR_CLASS_NAME) {
+export default function {{INIT_PACKAGE_VAR_CLASS_NAME}}Template(this: {{INIT_PACKAGE_VAR_CLASS_NAME}}) {
 	return (
 		<div class="root" onClick={this.onClick}>
 			{this.counterText} :: {this.count}

package/template/{bundle.esm.js → src/bundle.esm.ts}

@@ -9,11 +9,12 @@ import { getNoConflict, setNoConflict } from "@ui5/webcomponents-base/dist/confi
 import { getFirstDayOfWeek } from "@ui5/webcomponents-base/dist/config/FormatSettings.js";
 
 // Enable additional themes and i18n texts
-import "./dist/Assets.js";
+import "./Assets.js";
 
-// Import your web components here from the dist/ directory
-import "./dist/INIT_PACKAGE_VAR_CLASS_NAME.js";
+// Import your web components here from the src/ directory
+import "./{{INIT_PACKAGE_VAR_CLASS_NAME}}.js";
 
+// @ts-expect-error
 window["sap-ui-webcomponents-bundle"] = {
 	renderFinished,
 	configuration: {

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

@@ -3,6 +3,7 @@ body {
 	background-color: var(--sapBackgroundColor);
 	font-size: var(--sapFontSize);
 	font-family: var(--sapFontFamily);
+	padding: 2rem;
 }
 
 h1 {
@@ -11,31 +12,78 @@ h1 {
 }
 
 h2 {
-	font-size: var(--sapFontHeader3Size);
-	margin-bottom: 0.5rem;
+	font-size: var(--sapFontHeader4Size);
+}
+
+a {
+	margin: 0.25rem;
+	padding: 0.5rem;
+}
+
+a.link {
+	color: var(--sapLinkColor);
 }
 
-.app, .app-settings, .app-docs, .app-first-component  {
+a.theme-link {
+	color: var(--sapButton_Emphasized_TextColor);
+	background-color: var(--sapButton_Emphasized_Background);
+	text-decoration: none;
+	border-radius: 0.25rem;
+}
+
+a.lang-link {
+	color: var(--sapButton_Attention_TextColor);
+	background-color: var(--sapButton_Attention_Background);
+	text-decoration: none;
+	border-radius: 0.25rem;
+}
+
+.app {
 	display: flex;
-	align-items: center;
-	justify-content: center;
 	flex-direction: column;
+	align-items: center;
+}
+
+.app-nav {
+	display: flex;
+	width: 100%;
+	flex-direction: row;
+	justify-content: flex-end;
 }
 
 .app-logo {
-	height: 230px;
-	width: 230px;
+	height: 5rem;
+	width: 5rem;
 }
 
-.app-first-component {
-	margin-bottom: 3rem;
+.app-header {
+	display: flex;
+	flex-direction: row;
+	align-items: center;
 }
 
-.app-docs {
-	margin-top: 3rem;
+.app-main {
+	display: flex;
+	flex-direction: row;
+	align-items: flex-start;
+	padding-top: 2rem;
 }
 
-a {
-	margin: 0.25rem;
-	color: var(--sapLinkColor);
+.app-main-demo {
+	padding: 2rem;
+	border-radius: 0.5rem;
+	box-sizing: border-box;
+	background-color: var(--sapTile_Background);
+}
+
+.app-main-settings  {
+	display: flex;
+	flex-direction: column;
+	padding: 0 2rem;
+}
+
+@media (max-width: 768px) {
+	.app-main {
+		flex-direction: column;
+	}
 }

package/template/test/pages/index.html

@@ -1,57 +1,53 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 
 <head>
 	<meta charset="utf-8">
-
-	<title>INIT_PACKAGE_VAR_TAG</title>
+	<title>UI5 Web Components</title>
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<meta charset="utf-8">
-
-	<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>
+	<script src="%VITE_BUNDLE_PATH%" type="module"></script>
 </head>
 
 <body>
 	<div class="app">
-		<a href="https://sap.github.io/ui5-webcomponents/docs/getting-started/first-steps/" target="_blank"><img src="./img/logo.png" class="app-logo" 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>
+		<nav class="app-nav">
+			<a class="link" href="https://sap.github.io/ui5-webcomponents/">Website</a>
+			<a class="link" href="https://sap.github.io/ui5-webcomponents/components/">Components</a>
+			<a class="link" href="https://sap.github.io/ui5-webcomponents/docs/development/package/">Development</a>
+		</nav>
+
+		<header class="app-header">
+			<a href="https://sap.github.io/ui5-webcomponents/" target="_blank"><img src="./img/logo.png" class="app-logo" alt="logo"/></a>
+			<h1>UI5 Web Components</h1>
+		</header>
+		
+		<main class="app-main">
+			<div class="app-main-demo">
+				<h2>Congrats! It's your First Web Component 🎉</h2>
+				<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>
 
-			<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 class="app-main-settings">
+				<h3>Switch theme</h3>
+				<div style="display: grid; grid-template-columns: 1fr 1fr;">
+					<a class="link theme-link" href="?sap-ui-theme=sap_horizon">Horizon Morning</a>
+					<a class="link theme-link" href="?sap-ui-theme=sap_horizon_dark">Horizon Evening</a>
+					<a class="link theme-link" href="?sap-ui-theme=sap_horizon_hcb">High Contrast Black</a>
+					<a class="link theme-link" href="?sap-ui-theme=sap_horizon_hcw">High Contrast White</a>
+				</div>
+			
+				<h3>Switch language</h3>
+				<div style="display: grid; grid-template-columns: 1fr 1fr;">
+					<a class="link lang-link" href="?sap-ui-language=en">English</a>
+					<a class="link lang-link" href="?sap-ui-language=de">German</a>
+					<a class="link lang-link" href="?sap-ui-language=es">Spanish</a>
+					<a class="link lang-link" href="?sap-ui-language=fr">French</a>
+				</div>
 			</div>
-		</div>
-
-		<div class="app-docs">
-			<h2>Documentation</h2>
-			<a class="link" href="https://sap.github.io/ui5-webcomponents/docs/development/custom-UI5-Web-Components-Packages/">Custom Component Development</a>
-		</div>
+		</main>
 	</div>
 </body>
 </html>

package/template/{tsconfig.json → tsconfig.template.json}

@@ -5,9 +5,10 @@
 		"global.d.ts"
 	],
 	"compilerOptions": {
+		{{INIT_PACKAGE_CYPRESS_ROOT_TSCONFIG}}
 		"outDir": "dist",
 		"experimentalDecorators": true,
 		"module": "NodeNext",
-		"moduleResolution": "NodeNext",
+		"moduleResolution": "NodeNext"
 	},
 }

package/template/config/wdio.conf.cjs

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

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

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

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

@@ -1,13 +0,0 @@
-import { assert } from "chai";
-
-describe("INIT_PACKAGE_VAR_TAG rendering", async () => {
-	before(async () => {
-		await browser.url("test/pages/index.html");
-	});
-
-	it("tests if web component is correctly rendered", async () => {
-		const innerContent = await browser.$("#myFirstComponent").shadow$("div");
-
-		assert.ok(innerContent, "content rendered");
-	});
-});