refactor: make:provider command allow to skip registering provider

Author: thetutlage

commands/make/preload.ts

@@ -7,11 +7,11 @@
  * file that was distributed with this source code.
  */
 
+import { extname, relative } from 'node:path'
 import type { AppEnvironments } from '@adonisjs/application/types'
 
 import { stubsRoot } from '../../stubs/main.js'
 import { args, flags, BaseCommand } from '../../modules/ace/main.js'
-import { extname, relative } from 'node:path'
 
 const ALLOWED_ENVIRONMENTS = ['web', 'console', 'test', 'repl'] satisfies AppEnvironments[]
 type AllowedAppEnvironments = typeof ALLOWED_ENVIRONMENTS

commands/make/provider.ts

@@ -7,6 +7,8 @@
  * file that was distributed with this source code.
  */
 
+import { extname, relative } from 'node:path'
+
 import { stubsRoot } from '../../stubs/main.js'
 import type { AppEnvironments } from '../../types/app.js'
 import { args, BaseCommand, flags } from '../../modules/ace/main.js'
@@ -24,6 +26,13 @@ export default class MakeProvider extends BaseCommand {
   @args.string({ description: 'Name of the provider' })
   declare name: string
 
+  @flags.boolean({
+    description: 'Auto register the provider inside the .adonisrc.ts file',
+    showNegatedVariantInHelp: true,
+    alias: 'r',
+  })
+  declare register?: boolean
+
   @flags.array({
     description: `Define the provider environment. Accepted values are "${ALLOWED_ENVIRONMENTS}"`,
     alias: 'e',
@@ -56,25 +65,41 @@ export default class MakeProvider extends BaseCommand {
       return
     }
 
+    /**
+     * Display prompt to know if we should register the provider
+     * file inside the ".adonisrc.ts" file.
+     */
+    if (this.register === undefined) {
+      this.register = await this.prompt.confirm(
+        'Do you want to register the provider in .adonisrc.ts file?'
+      )
+    }
+
     const codemods = await this.createCodemods()
-    const output = await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+    const { destination } = await codemods.makeUsingStub(stubsRoot, this.stubPath, {
       flags: this.parsed.flags,
       entity: this.app.generators.createEntity(this.name),
     })
 
     /**
-     * Registering the provider with the `adonisrc.js` file. We register
-     * the relative path, since we cannot be sure about aliases to exist.
+     * Do not register when prompt has been denied or "--no-register"
+     * flag was used
      */
-    try {
-      const providerImportPath = `./${output.relativeFileName.replace(/(\.js|\.ts)$/, '')}.js`
-      await codemods.updateRcFile((rcFile) => {
-        rcFile.addProvider(providerImportPath, this.environments)
-      })
-    } catch (_) {
-      this.logger.warning(
-        'Unable to register provider inside the adonisrc.ts file. Make sure to manually register it'
-      )
+    if (!this.register) {
+      return
     }
+
+    /**
+     * Creative relative path for the provider file from
+     * the "./start" directory
+     */
+    const providerRelativePath = relative(this.app.providersPath(), destination).replace(
+      extname(destination),
+      ''
+    )
+
+    await codemods.updateRcFile((rcFile) => {
+      rcFile.addProvider(`#providers/${providerRelativePath}`, this.environments)
+    })
   }
 }

tests/commands/make_preload.spec.ts

@@ -103,7 +103,7 @@ test.group('Make preload file', () => {
       },
     ])
 
-    await assert.fileContains('adonisrc.ts', ``)
+    await assert.fileEquals('adonisrc.ts', `export default defineConfig({})`)
   })
 
   test('use environment flag to make preload file in a specific env', async ({ assert, fs }) => {
@@ -142,6 +142,7 @@ test.group('Make preload file', () => {
 
     const command = await ace.create(MakePreload, ['app'])
     command.environments = ['foo' as any]
+    command.prompt.trap('Do you want to register the preload file in .adonisrc.ts file?').accept()
     await command.exec()
 
     command.assertLog(

tests/commands/make_provider.spec.ts

@@ -24,6 +24,7 @@ test.group('Make provider', () => {
     ace.ui.switchMode('raw')
 
     const command = await ace.create(MakeProvider, ['app'])
+    command.prompt.trap('Do you want to register the provider in .adonisrc.ts file?').accept()
     await command.exec()
 
     const { contents } = await new StubsFactory().prepare('make/provider/main.stub', {
@@ -43,7 +44,69 @@ test.group('Make provider', () => {
       },
     ])
 
-    await assert.fileContains('adonisrc.ts', `() => import('./providers/app_provider.js')`)
+    await assert.fileContains('adonisrc.ts', `() => import('#providers/app_provider')`)
+  })
+
+  test('do not display prompt when --register flag is used', async ({ assert, fs }) => {
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('adonisrc.ts', `export default defineConfig({})`)
+
+    const ace = await new AceFactory().make(fs.baseUrl, {
+      importer: (filePath) => import(filePath),
+    })
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    const command = await ace.create(MakeProvider, ['app', '--register'])
+    await command.exec()
+
+    const { contents } = await new StubsFactory().prepare('make/provider/main.stub', {
+      entity: ace.app.generators.createEntity('app'),
+    })
+
+    await assert.fileEquals('providers/app_provider.ts', contents)
+
+    assert.deepEqual(ace.ui.logger.getLogs(), [
+      {
+        message: 'green(DONE:)    create providers/app_provider.ts',
+        stream: 'stdout',
+      },
+      {
+        message: 'green(DONE:)    update adonisrc.ts file',
+        stream: 'stdout',
+      },
+    ])
+
+    await assert.fileContains('adonisrc.ts', `() => import('#providers/app_provider')`)
+  })
+
+  test('do not register provider when --no-register flag is used', async ({ assert, fs }) => {
+    await fs.createJson('tsconfig.json', {})
+    await fs.create('adonisrc.ts', `export default defineConfig({})`)
+
+    const ace = await new AceFactory().make(fs.baseUrl, {
+      importer: (filePath) => import(filePath),
+    })
+    await ace.app.init()
+    ace.ui.switchMode('raw')
+
+    const command = await ace.create(MakeProvider, ['app', '--no-register'])
+    await command.exec()
+
+    const { contents } = await new StubsFactory().prepare('make/provider/main.stub', {
+      entity: ace.app.generators.createEntity('app'),
+    })
+
+    await assert.fileEquals('providers/app_provider.ts', contents)
+
+    assert.deepEqual(ace.ui.logger.getLogs(), [
+      {
+        message: 'green(DONE:)    create providers/app_provider.ts',
+        stream: 'stdout',
+      },
+    ])
+
+    await assert.fileEquals('adonisrc.ts', `export default defineConfig({})`)
   })
 
   test('create provider class for a specific environment', async ({ assert, fs }) => {
@@ -57,6 +120,7 @@ test.group('Make provider', () => {
     ace.ui.switchMode('raw')
 
     const command = await ace.create(MakeProvider, ['app', '-e=web', '-e=repl'])
+    command.prompt.trap('Do you want to register the provider in .adonisrc.ts file?').accept()
     await command.exec()
 
     const { contents } = await new StubsFactory().prepare('make/provider/main.stub', {
@@ -76,7 +140,7 @@ test.group('Make provider', () => {
 
     await assert.fileEquals('providers/app_provider.ts', contents)
     await assert.fileContains('adonisrc.ts', [
-      `() => import('./providers/app_provider.js')`,
+      `() => import('#providers/app_provider')`,
       `environment: ['web', 'repl']`,
     ])
   })
@@ -92,6 +156,7 @@ test.group('Make provider', () => {
     ace.ui.switchMode('raw')
 
     const command = await ace.create(MakeProvider, ['app', '--environments=foo'])
+    command.prompt.trap('Do you want to register the provider in .adonisrc.ts file?').accept()
     await command.exec()
 
     assert.deepEqual(ace.ui.logger.getLogs(), [