feat: add make:listener command

Author: thetutlage

commands/Make/Listener.ts

@@ -0,0 +1,60 @@
+/*
+ * @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 } from '@adonisjs/ace'
+import { RcFile } from '@ioc:Adonis/Core/Application'
+import { BaseGenerator } from './Base'
+
+/**
+ * Command to make a new event listener class
+ */
+export default class MakeListener extends BaseGenerator {
+  /**
+   * Required by BaseGenerator
+   */
+  protected $form = 'singular' as const
+  protected $pattern = 'pascalcase' as const
+  protected $resourceName: string
+
+  /**
+   * Command meta data
+   */
+  public static commandName = 'make:listener'
+  public static description = 'Make a new event listener class'
+
+  @args.string({ description: 'Name of the event listener class' })
+  public name: string
+
+  /**
+   * Returns the template stub
+   */
+  protected $getStub (): string {
+    return join(
+      __dirname,
+      '..',
+      '..',
+      'templates',
+      'event-listener.txt',
+    )
+  }
+
+  /**
+   * Pull path from the `listeners` directory declaration from
+   * the `.adonisrc.json` file or fallback to `app/Listeners`
+   */
+  protected $getDestinationPath (rcContents: RcFile): string {
+    return this.$getPathForNamespace(rcContents, 'eventListeners') || 'app/Listeners'
+  }
+
+  public async handle () {
+    this.$resourceName = this.name
+    await super.generate()
+  }
+}

templates/event-listener.txt

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

test/make-listener.spec.ts

@@ -0,0 +1,76 @@
+/*
+* @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 MakeListener from '../commands/Make/Listener'
+
+const fs = new Filesystem(join(__dirname, '__app'))
+const templates = new Filesystem(join(__dirname, '..', 'templates'))
+
+test.group('Make Listener', (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 a listener inside the default directory', async (assert) => {
+    await fs.add('.adonisrc.json', JSON.stringify({}))
+
+    const app = new Application(fs.basePath, new Ioc(), {}, {})
+
+    const listener = new MakeListener(app, new Kernel(app))
+    listener.name = 'user'
+    await listener.handle()
+
+    const UserListener = await fs.get('app/Listeners/User.ts')
+    const ListenerTemplate = await templates.get('event-listener.txt')
+    assert.deepEqual(
+      toNewlineArray(UserListener),
+      toNewlineArray(ListenerTemplate.replace('${filename}', 'User')),
+    )
+  })
+
+  test('make a listener inside a custom directory', async (assert) => {
+    await fs.add('.adonisrc.json', JSON.stringify({
+      namespaces: {
+        eventListeners: 'App/Events/Listeners',
+      },
+      aliases: {
+        App: './app'
+      }
+    }))
+
+    const app = new Application(fs.basePath, new Ioc(), {}, {})
+
+    const listener = new MakeListener(app, new Kernel(app))
+    listener.name = 'user'
+    await listener.handle()
+
+    const UserListener = await fs.get('app/Events/Listeners/User.ts')
+    const ListenerTemplate = await templates.get('event-listener.txt')
+    assert.deepEqual(
+      toNewlineArray(UserListener),
+      toNewlineArray(ListenerTemplate.replace('${filename}', 'User')),
+    )
+  })
+})