@ui5/create-webcomponents-package 0.0.0-2f7664755 → 0.0.0-354b6d238

package/CHANGELOG.md

@@ -3,6 +3,124 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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
+
+
+
+
+
+# [1.13.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.1...v1.13.0-rc.2) (2023-04-20)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.13.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.0...v1.13.0-rc.1) (2023-04-13)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.13.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0...v1.13.0-rc.0) (2023-04-06)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.12.0](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.3...v1.12.0) (2023-04-04)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.12.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.2...v1.12.0-rc.3) (2023-03-30)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.12.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.1...v1.12.0-rc.2) (2023-03-23)
+
+
+### Bug Fixes
+
+* inline sources in the .map file so the src folder is not mandatory ([#6732](https://github.com/SAP/ui5-webcomponents/issues/6732)) ([16771a6](https://github.com/SAP/ui5-webcomponents/commit/16771a64d7b13f418af9afa1a03b224fe3762775))
+
+
+
+
+
+# [1.12.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.12.0-rc.0...v1.12.0-rc.1) (2023-03-16)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.12.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0...v1.12.0-rc.0) (2023-03-09)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.11.0](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.4...v1.11.0) (2023-03-06)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.11.0-rc.4](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.3...v1.11.0-rc.4) (2023-03-02)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.11.0-rc.3](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.2...v1.11.0-rc.3) (2023-02-23)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.11.0-rc.2](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.1...v1.11.0-rc.2) (2023-02-16)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.11.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.11.0-rc.0...v1.11.0-rc.1) (2023-02-09)
+
+
+### Features
+
+* **framework:** add option to define package name, tag and typescript support from CLI ([#6379](https://github.com/SAP/ui5-webcomponents/issues/6379)) ([687c0f7](https://github.com/SAP/ui5-webcomponents/commit/687c0f7a420a72f77f294ace2898223c48708ae2)), closes [#6382](https://github.com/SAP/ui5-webcomponents/issues/6382)
+
+
+
+
+
 # [1.11.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.10.4-rc.0...v1.11.0-rc.0) (2023-02-02)
 
 **Note:** Version bump only for package @ui5/create-webcomponents-package

package/README.md

@@ -13,13 +13,14 @@ Usage:
 
 # npm 6.x
     npm init @ui5/webcomponents-package [OPTIONS]
-# npm 7+, extra double-dash is needed:
+# npm 7+, an extra double-dash is needed:
     npm init @ui5/webcomponents-package -- [OPTIONS]
 
 Options:
-    --name <string>     - defines package name
-    --tag <string>      - defines predefined custom element tag name
-    --enable-typescript - enables TypeScript support to the package
+    --name <string>     - defines the package name
+    --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
 ```
 
@@ -32,10 +33,10 @@ components package.
 Usage:
     yarn create @ui5/webcomponents-package [OPTIONS]
 Options:
-    --name <string>     - defines package name
-    --tag <string>      - defines predefined custom element tag name
-    --enable-typescript - enables TypeScript support to the package
-    --skip              - skips all configurations and generates package with default configurations
+    --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
+    --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

@@ -5,8 +5,8 @@ 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');
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
 
 const argv = yargs(hideBin(process.argv)).argv;
 
@@ -23,14 +23,36 @@ const toCamelCase = parts => {
 		return index === 0 ? string.toLowerCase() : string.charAt(0).toUpperCase() + string.slice(1).toLowerCase();
 	}).join("");
 };
-const isTypescriptRelatedFile = sourcePath => {
-	return ["Аssets.ts", "MyFirstComponent.ts", "tsconfig.json", "global.d.ts"].some(fileName => sourcePath.includes(fileName));
-}
+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 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 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) {
@@ -45,17 +67,28 @@ const replaceVarsInFileName = (vars, fileName) => {
 };
 
 const copyFile = (vars, sourcePath, destPath) => {
-	const ignoreJsRelated = vars.INIT_PACKAGE_VAR_TYPESCRIPT && sourcePath.includes("MyFirstComponent.js")
-	const ignoreTsRelated = !vars.INIT_PACKAGE_VAR_TYPESCRIPT && isTypescriptRelatedFile(sourcePath)
+	const ignoreJsRelated = vars.INIT_PACKAGE_VAR_TYPESCRIPT && isJSRelatedFile(sourcePath);
+	const ignoreTsRelated = !vars.INIT_PACKAGE_VAR_TYPESCRIPT && isTSRelatedFile(sourcePath);
 
 	if (ignoreJsRelated || ignoreTsRelated) {
 		return;
 	}
 
-	let content = fs.readFileSync(sourcePath, {encoding: "UTF-8"});
+	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 copyFiles = (vars, sourcePath, destPath) => {
@@ -72,16 +105,15 @@ 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_TYPESCRIPT: typescript
+		INIT_PACKAGE_VAR_TAG: tagName,
+		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
+		INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
 	};
 
 	const packageContent = {
@@ -117,8 +149,12 @@ const generateFilesContent = (name, tag, typescript) => {
 		},
 	};
 
+	if (typescript) {
+		packageContent.devDependencies.typescript = "^4.9.4";
+	}
+
 	// 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
@@ -141,25 +177,30 @@ const generateFilesContent = (name, tag, typescript) => {
 	}
 
 	console.log("\n");
-}
+};
 
 // 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).");
+		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);
+	if (argv.skip) {
+		return generateFilesContent(name, componentName, typescriptSupport, skipSubfolder);
 	}
 
 	if (!argv.name) {
@@ -167,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;
 	}
@@ -186,23 +227,23 @@ const createWebcomponentsPackage = async () => {
 					title: "TypeScript",
 					value: true,
 				},
-			]
+			],
 		});
-		typescript = response.language;
+		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, typescript);
+	return generateFilesContent(name, componentName, typescriptSupport, skipSubfolder);
 };
 
 createWebcomponentsPackage();

package/package.json

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

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/gitignore

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

package/template/npmrc

@@ -0,0 +1,2 @@
+# Auto detect the chromedriver version
+detect_chromedriver_version=true

package/template/src/MyFirstComponent.ts

@@ -25,22 +25,15 @@ import { PLEASE_WAIT } from "./generated/i18n/i18n-defaults.js";
  * @tagname INIT_PACKAGE_VAR_TAG
  * @public
  */
-@customElement("INIT_PACKAGE_VAR_TAG")
+@customElement({
+	tag: "INIT_PACKAGE_VAR_TAG",
+	renderer: litRender,
+	styles: INIT_PACKAGE_VAR_CLASS_NAMECss,
+	template: INIT_PACKAGE_VAR_CLASS_NAMETemplate,
+})
 class INIT_PACKAGE_VAR_CLASS_NAME extends UI5Element {
 	static i18nBundle: I18nBundle;
 
-	static get render() {
-		return litRender;
-	}
-
-	static get template() {
-		return INIT_PACKAGE_VAR_CLASS_NAMETemplate;
-	}
-
-	static get styles() {
-		return INIT_PACKAGE_VAR_CLASS_NAMECss;
-	}
-
 	static async onDefine() {
 		INIT_PACKAGE_VAR_CLASS_NAME.i18nBundle = await getI18nBundle("INIT_PACKAGE_VAR_NAME");
 	}

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/test/specs/Demo.spec.js

@@ -1,7 +1,9 @@
 const assert = require("assert");
 
 describe("INIT_PACKAGE_VAR_TAG rendering", async () => {
-	await browser.url("test/pages/index.html");
+	before(async () => {
+		await browser.url("test/pages/index.html");
+	});
 
 	it("tests if web component is correctly rendered", async () => {
 

package/template/tsconfig.json

@@ -7,6 +7,7 @@
       "outDir": "dist",
       "skipLibCheck": true,
       "sourceMap": true,
+      "inlineSources": true,
       "strict": true,
       "moduleResolution": "node",
       "experimentalDecorators": true,

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

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