Merge pull request #10 from AthennaIO/develop

feat: add support for exception handling

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/artisan",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -40,6 +40,7 @@
     "husky": "3.0.9",
     "jest": "27.1.0",
     "lint-staged": "9.4.3",
+    "nodemon": "2.0.15",
     "prettier": "2.0.5",
     "ts-jest": "27.0.5",
     "ts-loader": "9.2.3",

src/Artisan.ts

@@ -12,6 +12,7 @@ import columnify from 'columnify'
 import chalkRainbow from 'chalk-rainbow'
 
 import { Path } from '@secjs/utils'
+import { Log } from '@athenna/logger'
 import { Config } from '@athenna/config'
 import { version } from '../package.json'
 import { Command } from 'src/Commands/Command'
@@ -25,13 +26,37 @@ export class Artisan {
    */
   private readonly commander: Commander
 
+  /**
+   * Artisan error handler.
+   *
+   * @private
+   */
+  private errorHandler: (...args: any[]) => any | Promise<any>
+
   /**
    * Creates a new instance of Artisan
    *
    * @return {Artisan}
    */
   public constructor() {
     this.commander = new Commander()
+    this.setErrorHandler(error =>
+      Log.channel('console').error(JSON.stringify(error, null, 2)),
+    )
+  }
+
+  /**
+   * Set Artisan error handler.
+   */
+  setErrorHandler(handler: (...args: any[]) => any | Promise<any>) {
+    this.errorHandler = handler
+  }
+
+  /**
+   * Get Artisan error handler.
+   */
+  getErrorHandler() {
+    return this.errorHandler
   }
 
   /**
@@ -182,6 +207,7 @@ export class Artisan {
     Path.switchEnvVerify()
 
     this.setVersion(Config.get('app.version'))
+
     await this.commander.parseAsync(process.argv)
 
     Path.switchEnvVerify()

src/Commands/List/Make.ts → src/Commands/Build.ts

@@ -7,20 +7,20 @@
  * file that was distributed with this source code.
  */
 
-import { Artisan } from 'src/Facades/Artisan'
+import { Path } from '@secjs/utils'
 import { Command } from 'src/Commands/Command'
 import { Commander } from 'src/Contracts/Commander'
 
-export class Make extends Command {
+export class Build extends Command {
   /**
    * The name and signature of the console command.
    */
-  protected signature = 'list:make'
+  protected signature = 'build'
 
   /**
    * The console command description.
    */
-  protected description = 'List all make commands.'
+  protected description = 'Compile project from Typescript to Javascript.'
 
   /**
    * Set additional flags in the commander instance.
@@ -37,16 +37,21 @@ export class Make extends Command {
    *
    * @return {Promise<void>}
    */
-  async handle(): Promise<void> {
-    this.simpleLog('[ LISTING MAKE ]', 'rmNewLineStart', 'bold', 'green')
+  async handle(_: any, commander: any): Promise<void> {
+    this.simpleLog('[ BUILDING PROJECT ]', 'rmNewLineStart', 'bold', 'green')
 
-    const commands =
-      'Commands:' +
-      Artisan.listCommands(true, 'make')
-        .split('\n')
-        .map(line => `  ${line}`)
-        .join('\n')
+    const rimrafPath = Path.noBuild().pwd('node_modules/.bin/rimraf')
+    let tscPath = Path.noBuild().pwd('node_modules/.bin/tsc')
 
-    this.simpleLog(commands)
+    const tscArgs = commander.args.join(' ')
+
+    if (tscArgs) {
+      tscPath = tscPath.concat(` ${tscArgs}`)
+    }
+
+    await this.execCommand(`${rimrafPath} dist`)
+    await this.execCommand(tscPath)
+
+    this.success('Built successfully.')
   }
 }

src/Commands/Eslint/Fix.ts

@@ -11,6 +11,7 @@ import { parse } from 'path'
 import { Path } from '@secjs/utils'
 import { Command } from 'src/Commands/Command'
 import { Commander } from 'src/Contracts/Commander'
+import { EslintException } from 'src/Exceptions/EslintException'
 
 export class Fix extends Command {
   /**
@@ -67,9 +68,7 @@ export class Fix extends Command {
       }
     } catch (error) {
       if (!options.quiet) {
-        this.error(
-          `Failed to lint ${options.resource} ({yellow} "${name}"). Please check your eslint configurations.`,
-        )
+        throw new EslintException(options.resource, name)
       }
     }
   }

src/Commands/List/Eslint.ts → src/Commands/List.ts

@@ -11,16 +11,16 @@ import { Artisan } from 'src/Facades/Artisan'
 import { Command } from 'src/Commands/Command'
 import { Commander } from 'src/Contracts/Commander'
 
-export class Eslint extends Command {
+export class List extends Command {
   /**
    * The name and signature of the console command.
    */
-  protected signature = 'list:eslint'
+  protected signature = 'list <alias>'
 
   /**
    * The console command description.
    */
-  protected description = 'List all eslint commands.'
+  protected description = 'List all commands available of the alias.'
 
   /**
    * Set additional flags in the commander instance.
@@ -37,12 +37,17 @@ export class Eslint extends Command {
    *
    * @return {Promise<void>}
    */
-  async handle(): Promise<void> {
-    this.simpleLog('[ LISTING ESLINT ]', 'rmNewLineStart', 'bold', 'green')
+  async handle(alias: string): Promise<void> {
+    this.simpleLog(
+      `[ LISTING ${alias.toUpperCase()} ]`,
+      'rmNewLineStart',
+      'bold',
+      'green',
+    )
 
     const commands =
       'Commands:' +
-      Artisan.listCommands(true, 'eslint')
+      Artisan.listCommands(true, alias)
         .split('\n')
         .map(line => `  ${line}`)
         .join('\n')

src/Commands/Make/Command.ts

@@ -7,13 +7,14 @@
  * file that was distributed with this source code.
  */
 
-import { parse } from 'path'
 import { existsSync } from 'fs'
 import { File, Path } from '@secjs/utils'
 import { Artisan } from 'src/Facades/Artisan'
 import { Commander } from 'src/Contracts/Commander'
 import { TemplateHelper } from 'src/Utils/TemplateHelper'
 import { Command as AbstractCommand } from 'src/Commands/Command'
+import { AlreadyExistFileException } from 'src/Exceptions/AlreadyExistFileException'
+import { TemplateNotFoundException } from 'src/Exceptions/TemplateNotFoundException'
 
 export class Command extends AbstractCommand {
   /**
@@ -59,11 +60,7 @@ export class Command extends AbstractCommand {
     const template = TemplateHelper.getTemplate('__name__Command', options)
 
     if (!template) {
-      this.error(
-        `Template for extension ({yellow} "${options.extension}") has not been found.`,
-      )
-
-      return
+      throw new TemplateNotFoundException(options.extension)
     }
 
     const replacedName = TemplateHelper.replaceTemplateName(name, template.base)
@@ -74,13 +71,7 @@ export class Command extends AbstractCommand {
     )
 
     if (existsSync(path)) {
-      this.error(
-        `The command ({yellow} "${
-          parse(path).name
-        }") already exists. Try using another name.`,
-      )
-
-      return
+      throw new AlreadyExistFileException('command', path)
     }
 
     const command = await new File(path, content).create()

src/Commands/Make/Controller.ts

@@ -7,13 +7,14 @@
  * file that was distributed with this source code.
  */
 
-import { parse } from 'path'
 import { existsSync } from 'fs'
 import { File, Path } from '@secjs/utils'
 import { Artisan } from 'src/Facades/Artisan'
 import { Command } from 'src/Commands/Command'
 import { Commander } from 'src/Contracts/Commander'
 import { TemplateHelper } from 'src/Utils/TemplateHelper'
+import { AlreadyExistFileException } from 'src/Exceptions/AlreadyExistFileException'
+import { TemplateNotFoundException } from 'src/Exceptions/TemplateNotFoundException'
 
 export class Controller extends Command {
   /**
@@ -54,11 +55,7 @@ export class Controller extends Command {
     const template = TemplateHelper.getTemplate('__name__Controller', options)
 
     if (!template) {
-      this.error(
-        `Template for extension ({yellow} "${options.extension}") has not been found.`,
-      )
-
-      return
+      throw new TemplateNotFoundException(options.extension)
     }
 
     const replacedName = TemplateHelper.replaceTemplateName(name, template.base)
@@ -69,13 +66,7 @@ export class Controller extends Command {
     )
 
     if (existsSync(path)) {
-      this.error(
-        `The controller ({yellow} "${
-          parse(path).name
-        }") already exists. Try using another name.`,
-      )
-
-      return
+      throw new AlreadyExistFileException('controller', path)
     }
 
     const controller = await new File(path, content).create()

src/Commands/Make/Exception.ts

@@ -7,13 +7,14 @@
  * file that was distributed with this source code.
  */
 
-import { parse } from 'path'
 import { existsSync } from 'fs'
 import { File, Path } from '@secjs/utils'
 import { Artisan } from 'src/Facades/Artisan'
 import { Command } from 'src/Commands/Command'
 import { Commander } from 'src/Contracts/Commander'
 import { TemplateHelper } from 'src/Utils/TemplateHelper'
+import { AlreadyExistFileException } from 'src/Exceptions/AlreadyExistFileException'
+import { TemplateNotFoundException } from 'src/Exceptions/TemplateNotFoundException'
 
 export class Exception extends Command {
   /**
@@ -54,11 +55,7 @@ export class Exception extends Command {
     const template = TemplateHelper.getTemplate('__name__Exception', options)
 
     if (!template) {
-      this.error(
-        `Template for extension ({yellow} "${options.extension}") has not been found.`,
-      )
-
-      return
+      throw new TemplateNotFoundException(options.extension)
     }
 
     const replacedName = TemplateHelper.replaceTemplateName(name, template.base)
@@ -69,13 +66,7 @@ export class Exception extends Command {
     )
 
     if (existsSync(path)) {
-      this.error(
-        `The exception ({yellow} "${
-          parse(path).name
-        }") already exists. Try using another name.`,
-      )
-
-      return
+      throw new AlreadyExistFileException('exception', path)
     }
 
     const exception = await new File(path, content).create()