feat(commands): add make:ehandler command

README.md

@@ -6,7 +6,7 @@
 [![Appveyor][appveyor-image]][appveyor-url]
 [![Coveralls][coveralls-image]][coveralls-url]
 
-Adonis cli is built on top of [Adonis ace](https://github.com/adonisjs/ace) and helps you scaffold new projects.
+Adonis cli is built on top of [Adonis ace](https://github.com/adonisjs/ace) and helps you scaffold new Adonisjs projects.
 
 Also it can proxy all the ace commands for a project, so that you can run them using the global `adonis` command.
 

index.js

@@ -32,6 +32,9 @@ try {
     require(path.join(process.cwd(), 'ace'))
   }
 } catch (error) {
+  if (error.code !== 'ENOENT') {
+    throw error
+  }
   ace.wireUpWithCommander()
   ace.invoke()
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/cli",
   "version": "3.0.2",
-  "description": "Scaffold new adonis application",
+  "description": "Command line tool for Adonisjs",
   "keywords": [
     "adonis",
     "adonisjs",
@@ -13,7 +13,7 @@
     "Romain Lanz <romain.lanz@slynova.ch>"
   ],
   "license": "MIT",
-  "main": "src/index.js",
+  "main": "src/Commands/index.js",
   "bin": {
     "adonis": "index.js"
   },

src/Commands/KeyGenerate/index.js

@@ -51,6 +51,13 @@ class KeyGenerate extends Command {
     return 'Generate secret key for the app'
   }
 
+  /**
+   * Load related dependencies
+   *
+   * @method loadVendor
+   *
+   * @return {void}
+   */
   loadVendor () {
     this.randomString = require('randomstring')
     this.dotEnv = require('dotenv')
@@ -67,6 +74,13 @@ class KeyGenerate extends Command {
    * @return {void}
    */
   async handle (args, { force = false, echo = false, size, env }) {
+    /**
+     * Asking for user conscious
+     */
+    if (process.env.NODE_ENV === 'production' && !force) {
+      this.error('Cannot generate APP_KEY in production. Pass --force flag to generate')
+    }
+
     size = size || 32
     env = env || '.env'
 

src/Commands/Make/Base.js

@@ -23,7 +23,6 @@ const options = {
     hooks: 'Models/Hooks',
     listeners: 'Listeners',
     exceptions: 'Exceptions',
-    exceptionHandlers: 'Exceptions/Handlers',
     middleware: 'Middleware',
     commands: 'Commands',
     views: 'resources/views',

src/Commands/Make/Command.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Creates a new ace command
+ *
+ * @class MakeCommand
+ * @constructor
+ */
 class MakeCommand extends BaseCommand {
   /**
    * The command signature
@@ -55,8 +61,8 @@ class MakeCommand extends BaseCommand {
       const lines = [
         'Register command as follows',
         '',
-        `1. Open ${this.chalk.yellow('start/app.js')}`,
-        `2. Add ${this.chalk.yellow(namespace)} to commands array`
+        `1. Open ${this.chalk.cyan('start/app.js')}`,
+        `2. Add ${this.chalk.cyan(namespace)} to commands array`
       ]
 
       this.printInstructions(lines)

src/Commands/Make/Controller.js

@@ -12,9 +12,9 @@
 const BaseCommand = require('./Base')
 
 /**
- * Generate unique application key
+ * Make a new HTTP or Ws controller
  *
- * @class KeyGenerate
+ * @class MakeController
  * @constructor
  */
 class MakeController extends BaseCommand {
@@ -42,7 +42,7 @@ class MakeController extends BaseCommand {
    * @return {String}
    */
   static get description () {
-    return 'Make a new HTTP or Ws controller'
+    return 'Make a new HTTP or Websocket channel controller'
   }
 
   /**
@@ -60,10 +60,16 @@ class MakeController extends BaseCommand {
     if (!type || ['ws', 'http'].indexOf(type) <= -1) {
       type = await this
       .on('validate', (value) => !!value)
-      .choice('Select controller type', {
-        http: 'For HTTP requests',
-        ws: 'For Websocket channel'
-      })
+      .choice('Select controller type', [
+        {
+          value: 'http',
+          name: 'For HTTP requests'
+        },
+        {
+          value: 'ws',
+          name: 'For Websocket channel'
+        }
+      ])
     }
 
     return type === 'ws' ? 'wsController' : 'httpController'

src/Commands/Make/ExceptionHandler.js

@@ -0,0 +1,60 @@
+'use strict'
+
+/*
+ * adonis-cli
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+const BaseCommand = require('./Base')
+
+/**
+ * Make a new global exception handler
+ *
+ * @class MakeExceptionHandler
+ * @constructor
+ */
+class MakeExceptionHandler extends BaseCommand {
+  /**
+   * The command signature
+   *
+   * @method signature
+   *
+   * @return {String}
+   */
+  static get signature () {
+    return 'make:ehandler'
+  }
+
+  /**
+   * The command description
+   *
+   * @method description
+   *
+   * @return {String}
+   */
+  static get description () {
+    return 'Make a new global exception handler'
+  }
+
+  /**
+   * Handle method executed by ace
+   *
+   * @method handle
+   *
+   * @return {void}
+   */
+  async handle () {
+    try {
+      await this.ensureInProjectRoot()
+      await this.generateBlueprint('exceptionHandler', '', {})
+    } catch ({ message }) {
+      this.error(message)
+    }
+  }
+}
+
+module.exports = MakeExceptionHandler

src/Commands/Make/Hook.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Make a new lucid model hook
+ *
+ * @class MakeModelHook
+ * @constructor
+ */
 class MakeModelHook extends BaseCommand {
   /**
    * The command signature

src/Commands/Make/Listener.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Make a new redis or event listener
+ *
+ * @class MakeListener
+ * @constructor
+ */
 class MakeListener extends BaseCommand {
   /**
    * The command signature

src/Commands/Make/Middleware.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Make a new HTTP or Ws middleware
+ *
+ * @class MakeMiddleware
+ * @constructor
+ */
 class MakeMiddleware extends BaseCommand {
   /**
    * The command signature
@@ -85,8 +91,8 @@ class MakeMiddleware extends BaseCommand {
    * @private
    */
   _pushHttpInstructions (lines, namespace) {
-    lines.push(`${lines.length - 1}. Open ${this.chalk.yellow('start/kernel.js')} file`)
-    lines.push(`${lines.length - 1}. Register ${this.chalk.yellow(namespace)} under global or named middleware`)
+    lines.push(`${lines.length - 1}. Open ${this.chalk.cyan('start/kernel.js')} file`)
+    lines.push(`${lines.length - 1}. Register ${this.chalk.cyan(namespace)} under global or named middleware`)
   }
 
   /**
@@ -102,8 +108,8 @@ class MakeMiddleware extends BaseCommand {
    * @private
    */
   _pushWsInstructions (lines, namespace) {
-    lines.push(`${lines.length - 1}. Open ${this.chalk.yellow('start/ws.js')} file`)
-    lines.push(`${lines.length - 1}. Register ${this.chalk.yellow(namespace)} under global or named middleware`)
+    lines.push(`${lines.length - 1}. Open ${this.chalk.cyan('start/ws.js')} file`)
+    lines.push(`${lines.length - 1}. Register ${this.chalk.cyan(namespace)} under global or named middleware`)
   }
 
   /**

src/Commands/Make/Migration.js

@@ -11,7 +11,13 @@
 
 const BaseCommand = require('./Base')
 
-class MigrationMake extends BaseCommand {
+/**
+ * Make a new migration file
+ *
+ * @class MakeMigration
+ * @constructor
+ */
+class MakeMigration extends BaseCommand {
   /**
    * Command signature required by ace
    *
@@ -86,4 +92,4 @@ class MigrationMake extends BaseCommand {
   }
 }
 
-module.exports = MigrationMake
+module.exports = MakeMigration

src/Commands/Make/Model.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Make a new lucid model
+ *
+ * @class MakeModel
+ * @constructor
+ */
 class MakeModel extends BaseCommand {
   /**
    * The command signature

src/Commands/Make/View.js

@@ -11,6 +11,12 @@
 
 const BaseCommand = require('./Base')
 
+/**
+ * Make a new edge view
+ *
+ * @class MakeView
+ * @constructor
+ */
 class MakeView extends BaseCommand {
   /**
    * The command signature

src/Commands/Repl/index.js

@@ -18,9 +18,9 @@ const { Command } = require('../../../lib/ace')
 const historyFile = path.join(os.homedir(), '/.adonis_repl_history')
 
 /**
- * Serve the application using forever
+ * Start the repl server session
  *
- * @class Serve
+ * @class Repl
  * @constructor
  */
 class Repl extends Command {
@@ -50,8 +50,10 @@ class Repl extends Command {
    * Reads the history file
    *
    * @param  {Object} repl
+   *
+   * @private
    */
-  readHistoryFile (repl) {
+  _readHistoryFile (repl) {
     try {
       fs.statSync(historyFile)
       repl.rli.history = fs.readFileSync(historyFile, 'utf-8').split('\n').reverse()
@@ -66,8 +68,10 @@ class Repl extends Command {
    * Save the history to the history file.
    *
    * @param {Object} repl
+   *
+   * @private
    */
-  addHistorySaveListener (repl) {
+  _addHistorySaveListener (repl) {
     const fd = fs.openSync(historyFile, 'a')
     repl.rli.addListener('line', (code) => {
       if (code && code !== '.history') {
@@ -101,8 +105,8 @@ class Repl extends Command {
       server.context.make = global.make
     }
 
-    this.readHistoryFile(server)
-    this.addHistorySaveListener(server)
+    this._readHistoryFile(server)
+    this._addHistorySaveListener(server)
     awaitOutside.addAwaitOutsideToReplServer(server)
   }
 }

src/Commands/Serve/index.js

@@ -68,8 +68,12 @@ class Serve extends Command {
       watch: dev,
       watchIgnorePatterns: [
         '*.edge',
+        '*.md',
+        '*.adoc',
+        '*.asciidoc',
+        'resources',
         'database',
-        'README.md',
+        'public',
         'package.json',
         'package-lock.json',
         '.gitignore',
@@ -89,7 +93,7 @@ class Serve extends Command {
     console.log('')
 
     child.on('watch:restart', (info) => {
-      console.log(`${this.chalk.magenta(info.file)}  ${info.stat.replace(process.cwd(), '')}`)
+      console.log(`${this.chalk.magenta(info.file)}  ${info.stat.replace(process.cwd(), '').replace(path.sep, '')}`)
     })
     child.start()
   }

src/Commands/index.js

@@ -26,5 +26,6 @@ module.exports = {
   'make:hook': require('./Make/Hook'),
   'make:migration': require('./Make/Migration'),
   'make:listener': require('./Make/Listener'),
-  'repl': require('./Repl')
+  'repl': require('./Repl'),
+  'make:ehandler': require('./Make/ExceptionHandler')
 }