Merge pull request #4 from alexlee-dev/v0.4.0

📦 v0.4.0

Author: Alex Lee

CHANGELOG.md

@@ -5,6 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2020-05-27
+
+### ✨ Interactivity
+
+### Added
+
+- Interactive option. Use the flag `--interactive` to use this mode
+- Comments :)
+- Cleanup on global error
+- Option for Author Name
+- Validation of application name according to NPM conventions
+
+### Changed
+
+- Refactored `copyTemplateFiles()`
+
+### Removed
+
+### Fixed
+
 ## [0.3.0] - 2020-05-26
 
 ### ✏️ Application Name in Template Files

README.md

@@ -68,6 +68,7 @@ Want support for an additional language? Feel free to open a [new issue](https:/
 - [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner.
 - [pickitt](https://pickitt.netlify.com/) - When you need a computer to just pick it, reach for Pickitt!
 - [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript.
+- [validate-npm-package-name](https://github.com/npm/validate-npm-package-name) - Is the given string an acceptable npm package name?
 
 ## ✍️ Authors <a name = "authors"></a>
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cli-application",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A bootstrapper for creating a cli application with Node.",
   "bin": {
     "create-cli-application": "./index.js"
@@ -38,6 +38,7 @@
     "@types/fs-extra": "^9.0.1",
     "@types/inquirer": "^6.5.0",
     "@types/node": "^14.0.5",
+    "@types/validate-npm-package-name": "^3.0.0",
     "@types/yargs": "^15.0.5",
     "copyfiles": "^2.2.0",
     "typescript": "^3.9.3"
@@ -52,6 +53,7 @@
     "fs-extra": "^9.0.0",
     "inquirer": "^7.1.0",
     "ora": "^4.0.4",
-    "pickitt": "^3.2.0"
+    "pickitt": "^3.2.0",
+    "validate-npm-package-name": "^3.0.0"
   }
 }

package.json

@@ -1,3 +1,6 @@
+/**
+ * These dependencies are required for the cli application regardless of language.
+ */
 export const dependencies = [
   "boxen",
   "chalk",
@@ -7,6 +10,9 @@ export const dependencies = [
   "pickitt",
 ];
 
+/**
+ * These dev dependencies are for JavaScript projects.
+ */
 export const devDependencies = [
   "@babel/core",
   "@babel/cli",
@@ -15,6 +21,9 @@ export const devDependencies = [
   "@babel/runtime",
 ];
 
+/**
+ * These dev dependencies are for TypeScript projects.
+ */
 export const devDependenciesTS = [
   "@types/clear",
   "@types/configstore",

src/constants.ts

@@ -1,11 +1,15 @@
+import * as Sentry from "@sentry/node";
 import chalk from "chalk";
 import commander from "commander";
-import * as Sentry from "@sentry/node";
+import inquirer from "inquirer";
 
+/**
+ * Initialize Sentry
+ */
 Sentry.init({
   dsn:
     "https://55c913cc3d394f71ba669fda095698fd@o202486.ingest.sentry.io/5254191",
-  release: "0.3.0",
+  release: "0.4.0",
 });
 
 import {
@@ -15,24 +19,43 @@ import {
   installDevDependencies,
   createTSConfig,
   displaySuccessMessage,
+  replaceTemplateValues,
 } from "./init";
 import { handleIncorrectApplicationName } from "./program";
+import { cleanupError, validateApplicationName } from "./util";
 
+/**
+ * Main CLI Program
+ */
 const main = async (): Promise<void> => {
+  let applicationName;
+  let authorName = "YOUR NAME";
+
   try {
-    let applicationName;
+    // * Used to set the directory, application name, and inserted into templates
     let language: "js" | "ts";
+    // * Default language is JavaScript
     language = "js";
+
+    /**
+     * The program that parses the initial user input
+     */
     const program = new commander.Command("create-cli-application")
-      .version("0.3.0")
+      .version("0.4.0")
       .arguments("<application-name>")
       .usage(`${chalk.yellowBright("<application-name>")} [options]`)
       .action((name) => {
         applicationName = name;
       })
       .option(
         "--typescript",
-        "use TypeScript as the cli application source language"
+        "use TypeScript as the cli application source language",
+        false
+      )
+      .option(
+        "--interactive",
+        "Have the bootstrapper walk you through the process",
+        false
       )
       .on("--help", () => {
         console.log(
@@ -47,26 +70,71 @@ const main = async (): Promise<void> => {
       })
       .parse(process.argv);
 
-    // TODO - Catch names like "my.app.name" or "my app name"
-    if (applicationName === "." || !applicationName) {
-      return handleIncorrectApplicationName(program);
+    // * Application Name must exist, and not consist of illegal characters
+    validateApplicationName(applicationName);
+    if (!applicationName) return;
+
+    if (program.interactive) {
+      // * Interactive walk-thru
+
+      // * Language
+      const languageAnswer = await inquirer.prompt([
+        {
+          type: "list",
+          name: "language",
+          message: "Please select a source language:",
+          choices: [
+            { value: "js", name: "JavaScript" },
+            { value: "ts", name: "TypeScript" },
+          ],
+        },
+      ]);
+      const languageChoice: "js" | "ts" = languageAnswer.language;
+      language = languageChoice;
+
+      // * Author Name
+      const nameAnswer = await inquirer.prompt([
+        {
+          type: "input",
+          name: "name",
+          message:
+            "Please input your name (used for the 'About' screen, but not required):",
+        },
+      ]);
+      const name: string = nameAnswer.name;
+      authorName = name;
+
+      // TODO - Compiler Choice (Babel vs. other)
+      // TODO - Add Prettier
+      // TODO - Add ESLint / Other Linter
+      // TODO - Menu Color Option
     }
 
-    if (program.typescript) language = "ts";
+    // * Set language to 'ts' if user passed --typescript flag
+    if (program.typescript && !program.interactive) language = "ts";
 
+    // * Creates a project directory and package.json
     await createProjectDirectory(applicationName, language);
 
+    // * Installs dependencies
     await installDependencies(applicationName);
 
+    // * Installs dev dependencies
     await installDevDependencies(applicationName, language);
 
+    // * Copies template files
     await copyTemplateFiles(applicationName, language);
 
+    // * Replaces template files placeholder values with real values for the application.
+    await replaceTemplateValues(applicationName, language, authorName);
+
+    // * Creates a tsconfig.json file
     if (language === "ts") await createTSConfig(applicationName);
 
+    // * Displays a success message to the user
     displaySuccessMessage(applicationName);
   } catch (error) {
-    // TODO - Cleanup
+    await cleanupError(applicationName);
     console.error(error);
     throw new Error(error);
   }