Merge pull request #2 from alexlee-dev/v0.2.0

📦 v0.2.0

Author: Alex Lee

CHANGELOG.md

@@ -5,6 +5,24 @@ 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.2.0] - 2020-05-26
+
+### 🔧 Vanilla JS Support
+
+### Added
+
+- Support for both JS (deafult language) and TS (passed as '--typescript' option)
+
+### Changed
+
+- Add "release" to Sentry config
+
+### Removed
+
+### Fixed
+
+- Fixed broken links on README
+
 ## [0.1.0] - 2020-05-26
 
 ### 🚀 First Happy Path Solution

README.md

@@ -24,11 +24,8 @@
 
 - [About](#about)
 - [Getting Started](#getting_started)
-- [Deployment](#deployment)
 - [Usage](#usage)
 - [Built Using](#built_using)
-- [TODO](../TODO.md)
-- [Contributing](../CONTRIBUTING.md)
 - [Authors](#authors)
 - [Acknowledgments](#acknowledgement)
 
@@ -51,6 +48,14 @@ I generally use a template when developing CLI applications for myself. I want t
 
 `create-cli-application cool-app-name`
 
+### Changing the Source Language
+
+By deafault, **create-cli-application** will create your application as a JavaScript project. You can pass the `--typescript` flag to create a TypeScript project instead.
+
+`create-cli-application cool-app-name --typescript`
+
+Want support for an additional language? Feel free to open a [new issue](https://github.com/alexlee-dev/create-cli-application/issues/new).
+
 ## ⛏️ Built Using <a name = "built_using"></a>
 
 - [@sentry/node](https://sentry.io/welcome/) - Sentry is cross-platform application monitoring, with a focus on error reporting.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cli-application",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A bootstrapper for creating a cli application with Node.",
   "bin": {
     "create-cli-application": "./index.js"

package.json

@@ -8,6 +8,14 @@ export const dependencies = [
 ];
 
 export const devDependencies = [
+  "@babel/core",
+  "@babel/cli",
+  "@babel/preset-env",
+  "@babel/plugin-transform-runtime",
+  "@babel/runtime",
+];
+
+export const devDependenciesTS = [
   "@types/clear",
   "@types/configstore",
   "@types/inquirer",

src/constants.ts

@@ -5,6 +5,7 @@ import * as Sentry from "@sentry/node";
 Sentry.init({
   dsn:
     "https://55c913cc3d394f71ba669fda095698fd@o202486.ingest.sentry.io/5254191",
+  release: "0.2.0",
 });
 
 import {
@@ -20,13 +21,19 @@ import { handleIncorrectApplicationName } from "./program";
 const main = async (): Promise<void> => {
   try {
     let applicationName;
+    let language: "js" | "ts";
+    language = "js";
     const program = new commander.Command("create-cli-application")
-      .version("0.0.0")
+      .version("0.2.0")
       .arguments("<application-name>")
       .usage(`${chalk.yellowBright("<application-name>")} [options]`)
       .action((name) => {
         applicationName = name;
       })
+      .option(
+        "--typescript",
+        "use TypeScript as the cli application source language"
+      )
       .on("--help", () => {
         console.log(
           `\nOnly ${chalk.yellowBright("<application-name>")} is required.`
@@ -40,21 +47,22 @@ 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);
     }
 
-    // TODO - Catch names like "my.app.name" or "my app name"
+    if (program.typescript) language = "ts";
 
-    await createProjectDirectory(applicationName);
+    await createProjectDirectory(applicationName, language);
 
     await installDependencies(applicationName);
 
-    await installDevDependencies(applicationName);
+    await installDevDependencies(applicationName, language);
 
-    await copyTemplateFiles(applicationName);
+    await copyTemplateFiles(applicationName, language);
 
-    await createTSConfig(applicationName);
+    if (language === "ts") await createTSConfig(applicationName);
 
     displaySuccessMessage(applicationName);
   } catch (error) {

src/index.ts

@@ -4,20 +4,28 @@ import ora from "ora";
 import os from "os";
 import path from "path";
 
-import { dependencies, devDependencies } from "./constants";
+import { dependencies, devDependencies, devDependenciesTS } from "./constants";
 import { executeCommand } from "./util";
 
 export const createProjectDirectory = async (
-  applicationName: string
+  applicationName: string,
+  language: "js" | "ts"
 ): Promise<void> => {
   const root = path.resolve(applicationName);
-  // const originalDirectory = process.cwd();
 
   fs.ensureDirSync(root);
 
   console.log();
   console.log(`Creating a new CLI app in ${chalk.yellowBright(root)}.`);
   console.log();
+  console.log(
+    `Source Language: ${
+      language === "js"
+        ? chalk.yellowBright("JavaScript")
+        : chalk.yellowBright("TypeScript")
+    }`
+  );
+  console.log();
 
   // TODO - Interactive mode to fill in some of these values
 
@@ -30,7 +38,7 @@ export const createProjectDirectory = async (
       [applicationName]: "./index.js",
     },
     scripts: {
-      build: "rimraf build && tsc",
+      build: language === "ts" ? "rimraf build && tsc" : "babel src -d build",
       start: "node build/index.js -- start",
       test: 'echo "Error: no test specified" && exit 1',
     },
@@ -77,7 +85,8 @@ export const installDependencies = async (
 };
 
 export const installDevDependencies = async (
-  applicationName: string
+  applicationName: string,
+  language: "js" | "ts"
 ): Promise<void> => {
   const root = path.resolve(applicationName);
 
@@ -88,6 +97,13 @@ export const installDevDependencies = async (
     const installCommand = "npm";
     let installArgs = ["install", "--save"];
     installArgs = installArgs.concat(devDependencies);
+
+    if (language === "ts") {
+      installArgs = installArgs.concat(devDependenciesTS);
+    } else {
+      installArgs = installArgs.concat(devDependencies);
+    }
+
     await executeCommand(installCommand, installArgs, { cwd: root });
     spinner.succeed("DevDependencies installed successfully");
   } catch (error) {
@@ -97,7 +113,8 @@ export const installDevDependencies = async (
 };
 
 export const copyTemplateFiles = async (
-  applicationName: string
+  applicationName: string,
+  language: "js" | "ts"
 ): Promise<void> => {
   const root = path.resolve(applicationName);
 
@@ -106,7 +123,7 @@ export const copyTemplateFiles = async (
   try {
     spinner.start();
     await fs.copy(
-      path.join(__dirname, "template/ts/src"),
+      path.join(__dirname, `template/${language}/src`),
       path.join(root, "/src")
     );
     await fs.copy(
@@ -121,6 +138,12 @@ export const copyTemplateFiles = async (
       path.join(__dirname, "template/gitignore"),
       path.join(root, "/.gitignore")
     );
+    if (language === "js") {
+      await fs.copy(
+        path.join(__dirname, "template/babelrc"),
+        path.join(root, "/.babelrc")
+      );
+    }
     spinner.succeed("Template files copied successfully");
   } catch (error) {
     spinner.fail();

src/init.ts

@@ -0,0 +1,6 @@
+{
+  "plugins":  ["@babel/plugin-transform-runtime"],
+  "presets":  [
+    "@babel/preset-env"
+  ]
+}

src/template/babelrc

@@ -0,0 +1,17 @@
+import { Options } from "boxen";
+
+/**
+ * Blank style applied to Boxen.
+ */
+export const blankBoxenStyle = {
+  borderStyle: {
+    topLeft: " ",
+    topRight: " ",
+    bottomLeft: " ",
+    bottomRight: " ",
+    horizontal: " ",
+    vertical: " ",
+  },
+  float: "center",
+  padding: { top: 0, bottom: 0, right: 1, left: 1 },
+};

src/template/js/src/constants.js

@@ -0,0 +1,46 @@
+import clear from "clear";
+import Configstore from "configstore";
+import EventEmitter from "events";
+import { titleScreen } from "pickitt";
+
+import { displayMainMenu, interpretMenuAction } from "./menu";
+import setup from "./setup";
+
+const main = async () => {
+  const menuActionEmitter = new EventEmitter.EventEmitter();
+  menuActionEmitter.on("actionCompleted", async (state) => {
+    await titleScreen("APP NAME");
+    await displayMainMenu(state);
+    await interpretMenuAction(state);
+  });
+
+  const config = new Configstore("app-name");
+
+  const state = {
+    config,
+    menuAction: null,
+    menuActionEmitter,
+  };
+
+  try {
+    const isSetUp = config.get("isSetUp");
+
+    if (!isSetUp) {
+      await setup(state);
+      clear();
+    }
+
+    await titleScreen("APP NAME");
+    await displayMainMenu(state);
+
+    await interpretMenuAction(state);
+  } catch (e) {
+    console.error("ERROR");
+    console.log(state);
+    console.error(e);
+  }
+};
+
+if (process.argv[3] === "start") main();
+
+export default main;