@ui5/create-webcomponents-package 0.0.0-2514bd09f → 0.0.0-2c875c3d3

package/create-package.js

@@ -1,217 +1,217 @@
 #!/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/`);
-
-// String utils
-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");
+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 = {
+	[path.normalize("eslintignore")]: path.normalize(".eslintignore"),
+	[path.normalize("eslintrc.cjs")]: path.normalize(".eslintrc.cjs"),
+	[path.normalize("gitignore")]: path.normalize(".gitignore"),
+	[path.normalize("npmignore")]: path.normalize(".npmignore"),
+	[path.normalize("npsrc.json")]: path.normalize(".npsrc.json"),
+	[path.normalize("npmrc")]: path.normalize(".npmrc"),
+	[path.normalize("env")]: path.normalize(".env"),
+	[path.normalize("tsconfig.template.json")]: path.normalize("tsconfig.json"),
+	[path.normalize("cypress/tsconfig.template.json")]: path.normalize("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 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]$/);
+	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 replacePlaceholders = (content, replacements) =>
+	content.replace(/{{(.*?)}}/g, (_, key) => replacements[key.trim()] || "");
 
-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) {
-		return;
-	}
-
-	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 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, namespace, typescript, 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_NAMESPACE: namespace, // namespace must be replaced before name
 		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_VAR_TYPESCRIPT: typescript,
-	};
-
-	const packageContent = {
-		name: packageName,
-		version: "0.0.1",
-		ui5: {
-			webComponentsPackage: true,
-		},
-		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": "*",
-		},
+		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.*` : "",
 	};
 
-	if (typescript) {
-		packageContent.devDependencies.typescript = "^4.9.4";
-	}
-
-	// 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}`);
+	console.log(`$ cd ${packageBaseName}`);
 
-	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
-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].");
-	}
+async function processFiles(destDir, replacements, testSetup) {
+	const files = await collectFiles(SRC_DIR);
+	const FILE_PATHS_TO_SKIP = [
+		testSetup !== "cypress" ? path.normalize("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);
+		}
 
-	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.");
+		// console.log(`Processed: ${file} -> ${destPath}`);
 	}
+}
 
-	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.");
+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.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 namespace = argv.namespace || "demo.components";
-	let typescriptSupport = !!argv.enableTypescript;
+	let componentName = "MyFirstComponent";
+	let testSetup = argv.testSetup || "manual";
 	const skipSubfolder = !!argv.skipSubfolder;
 
 	if (argv.skip) {
-		return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
+		return generateFilesContent(
+			packageName,
+			componentName,
+			skipSubfolder,
+			testSetup,
+		);
 	}
 
 	if (!argv.name) {
@@ -219,53 +219,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 (!typescriptSupport) {
+	if (!argv.testSetup) {
 		response = await prompts({
 			type: "select",
-			name: "language",
-			message: "Project type:",
+			name: "testSetup",
+			message: "How would you like to set up testing?",
 			choices: [
-				{
-					title: "JavaScript",
-					value: false,
-				},
-				{
-					title: "TypeScript",
-					value: true,
-				},
+				{ title: "Cypress", value: "cypress" },
+				{ title: "I'll set it up manually", value: "manual" },
 			],
+			initial: 0,
 		});
-		typescriptSupport = response.language;
-	}
 
-	if (!argv.componentName) {
-		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.).",
-		});
-		componentName = response.componentName;
-	}
-
-	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;
+		testSetup = response.testSetup;
 	}
 
-	return generateFilesContent(packageName, componentName, namespace, typescriptSupport, skipSubfolder);
+	return generateFilesContent(
+		packageName,
+		componentName,
+		skipSubfolder,
+		testSetup,
+	);
 };
 
 createWebcomponentsPackage();

package/package.json

@@ -1,27 +1,28 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "0.0.0-2514bd09f",
+  "version": "0.0.0-2c875c3d3",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
-  "private": false,
+  "type": "module",
   "keywords": [
     "openui5",
     "sapui5",
     "ui5"
   ],
-  "bin": {
-    "create-webcomponents-package": "create-package.js"
-  },
+  "bin": "create-package.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/SAP/ui5-webcomponents.git",
+    "url": "https://github.com/UI5/webcomponents.git",
     "directory": "packages/create-package"
   },
   "dependencies": {
+    "chokidar-cli": "^3.0.0",
     "mkdirp": "^1.0.4",
     "npm-config-user-agent-parser": "^1.0.0",
+    "prettier": "^3.5.3",
     "prompts": "^2.4.1",
     "yargs": "^17.5.1"
-  }
-}
+  },
+  "gitHead": "3c5b1e24f98e272076d97aedee53e66b3d5d1836"
+}

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/{.eslintignore → eslintignore}

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

package/template/gitignore

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