@ui5/create-webcomponents-package 0.0.0-b93bc8b37 → 0.0.0-c0e494b02

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.14.0-rc.1](https://github.com/SAP/ui5-webcomponents/compare/v1.14.0-rc.0...v1.14.0-rc.1) (2023-05-25)
+
+**Note:** Version bump only for package @ui5/create-webcomponents-package
+
+
+
+
+
+# [1.14.0-rc.0](https://github.com/SAP/ui5-webcomponents/compare/v1.13.2...v1.14.0-rc.0) (2023-05-18)
+
+
+### Features
+
+* users can provide a JSDoc namespeace when creating a package ([#7034](https://github.com/SAP/ui5-webcomponents/issues/7034)) ([0af8d23](https://github.com/SAP/ui5-webcomponents/commit/0af8d2376e25e5abe6d940c72286ab7c682eea56))
+
+
+
+
+
+## [1.13.1](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.5...v1.13.1) (2023-05-11)
+
+
+### Bug Fixes
+
+* **create-package:** revert  `moduleResolution` setting to `node` ([#7020](https://github.com/SAP/ui5-webcomponents/issues/7020)) ([9fc84e2](https://github.com/SAP/ui5-webcomponents/commit/9fc84e288452616ee72f3a2b6fc31d9752f05f6f))
+
+
+
+
+
+# [1.13.0-rc.5](https://github.com/SAP/ui5-webcomponents/compare/v1.13.0-rc.4...v1.13.0-rc.5) (2023-05-11)
+
+
+### 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

@@ -16,13 +16,6 @@ const version = JSON.parse(fs.readFileSync(path.join(__dirname, "package.json"))
 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));
 };
@@ -38,8 +31,10 @@ const isNPMRC = sourcePath => {
 
 // Validation of user input
 const ComponentNamePattern = /^[A-Z][A-Za-z0-9]+$/;
-const isNameValid = name => typeof name === "string" && name.match(/^[a-zA-Z0-9\-_]+$/);
+const NamespacePattern = /^[a-z][a-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 isNamespaceValid = name => typeof name === "string" && NamespacePattern.test(name);
 const isTagValid = tag => typeof tag === "string" && tag.match(/^[a-z0-9]+?-[a-zA-Z0-9\-_]+?[a-z0-9]$/);
 
 /**
@@ -105,17 +100,20 @@ const copyFiles = (vars, sourcePath, destPath) => {
 	}
 };
 
-const generateFilesContent = (name, componentName, tagName, typescript, skipSubfolder) => {
+const generateFilesContent = (packageName, componentName, namespace, 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_NAMESPACE: namespace, // namespace must be replaced before name
+		INIT_PACKAGE_VAR_NAME: packageName,
 		INIT_PACKAGE_VAR_TAG: tagName,
 		INIT_PACKAGE_VAR_CLASS_NAME: componentName,
 		INIT_PACKAGE_VAR_TYPESCRIPT: typescript,
 	};
 
 	const packageContent = {
-		name,
+		packageName,
 		version: "0.0.1",
 		ui5: {
 			webComponentsPackage: true,
@@ -152,14 +150,16 @@ const generateFilesContent = (name, componentName, tagName, typescript, skipSubf
 	}
 
 	// Update package.json
-	const destDir = skipSubfolder ? path.join("./") : 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 {
@@ -180,26 +180,30 @@ const generateFilesContent = (name, componentName, tagName, typescript, skipSubf
 // 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.namespace && !isNamespaceValid(argv.namespace)) {
+		throw new Error("The JSDoc namespace must start with a letter and can only contain small-case letters, numbers, dots and dashes.");
+	}
+
 	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.");
 	}
 
-	let name = argv.name || "my-package";
+	let packageName = argv.name || "my-package";
 	let componentName = argv.componentName || "MyComponent";
+	let namespace = argv.namespace || "demo.components";
 	let typescriptSupport = !!argv.enableTypescript;
-	const tagName = argv.tag || hyphaneteComponentName(componentName);
 	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(name, componentName, tagName, typescriptSupport, skipSubfolder);
+		return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
 	}
 
 	if (!argv.name) {
@@ -207,9 +211,9 @@ const createWebcomponentsPackage = async () => {
 			type: "text",
 			name: "name",
 			message: "Package name:",
-			validate: isNameValid,
+			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, _, -].",
 		});
-		name = response.name;
+		packageName = response.name;
 	}
 
 	if (!typescriptSupport) {
@@ -237,12 +241,23 @@ const createWebcomponentsPackage = async () => {
 			name: "componentName",
 			message: "Component name:",
 			initial: "MyComponent",
-			validate: isComponentNameValid,
+			validate: (value) => isComponentNameValid(value) ? true : "Component name should follow PascalCase naming convention (f.e. Button, MyButton, etc.).",
 		});
 		componentName = response.componentName;
 	}
 
-	return generateFilesContent(name, componentName, tagName, typescriptSupport, skipSubfolder);
+	if (!argv.namespace) {
+		response = await prompts({
+			type: "text",
+			name: "namespace",
+			message: "JSDoc namespace:",
+			initial: "demo.components",
+			validate: (value) => isNamespaceValid(value) ? true : "The JSDoc namespace must start with a letter and can only contain small-case letters, numbers, dots and dashes.",
+		});
+		namespace = response.namespace;
+	}
+
+	return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
 };
 
 createWebcomponentsPackage();

package/package.json

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

package/template/src/MyFirstComponent.js

@@ -31,7 +31,7 @@ const metadata = {
  * 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
+ * @alias INIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME
  * @extends sap.ui.webc.base.UI5Element
  * @tagname INIT_PACKAGE_VAR_TAG
  * @public

package/template/src/MyFirstComponent.ts

@@ -20,7 +20,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
+ * @alias INIT_PACKAGE_VAR_NAMESPACE.INIT_PACKAGE_VAR_CLASS_NAME
  * @extends sap.ui.webc.base.UI5Element
  * @tagname INIT_PACKAGE_VAR_TAG
  * @public

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;
-	}
-}