@ui5/create-webcomponents-package 0.0.4 → 0.0.8

package/README.md

@@ -5,7 +5,22 @@
 [![Travis CI Build Status](https://travis-ci.org/SAP/ui5-webcomponents.svg?branch=master)](https://travis-ci.org/SAP/ui5-webcomponents)
 [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fwebcomponents.svg)](https://www.npmjs.com/package/@ui5/webcomponents)
 
-Provides a create script for a new UI5 Webcomponents Package 
+Provides an `npm init` script for creating new UI5 Webcomponents Packages
+
+## Usage
+
+with `npm`
+
+- `npm init @ui5/webcomponents-package` (the user will be asked for **name**, **port**, **tag**)
+- `npm init @ui5/webcomponents-package <NEW-PACKAGE-NAME>` (the user will be asked for **port** and **tag** only)
+
+and with `yarn`
+
+- `yarn create @ui5/webcomponents-package`
+- `yarn create @ui5/webcomponents-package <NEW-PACKAGE-NAME>`
+
+The script creates a new directory, and fills it with a `package.json` file and all necessary source files and resources for a new
+components package.
 
 ## Resources
 - [UI5 Web Components - README.md](https://github.com/SAP/ui5-webcomponents/blob/master/README.md)

package/{lib/init-package/index.js → index.js}

@@ -1,8 +1,13 @@
+#!/usr/bin/env node
+
 const fs = require("fs");
 const path = require("path");
 const mkdirp = require("mkdirp");
 const prompts = require("prompts");
-const beautify = require("json-beautify");
+const parser = require("npm-config-user-agent-parser");
+
+// from where all the files will be copied
+const TEMPLATE_DIR = path.join(`${__dirname}`, `template/`);
 
 // String utils
 const capitalizeFirst = str => str.substr(0,1).toUpperCase() + str.substr(1);
@@ -36,27 +41,24 @@ const copyFile = (vars, sourcePath, destPath) => {
 	content = replaceVarsInFileContent(vars, content);
 	destPath = replaceVarsInFileName(vars, destPath);
 	fs.writeFileSync(destPath, content);
-	console.log(destPath);
 };
 
-const copyResources = (vars, sourcePath, destPath) => {
+const copyFiles = (vars, sourcePath, destPath) => {
 	const isDir = fs.lstatSync(sourcePath).isDirectory();
 	if (isDir) {
 		if (destPath) {
 			mkdirp.sync(destPath);
 		}
 		fs.readdirSync(sourcePath).forEach(file => {
-			copyResources(vars, path.join(sourcePath, file), path.join(destPath, file));
+			copyFiles(vars, path.join(sourcePath, file), path.join(destPath, file));
 		});
 	} else {
 		copyFile(vars, sourcePath, destPath);
 	}
 };
 
-// from where all the files will be copied
-const RESOURCES_DIR = path.join(`${__dirname}`, `resources/`);
-
-const initPackage = async () => {
+// Main function
+const createWebcomponentsPackage = async () => {
 	let response;
 
 	// Get the name
@@ -66,7 +68,7 @@ const initPackage = async () => {
 		response = await prompts({
 			type: "text",
 			name: "name",
-			message: `Enter the name of the new package\n A directory with this name will be created, and this will be the "name" field in "package.json":`,
+			message: "Package name:",
 			validate: isNameValid,
 		});
 		name = response.name;
@@ -76,7 +78,7 @@ const initPackage = async () => {
 	response = await prompts({
 		type: "text",
 		name: "port",
-		message: "Choose the port where the test server will run\n Press Enter for default:",
+		message: "Dev server port:",
 		validate: isPortValid,
 		initial: "8080",
 	});
@@ -86,7 +88,7 @@ const initPackage = async () => {
 	response = await prompts({
 		type: "text",
 		name: "tag",
-		message: "Enter the name of your first component (must contain at least one dash)\n Press Enter for default:",
+		message: "Demo component name:",
 		initial: "my-first-component",
 		validate: isTagValid,
 	});
@@ -128,11 +130,11 @@ const initPackage = async () => {
 			"./*": "./dist/*",
 		},
 		"dependencies": {
-			"@ui5/webcomponents-base": "*",
-			"@ui5/webcomponents-theme-base": "*",
+			"@ui5/webcomponents-base": "1.0.0-rc.15",
+			"@ui5/webcomponents-theme-base": "1.0.0-rc.15",
 		},
 		"devDependencies": {
-			"@ui5/webcomponents-tools": "*",
+			"@ui5/webcomponents-tools": "1.0.0-rc.15",
 			"chromedriver": "*",
 		},
 	};
@@ -140,14 +142,27 @@ const initPackage = async () => {
 	// Update package.json
 	const destDir = path.join(`./`, name);
 	mkdirp.sync(destDir);
-	fs.writeFileSync(path.join(destDir, "package.json"), beautify(packageContent, null, 2, 100));
+	fs.writeFileSync(path.join(destDir, "package.json"), JSON.stringify(packageContent, null, 2));
 	// Copy files
-	copyResources(vars, RESOURCES_DIR, destDir);
+	copyFiles(vars, TEMPLATE_DIR, destDir);
+
+	console.log("\nPackage successfully created!\nNext steps:\n");
+	console.log(`$ cd ${name}`);
+
+	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`);
+	}
 
-	console.log("Package successfully initialized.\n\n");
-	console.log(`cd ${name}`);
-	console.log(`npm i`);
-	console.log(`npm start\n\n`);
+	console.log("\n");
 };
 
-initPackage();
+createWebcomponentsPackage();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/create-webcomponents-package",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "UI5 Web Components: create package",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -10,9 +10,8 @@
     "sapui5",
     "ui5"
   ],
-  "scripts": {},
   "bin": {
-    "create-webcomponents-package": "bin/init-ui5-package.js"
+    "create-webcomponents-package": "index.js"
   },
   "repository": {
     "type": "git",
@@ -20,9 +19,8 @@
     "directory": "packages/create-package"
   },
   "dependencies": {
-    "json-beautify": "^1.1.1",
     "mkdirp": "^1.0.4",
+    "npm-config-user-agent-parser": "^1.0.0",
     "prompts": "^2.4.1"
-  },
-  "peerDependencies": {}
+  }
 }