feat(create): add --workspace-install flag

README.md

@@ -17,7 +17,7 @@ Serverless functions allow developers to quickly implement and deploy functional
 ## Install
 
 ```bash
-$ npm install -g kazi
+npm i -g @kazi-faas/cli
 ```
 
 ## Pre-requisite
@@ -26,21 +26,26 @@ $ npm install -g kazi
 2. pack CLI
 3. Node 16.3.x (some commands may not run smoothly in versions below 16)
 
+## Getting Started
+
+> TODO: A short guide that shows the concept so users can get started on the topic in under 10 minutes.
+
 ## CLI
 
 ```
 Commands
   $ kazi create: Scaffold a new project
   $ kazi list: List the functions deployed using kazi
   $ kazi deploy: Deploy a function (only works if you're inside the function's directory)
-	$ kazi --help: Show help text
+  $ kazi --help: Show help text
 
 Usage
   $ kazi create <Function_Name>
 
 Options
   --registry (-r),  Your registry namespace
-	--use-yarn, Use Yarn to install dependencies
+	--use-yarn, Use Yarn to install dependencies (default: false)
+	--workspace-install, Used to install the dependencies in a workspace i.e using the workspace's node_modules(default: false).
 
 Examples
   $ kazi create hello --registry=docker.io/pmbanugo

source/cli.tsx

@@ -16,6 +16,10 @@ const cli = meow(helpText, {
 			type: "boolean",
 			default: false,
 		},
+		workspaceInstall: {
+			type: "boolean",
+			default: false,
+		},
 	},
 });
 

source/commands/create-project.ts

@@ -1,11 +1,16 @@
 import degit from "degit";
-import { install as pkgInstall } from "pkg-install";
+import { projectInstall } from "pkg-install";
 import { join } from "path";
 import { writeFile } from "fs/promises";
 
+function stripPath(name: string) {
+	//removes directory name if it's included.
+	return name.split("/").pop();
+}
+
 export async function createConfigFile(name: string, registry: string) {
 	const config = {
-		name,
+		name: stripPath(name),
 		registry,
 	};
 	await writeFile(
@@ -14,16 +19,22 @@ export async function createConfigFile(name: string, registry: string) {
 	);
 }
 
-async function createPkgJson(name: string) {
+export async function createPkgJson(name: string) {
 	const pkg = {
-		name,
+		name: stripPath(name),
 		description: "A function which responds to HTTP requests",
 		main: "index.js",
 		scripts: {
 			start: "micro",
 			dev: "micro-dev",
 			deploy: "kazi deploy",
 		},
+		dependencies: {
+			micro: "^9.3.4",
+		},
+		devDependencies: {
+			"micro-dev": "^3.0.0",
+		},
 	};
 
 	await writeFile(
@@ -46,29 +57,16 @@ export const clone = async (name: string) => {
 	await emitter.clone(`./${name}`);
 };
 
-export const install = async (name: string, useYarn: boolean = false) => {
+export const install = async (
+	name: string,
+	useYarn: boolean,
+	workspaceInstall: boolean
+) => {
 	const pkgManager = useYarn ? "yarn" : "npm";
-
-	await createPkgJson(name);
 	const dir = join(process.cwd(), name);
 
-	await pkgInstall(
-		{
-			micro: "^9.3.4",
-		},
-		{
-			cwd: dir,
-			prefer: pkgManager,
-		}
-	);
-	await pkgInstall(
-		{
-			"micro-dev": "^3.0.0",
-		},
-		{
-			cwd: dir,
-			prefer: pkgManager,
-			dev: true,
-		}
-	);
+	await projectInstall({
+		cwd: workspaceInstall ? undefined : dir,
+		prefer: pkgManager,
+	});
 };

source/components/Create.tsx

@@ -1,7 +1,12 @@
 import React, { FC, useEffect, useState } from "react";
 import { TaskList, Task } from "ink-task-list";
 import { useInput, Text } from "ink";
-import { clone, install, createConfigFile } from "../commands/create-project";
+import {
+	clone,
+	install,
+	createConfigFile,
+	createPkgJson,
+} from "../commands/create-project";
 
 type State = "pending" | "loading" | "success" | "warning" | "error";
 type List = Record<"install" | "create", { label: string; state: State }>;
@@ -37,7 +42,8 @@ const Create: FC<{
 	input: string[];
 	registryFlag?: string;
 	useYarn?: boolean;
-}> = ({ input, registryFlag, useYarn }) => {
+	workspaceInstall?: boolean;
+}> = ({ input, registryFlag, useYarn, workspaceInstall }) => {
 	const [tasks, setTasks] = useState<List>({
 		create: { label: "Create the project", state: "loading" },
 		install: { label: "Install project's dependencies", state: "pending" },
@@ -51,13 +57,14 @@ const Create: FC<{
 			if (name && registry && tasks.create.state === "loading") {
 				await clone(name);
 				await createConfigFile(name, registry);
+				await createPkgJson(name);
 
 				setTasks((state) => ({
 					create: { ...state.create, state: "success" },
 					install: { ...state.install, state: "loading" },
 				}));
 
-				await install(name, useYarn);
+				await install(name, Boolean(useYarn), Boolean(workspaceInstall));
 				setTasks((state) => ({
 					...state,
 					install: { ...state.install, state: "success" },

source/components/Deploy.tsx

@@ -56,7 +56,6 @@ const Deploy: FC = () => {
 						deploy: { ...state.deploy, state: "success" },
 					}));
 				} catch (error) {
-					console.log({ error });
 					setTasks((state) => ({
 						...state,
 						deploy: { ...state.deploy, state: "error" },

source/meow-util.ts

@@ -10,7 +10,8 @@ Usage
 
 Options
   --registry (-r),  Your registry namespace
-	--use-yarn, Use Yarn to install dependencies
+	--use-yarn, Use Yarn to install dependencies (default: false)
+	--workspace-install, Used to install the dependencies in a workspace i.e using the workspace's node_modules(default: false).
 
 Examples
   $ kazi create hello --registry=docker.io/pmbanugo

source/ui.tsx

@@ -16,6 +16,9 @@ const App: FC<{
 		useYarn: {
 			type: "boolean";
 		};
+		workspaceInstall: {
+			type: "boolean";
+		};
 	}>;
 }> = ({ input, flags }) => {
 	if (input.length === 2 && input[0] === "create") {
@@ -24,6 +27,7 @@ const App: FC<{
 				input={input}
 				registryFlag={flags?.registry}
 				useYarn={flags?.useYarn}
+				workspaceInstall={flags?.workspaceInstall}
 			/>
 		);
 	}