feat: add make:exception command

Author: thetutlage

commands/Make/Exception.ts

@@ -0,0 +1,64 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
+import { join } from 'path'
+import { args, flags } from '@adonisjs/ace'
+import { RcFile } from '@ioc:Adonis/Core/Application'
+import { BaseGenerator } from './Base'
+
+/**
+ * Command to make a new event exceptions class
+ */
+export default class MakeException extends BaseGenerator {
+  /**
+   * Required by BaseGenerator
+   */
+  protected $form = 'singular' as const
+  protected $pattern = 'pascalcase' as const
+  protected $resourceName: string
+  protected $suffix = 'Exception'
+
+  /**
+   * Command meta data
+   */
+  public static commandName = 'make:exception'
+  public static description = 'Make a new exception handle'
+
+  @args.string({ description: 'Name of the exception class' })
+  public name: string
+
+  @flags.boolean({ description: 'Add handle method to self handle the exception' })
+  public selfHandle: boolean
+
+  /**
+   * Returns the template stub
+   */
+  protected $getStub (): string {
+    return join(
+      __dirname,
+      '..',
+      '..',
+      'templates',
+      this.selfHandle ? 'self-handle-exception.txt' : 'exception.txt',
+    )
+  }
+
+  /**
+   * Pull path from the `exceptions` namespace declaration from
+   * the `.adonisrc.json` file or fallback to `app/Exceptions`
+   */
+  protected $getDestinationPath (rcContents: RcFile): string {
+    return this.$getPathForNamespace(rcContents, 'exceptions') || 'app/Exceptions'
+  }
+
+  public async handle () {
+    this.$resourceName = this.name
+    await super.generate()
+  }
+}

templates/exception.txt

@@ -0,0 +1,2 @@
+export default class ${filename} {
+}

templates/self-handle-exception.txt

@@ -0,0 +1,7 @@
+import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
+
+export default class ${filename} {
+  public async handle (error: this, ctx: HttpContextContract) {
+    ctx.response.status(error.status || 500).send(error.message)
+  }
+}

test/make-exception.spec.ts

@@ -0,0 +1,95 @@
+/*
+* @adonisjs/assembler
+*
+* (c) Harminder Virk <[email protected]>
+*
+* For the full copyright and license information, please view the LICENSE
+* file that was distributed with this source code.
+*/
+
+import test from 'japa'
+import { join } from 'path'
+import { Ioc } from '@adonisjs/fold'
+import { Kernel } from '@adonisjs/ace'
+import { Filesystem } from '@poppinss/dev-utils'
+import { Application } from '@adonisjs/application/build/standalone'
+
+import { toNewlineArray } from '../test-helpers'
+import MakeException from '../commands/Make/Exception'
+
+const fs = new Filesystem(join(__dirname, '__app'))
+const templates = new Filesystem(join(__dirname, '..', 'templates'))
+
+test.group('Make Exception', (group) => {
+  group.before(() => {
+    process.env.ADONIS_ACE_CWD = fs.basePath
+  })
+
+  group.after(() => {
+    delete process.env.ADONIS_ACE_CWD
+  })
+
+  group.afterEach(async () => {
+    await fs.cleanup()
+  })
+
+  test('make an exception class inside the default directory', async (assert) => {
+    await fs.add('.adonisrc.json', JSON.stringify({}))
+
+    const app = new Application(fs.basePath, new Ioc(), {}, {})
+
+    const exception = new MakeException(app, new Kernel(app))
+    exception.name = 'user'
+    await exception.handle()
+
+    const UserException = await fs.get('app/Exceptions/UserException.ts')
+    const ExceptionTemplate = await templates.get('exception.txt')
+    assert.deepEqual(
+      toNewlineArray(UserException),
+      toNewlineArray(ExceptionTemplate.replace('${filename}', 'UserException')),
+    )
+  })
+
+  test('make a self-handled exception class inside the default directory', async (assert) => {
+    await fs.add('.adonisrc.json', JSON.stringify({}))
+
+    const app = new Application(fs.basePath, new Ioc(), {}, {})
+
+    const exception = new MakeException(app, new Kernel(app))
+    exception.name = 'user'
+    exception.selfHandle = true
+    await exception.handle()
+
+    const UserException = await fs.get('app/Exceptions/UserException.ts')
+    const ExceptionTemplate = await templates.get('self-handle-exception.txt')
+    assert.deepEqual(
+      toNewlineArray(UserException),
+      toNewlineArray(ExceptionTemplate.replace('${filename}', 'UserException')),
+    )
+  })
+
+  test('make an exception class inside a custom directory', async (assert) => {
+    await fs.add('.adonisrc.json', JSON.stringify({
+      namespaces: {
+        exceptions: 'App/Exceptions/Custom',
+      },
+      aliases: {
+        App: './app',
+      },
+    }))
+
+    const app = new Application(fs.basePath, new Ioc(), {}, {})
+
+    const exception = new MakeException(app, new Kernel(app))
+    exception.name = 'user'
+    exception.selfHandle = true
+    await exception.handle()
+
+    const UserException = await fs.get('app/Exceptions/Custom/UserException.ts')
+    const ExceptionTemplate = await templates.get('self-handle-exception.txt')
+    assert.deepEqual(
+      toNewlineArray(UserException),
+      toNewlineArray(ExceptionTemplate.replace('${filename}', 'UserException')),
+    )
+  })
+})

test/make-listener.spec.ts

@@ -56,8 +56,8 @@ test.group('Make Listener', (group) => {
         eventListeners: 'App/Events/Listeners',
       },
       aliases: {
-        App: './app'
-      }
+        App: './app',
+      },
     }))
 
     const app = new Application(fs.basePath, new Ioc(), {}, {})