Merge pull request #24 from bangajs/develop

Develop

Author: saucecodee

Diff for: .DS_Store

@@ -1,4 +1,3 @@
-node_modules
-
-src
+node_modules/
+test-app/
 to-do

Diff for: .gitignore

@@ -1,6 +1,6 @@
 [![BangaJS Logo](https://i.ibb.co/GC3hqjC/banga-banner.jpg)](https://bangajs.netlify.app/)
 
-BàngáJS is a CLI generator for scaffolding [ExpressJS](https://expressjs.com) applications and generating application layer files for speed and efficiency.
+BàngáJS is a CLI generator tool for scaffolding [ExpressJS](https://expressjs.com) applications and generating application layer files with speed and efficiency ⚡️.
 
 
 [![NPM Version][npm-image]][npm-url]
@@ -16,7 +16,7 @@ Before installing, make sure you've [downloaded and installed Node.js](https://n
 Then install BàngáJS globally:
 
 ```bash
-$ npm install bangajs -g
+$ npm install -g  bangajs
 ```
 
 ## Features

Diff for: README.md

@@ -1,12 +1,16 @@
 #!/usr/bin/env node
+"use strict"
 
-const chalk = require('chalk');
+const chalk = require("chalk");
 const help = require("./../lib/cmd/help")
 
+process.title = "bangajs-cli";
+process.on("unhandledRejection", (err) => console.log( chalk.red(err.message)));
+
 try {
-     require("./../lib/utils/app").parse()
-     if (process.ARGS) require("./../lib")()
+  require("../lib/bootstrap").parse()
+  if (process.ARGS) require("./../lib")()
 } catch (error) {
-     console.log(chalk.red(error.message))
-     help()
+  console.log(chalk.red(error.message))
+  help()
 }

Diff for: bin/index.js

@@ -0,0 +1,62 @@
+const yargs = require("yargs-parser")
+const app = {}
+const { command_alias, commands } = require("./config")
+const help = require("./cmd/help")
+const package = require("../package.json")
+
+
+/**
+ * Creates custom process.ARGS object with cli args
+ */
+app.parse = () => {
+  const args = yargs(process.argv.splice(2))
+  const cmd = args._[0] && args._[0].toLowerCase()
+
+  if (!cmd) return help()
+  if (!command_alias[cmd]) throw new Error(`banga: "${cmd}" is not a recognised command or alias`)
+
+  args.$cmd = command_alias[cmd]
+  args.$version = package.version
+
+  process.ARGS = { ...commands[args.$cmd], ...args }
+}
+
+/**
+ * Validate and parse file/path names
+ * 
+ * @param {string} str File path
+ */
+app.parseName = (str) => {
+  const strArray = str.split("/")
+
+  // Remove "/" at the beginning of the string if there is any
+  if (str.charAt(0) == "/") strArray.shift()
+
+  // Check if name is valid 
+  var patt = new RegExp(/^[\w\/-]{1,}$/);
+  if (!patt.test(str)) return false
+
+  const name = strArray.splice((strArray.length - 1), 1).join()
+  if (!name) return false
+
+  const path = strArray.join("/")
+
+  return {
+    name,
+    path
+  }
+}
+
+/**
+ * Checks if a template is renderable with regards to the given options
+ * 
+ * @param {string[]} options Array of options
+ */
+app.canRender = (options = []) => {
+  for (const opt of options)
+    if (!process.ARGS[opt]) return false
+
+  return true
+}
+
+module.exports = app

Diff for: lib/.DS_Store

@@ -2,6 +2,6 @@ const opn = require('opn');
 const { docs } = require("../config")
 
 module.exports = () => {
-     // opens the url in the default browser 
-     opn(`${docs}`);
+   // opens the url in the default browser 
+   opn(`${docs}`);
 }

Diff for: lib/bootstrap.js

@@ -1,88 +1,88 @@
-const chalk = require('chalk');
+const chalk = require('chalk')
 const ejs = require("ejs")
-const path = require("path");
+const path = require("path")
 
-const app = require('./../utils/app');
+const app = require("./../bootstrap")
 const FM = require("./../utils/file-manager")
-const TextFormatter = require("./../utils/text-formatter")
+const { FormatString } = require("./../utils")
 const help = require("./help")
 
 
 const ARGS = process.ARGS
 
 const types = ["controller", "model", "route", "service"]
 const typeAlias = {
-   a: "asset",
-   asset: "asset",
-   c: "controller",
-   controller: "controller",
-   m: "model",
-   model: "model",
-   r: "route",
-   route: "route",
-   s: "service",
-   service: "service"
+  a: "asset",
+  asset: "asset",
+  c: "controller",
+  controller: "controller",
+  m: "model",
+  model: "model",
+  r: "route",
+  route: "route",
+  s: "service",
+  service: "service"
 }
 
 
 // Create a specific file "type"
 async function createFile() {
-   const { $type, $name } = ARGS
-   const templatePath = path.join(__dirname, `./../templates/asset/${$type}.ejs`)
-   const data = await ejs.renderFile(templatePath, { canRender: app.canRender, ...ARGS }, {})
+  const { $type, $name } = ARGS
+  const templatePath = path.join(__dirname, `./../templates/asset/${$type}.ejs`)
+  const data = await ejs.renderFile(templatePath, { canRender: app.canRender, ...ARGS }, {})
 
-   const newFile = await FM.create(null, data)
+  const newFile = await FM.create(null, data)
 
-   if (newFile.status == "exists")
-      console.log(`${chalk.yellow("EXISTS")}: ${$name} ${$type} - ${newFile.full}`)
-   else
-      console.log(`${chalk.green("CREATE")}: ${$name} ${$type} - ${newFile.full}`)
+  if (newFile.status == "exists")
+    console.log(`${chalk.yellow("EXISTS")}: ${$name} ${$type} - ${newFile.full}`)
+  else
+    console.log(`${chalk.green("CREATE")}: ${$name} ${$type} - ${newFile.full}`)
 }
 
 // Create all all file "types"
 async function createAsset() {
-   for (const type of types) {
-      if (app.canRender([type])) {
-         ARGS.$type = type
-         await createFile()
-      }
-   }
+  for (const type of types) {
+    if (app.canRender([type])) {
+      ARGS.$type = type
+      await createFile()
+    }
+  }
 }
 
 
 module.exports = async (type, name) => {
-   try {
-      // Check if "name" and "type"
-      if (!ARGS._[1] && !name) throw new Error(`banga: "<type>" is required`)
-      if (!ARGS._[2] && !type) throw new Error(`banga: "<name>" is required`)
-
-      type = type ? typeAlias[type] : typeAlias[ARGS._[1]]
-
-      // Check if "name" is valid
-      const parseName = app.parseName(ARGS._[2])
-      if (!parseName) throw new Error(`banga: '${ARGS._[2]}' is an invalid name`)
-      name = name ? TextFormatter(parseName.name) : TextFormatter(parseName.name)
-
-      // Check if "type" is valid
-      if (!typeAlias[type]) {
-         throw new Error(`banga: '${ARGS._[1]}' is not a recognised type or alias`)
-      }
-
-      // Add type, name and parsedName.path to process.ARGS
-      ARGS.$type = type
-      ARGS.$name = name
-      ARGS.$path = parseName.path
-
-      // Check what "type" of files to create
-      if (type == "asset") {
-         await createAsset()
-      } else {
-         await createFile()
-      }
-
-      console.log("")
-   } catch (error) {
-      console.log(chalk.red(error.message))
-      help()
-   }
+  try {
+    // Check if "name" and "type"
+    if (!ARGS._[1] && !name) throw new Error(`banga: "<type>" is required`)
+    if (!ARGS._[2] && !type) throw new Error(`banga: "<name>" is required`)
+
+    type = type ? typeAlias[type] : typeAlias[ARGS._[1]]
+
+    // Check if "name" is valid
+    const parseName = app.parseName(ARGS._[2])
+    if (!parseName) throw new Error(`banga: '${ARGS._[2]}' is an invalid name`)
+    name = name ? FormatString(parseName.name) : FormatString(parseName.name)
+
+    // Check if "type" is valid
+    if (!typeAlias[type]) {
+      throw new Error(`banga: '${ARGS._[1]}' is not a recognised type or alias`)
+    }
+
+    // Add type, name and parsedName.path to process.ARGS
+    ARGS.$type = type
+    ARGS.$name = name
+    ARGS.$path = parseName.path
+
+    // Check what "type" of files to create
+    if (type == "asset") {
+      await createAsset()
+    } else {
+      await createFile()
+    }
+
+    console.log("")
+  } catch (error) {
+    console.log(chalk.red(error.message))
+    help()
+  }
 }

Diff for: lib/cmd/docs.js

@@ -1,7 +1,7 @@
 const help = {}
 
 help.default =
-  `
+   `
 Build ExpressJS applications with speed and efficiency with BàngáJS
 
 
@@ -24,7 +24,7 @@ Run 'banga <command> --help' for more information on a command.
 
 
 help.generate =
-  `
+   `
 Generate and/or modify files
 
 
@@ -60,7 +60,7 @@ Options:
 
 
 help.new =
-  `
+   `
 Creates a new Express app.
 
 Usage: 
@@ -78,6 +78,6 @@ Options:
 
 
 module.exports = () => {
-  const cmd = process.ARGS && process.ARGS.$cmd
-  console.log(help[cmd] || help.default)
+   const cmd = process.ARGS && process.ARGS.$cmd
+   console.log(help[cmd] || help.default)
 }

Diff for: lib/cmd/generate.js

@@ -1,7 +1,7 @@
 module.exports = {
-     docs: require("./docs"),
-     generate: require("./generate"),
-     help: require("./help"),
-     new: require("./new"),
-     version: require("./version"),
+   docs: require("./docs"),
+   generate: require("./generate"),
+   help: require("./help"),
+   new: require("./new"),
+   version: require("./version"),
 }