@adonisjs/core 6.1.5-2 → 6.1.5-3

package/commands/make/event.ts

@@ -0,0 +1,33 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args } from '../../modules/ace/main.js'
+
+/**
+ * The make event command to create a class based event
+ */
+export default class MakeEvent extends BaseCommand {
+  static commandName = 'make:event'
+  static description = 'Create a new event class'
+
+  @args.string({ description: 'Name of the event' })
+  declare name: string
+
+  /**
+   * The stub to use for generating the event
+   */
+  protected stubPath: string = 'make/event/main.stub'
+
+  async run() {
+    await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+  }
+}

package/commands/make/listener.ts

@@ -0,0 +1,63 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args, flags } from '../../modules/ace/main.js'
+
+/**
+ * The make listener command to create a class based event
+ * listener
+ */
+export default class MakeListener extends BaseCommand {
+  static commandName = 'make:listener'
+  static description = 'Create a new event listener class'
+
+  @args.string({ description: 'Name of the listener' })
+  declare name: string
+
+  @flags.string({
+    description: 'Generate an event class alongside the listener',
+    alias: 'e',
+  })
+  declare event: string
+
+  /**
+   * The stub to use for generating the event listener
+   */
+  protected stubPath: string = 'make/listener/main.stub'
+
+  prepare() {
+    if (this.event) {
+      this.stubPath = 'make/listener/for_event.stub'
+    }
+  }
+
+  async run() {
+    if (this.event) {
+      const { exitCode } = await this.kernel.exec('make:event', [this.event])
+
+      /**
+       * Create listener only when make:event is completed successfully
+       */
+      if (exitCode === 0) {
+        const eventEntity = this.app.generators.createEntity(this.event)
+        await this.generate(this.stubPath, {
+          entity: this.app.generators.createEntity(this.name),
+          event: eventEntity,
+        })
+      }
+
+      return
+    }
+
+    await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+  }
+}

package/commands/make/middleware.ts

@@ -0,0 +1,34 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args } from '../../modules/ace/main.js'
+
+/**
+ * The make middleware command to create a new middleware
+ * class.
+ */
+export default class MakeMiddleware extends BaseCommand {
+  static commandName = 'make:middleware'
+  static description = 'Create a new middleware class'
+
+  @args.string({ description: 'Name of the middleware' })
+  declare name: string
+
+  /**
+   * The stub to use for generating the middleware
+   */
+  protected stubPath: string = 'make/middleware/main.stub'
+
+  async run() {
+    await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+  }
+}

package/commands/make/prldfile.ts

@@ -0,0 +1,40 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args } from '../../modules/ace/main.js'
+
+/**
+ * Make a new preload file
+ */
+export default class MakePreloadFile extends BaseCommand {
+  static commandName = 'make:prldfile'
+  static description = 'Create a new preload file inside the start directory'
+
+  @args.string({ description: 'Name of the preload file' })
+  declare name: string
+
+  /**
+   * The stub to use for generating the preload file
+   */
+  protected stubPath: string = 'make/preload_file/main.stub'
+
+  async run() {
+    const output = await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+
+    /**
+     * Registering the preload file with the `.adonisrc.json` file. We register
+     * the relative path, since we cannot be sure about aliases to exist.
+     */
+    const preloadImportPath = `./${output.relativeFileName.replace(/(\.js|\.ts)$/, '')}.js`
+    await this.app.rcFileEditor.addPreloadFile(preloadImportPath).save()
+  }
+}

package/commands/make/provider.ts

@@ -0,0 +1,40 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args } from '../../modules/ace/main.js'
+
+/**
+ * Make a new provider class
+ */
+export default class MakeProvider extends BaseCommand {
+  static commandName = 'make:provider'
+  static description = 'Create a new service provider class'
+
+  @args.string({ description: 'Name of the provider' })
+  declare name: string
+
+  /**
+   * The stub to use for generating the provider class
+   */
+  protected stubPath: string = 'make/provider/main.stub'
+
+  async run() {
+    const output = await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+
+    /**
+     * Registering the provider with the `.adonisrc.json` file. We register
+     * the relative path, since we cannot be sure about aliases to exist.
+     */
+    const providerImportPath = `./${output.relativeFileName.replace(/(\.js|\.ts)$/, '')}.js`
+    await this.app.rcFileEditor.addProvider(providerImportPath).save()
+  }
+}

package/commands/make/service.ts

@@ -0,0 +1,33 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args } from '../../modules/ace/main.js'
+
+/**
+ * Make a new service class
+ */
+export default class MakeService extends BaseCommand {
+  static commandName = 'make:service'
+  static description = 'Create a new service class'
+
+  @args.string({ description: 'Name of the service' })
+  declare name: string
+
+  /**
+   * The stub to use for generating the service class
+   */
+  protected stubPath: string = 'make/service/main.stub'
+
+  async run() {
+    await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+    })
+  }
+}

package/commands/make/test.ts

@@ -0,0 +1,115 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import BaseCommand from './_base.js'
+import { args, flags } from '../../modules/ace/main.js'
+
+/**
+ * Make a new test file
+ */
+export default class MakeTest extends BaseCommand {
+  static commandName = 'make:test'
+  static description = 'Create a new Japa test file'
+
+  @args.string({ description: 'Name of the test file' })
+  declare name: string
+
+  @flags.string({ description: 'The suite for which to create the test file' })
+  declare suite?: string
+
+  /**
+   * The stub to use for generating the test file
+   */
+  protected stubPath: string = 'make/test/main.stub'
+
+  /**
+   * Returns the suite name for creating the test file
+   */
+  async #getSuite(): Promise<string> {
+    if (this.suite) {
+      return this.suite
+    }
+
+    /**
+     * Use the first suite from the rcFile when there is only
+     * one suite
+     */
+    const rcFileSuites = this.app.rcFile.tests.suites
+    if (rcFileSuites.length === 1) {
+      return rcFileSuites[0].name
+    }
+
+    /**
+     * Prompt the user to select a suite manually
+     */
+    return this.prompt.choice(
+      'Select the suite for the test file',
+      this.app.rcFile.tests.suites.map((suite) => {
+        return suite.name
+      }),
+      {
+        validate(choice) {
+          return choice ? true : 'Please select a suite'
+        },
+      }
+    )
+  }
+
+  /**
+   * Returns the directory path for the selected suite.
+   */
+  async #getSuiteDirectory(directories: string[]): Promise<string> {
+    if (directories.length === 1) {
+      return directories[0]
+    }
+
+    return this.prompt.choice('Select directory for the test file', directories, {
+      validate(choice) {
+        return choice ? true : 'Please select a directory'
+      },
+    })
+  }
+
+  /**
+   * Find suite info from the rcFile file
+   */
+  #findSuite(suiteName: string) {
+    return this.app.rcFile.tests.suites.find((suite) => {
+      return suite.name === suiteName
+    })
+  }
+
+  /**
+   * Executed by ace
+   */
+  async run() {
+    const suite = this.#findSuite(await this.#getSuite())
+
+    /**
+     * Show error when mentioned/selected suite does not exist
+     */
+    if (!suite) {
+      this.logger.error(
+        `The "${this.suite}" suite is not configured inside the .adonisrc.json file`
+      )
+      this.exitCode = 1
+      return
+    }
+
+    /**
+     * Generate entity
+     */
+    await this.generate(this.stubPath, {
+      entity: this.app.generators.createEntity(this.name),
+      suite: {
+        directory: await this.#getSuiteDirectory(suite.directories),
+      },
+    })
+  }
+}

package/commands/serve.ts

@@ -0,0 +1,146 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { CommandOptions } from '../types/ace.js'
+import { BaseCommand, flags } from '../modules/ace/main.js'
+import { detectAssetsBundler, importAssembler, importTypeScript } from '../src/internal_helpers.js'
+
+/**
+ * Serve command is used to run the AdonisJS HTTP server during development. The
+ * command under the hood runs the "bin/server.ts" file and watches for file
+ * system changes
+ */
+export default class Serve extends BaseCommand {
+  static commandName = 'serve'
+  static description =
+    'Start the development HTTP server along with the file watcher to perform restarts on file change'
+
+  static help = [
+    'Start the development server with file watcher using the following command.',
+    '```',
+    '{{ binaryName }} serve --watch',
+    '```',
+    '',
+    'The assets bundler dev server runs automatically after detecting vite config or webpack config files',
+    'You may pass vite CLI args using the --assets-args command line flag.',
+    '```',
+    '{{ binaryName }} serve --assets-args="--debug --base=/public"',
+    '```',
+  ]
+
+  static options: CommandOptions = {
+    staysAlive: true,
+  }
+
+  @flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' })
+  declare watch?: boolean
+
+  @flags.boolean({ description: 'Use polling to detect filesystem changes' })
+  declare poll?: boolean
+
+  @flags.boolean({
+    description: 'Clear the terminal for new logs after file change',
+    showNegatedVariantInHelp: true,
+    default: true,
+  })
+  declare clear?: boolean
+
+  @flags.boolean({
+    description: 'Start assets bundler dev server',
+    showNegatedVariantInHelp: true,
+    default: true,
+  })
+  declare assets?: boolean
+
+  @flags.array({
+    description: 'Define CLI arguments to pass to the assets bundler',
+  })
+  declare assetsArgs?: string[]
+
+  /**
+   * Log a development dependency is missing
+   */
+  #logMissingDevelopmentDependency(dependency: string) {
+    this.logger.error(
+      [
+        `Cannot find package "${dependency}"`,
+        '',
+        `The "${dependency}" package is a development dependency and therefore you should use the serve command during development only.`,
+        '',
+        'If you are running your application in production, then use "node bin/server.js" command to start the HTTP server',
+      ].join('\n')
+    )
+  }
+
+  /**
+   * Runs the HTTP server
+   */
+  async run() {
+    const assembler = await importAssembler(this.app)
+    if (!assembler) {
+      this.#logMissingDevelopmentDependency('@adonisjs/assembler')
+      this.exitCode = 1
+      return
+    }
+
+    const assetsBundler = await detectAssetsBundler(this.app)
+    const devServer = new assembler.DevServer(this.app.appRoot, {
+      clearScreen: this.clear === false ? false : true,
+      nodeArgs: this.parsed.nodeArgs,
+      scriptArgs: [],
+      assets: assetsBundler
+        ? {
+            serve: this.assets === false ? false : true,
+            driver: assetsBundler.name,
+            cmd: assetsBundler.devServerCommand,
+            args: this.assetsArgs || [],
+          }
+        : {
+            serve: false,
+          },
+      metaFiles: this.app.rcFile.metaFiles,
+    })
+
+    /**
+     * Share command logger with assembler, so that CLI flags like --no-ansi has
+     * similar impact for assembler logs as well.
+     */
+    devServer.setLogger(this.logger)
+
+    /**
+     * Exit command when the dev server is closed
+     */
+    devServer.onClose((exitCode) => {
+      this.exitCode = exitCode
+    })
+
+    /**
+     * Exit command when the dev server crashes
+     */
+    devServer.onError(() => {
+      this.exitCode = 1
+    })
+
+    /**
+     * Start the development server
+     */
+    if (this.watch) {
+      const ts = await importTypeScript(this.app)
+      if (!ts) {
+        this.#logMissingDevelopmentDependency('typescript')
+        this.exitCode = 1
+        return
+      }
+
+      await devServer.startAndWatch(ts, { poll: this.poll || false })
+    } else {
+      await devServer.start()
+    }
+  }
+}

package/commands/test.ts

@@ -0,0 +1,189 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { CommandOptions } from '../types/ace.js'
+import { BaseCommand, flags, args } from '../modules/ace/main.js'
+import { detectAssetsBundler, importAssembler, importTypeScript } from '../src/internal_helpers.js'
+
+/**
+ * Test command is used to run tests with optional file watcher. Under the
+ * hood, we run "bin/test.js" file.
+ */
+export default class Test extends BaseCommand {
+  static commandName = 'test'
+  static description = 'Run tests along with the file watcher to re-run tests on file change'
+
+  static options: CommandOptions = {
+    allowUnknownFlags: true,
+    staysAlive: true,
+  }
+
+  @args.spread({
+    description: 'Mention suite names to run tests for selected suites',
+    required: false,
+  })
+  declare suites?: string[]
+
+  @flags.array({ description: 'Filter tests by the filename' })
+  declare files?: string[]
+
+  @flags.array({ description: 'Filter tests by tags' })
+  declare tags?: string[]
+
+  @flags.array({ description: 'Run tests that does not have mentioned tags' })
+  declare ignoreTags?: string[]
+
+  @flags.array({ description: 'Filter tests by parent group title' })
+  declare groups?: string[]
+
+  @flags.array({ description: 'Filter tests by test title' })
+  declare tests?: string[]
+
+  @flags.boolean({ description: 'Watch filesystem and re-run tests on file change' })
+  declare watch?: boolean
+
+  @flags.boolean({ description: 'Use polling to detect filesystem changes' })
+  declare poll?: boolean
+
+  @flags.boolean({
+    description: 'Clear the terminal for new logs after file change',
+    showNegatedVariantInHelp: true,
+    default: true,
+  })
+  declare clear?: boolean
+
+  @flags.boolean({
+    description: 'Start assets bundler dev server.',
+    showNegatedVariantInHelp: true,
+    default: true,
+  })
+  declare assets?: boolean
+
+  @flags.array({
+    description: 'Define CLI arguments to pass to the assets bundler',
+  })
+  declare assetsArgs?: string[]
+
+  /**
+   * Log a development dependency is missing
+   */
+  #logMissingDevelopmentDependency(dependency: string) {
+    this.logger.error(
+      [
+        `Cannot find package "${dependency}"`,
+        '',
+        `The "${dependency}" package is a development dependency and therefore you should run tests with development dependencies installed.`,
+        '',
+        'If you are run tests inside a CI, make sure the NODE_ENV is set to "development"',
+      ].join('\n')
+    )
+  }
+
+  /**
+   * Runs tests
+   */
+  async run() {
+    console.log(this.app.rcFile.tests)
+    const assembler = await importAssembler(this.app)
+    if (!assembler) {
+      this.#logMissingDevelopmentDependency('@adonisjs/assembler')
+      this.exitCode = 1
+      return
+    }
+
+    const assetsBundler = await detectAssetsBundler(this.app)
+
+    const testRunner = new assembler.TestRunner(this.app.appRoot, {
+      clearScreen: this.clear === false ? false : true,
+      nodeArgs: this.parsed.nodeArgs,
+      scriptArgs: this.parsed.unknownFlags
+        .map((flag) => {
+          const value = this.parsed.flags[flag]
+
+          /**
+           * Not mentioning value when value is "true"
+           */
+          if (value === true) {
+            return [`--${flag}`] as string[]
+          }
+
+          /**
+           * Repeating flag multiple times when value is an array
+           */
+          if (Array.isArray(value)) {
+            return value.map((v) => [`--${flag}`, v]) as string[][]
+          }
+
+          return [`--${flag}`, value] as string[]
+        })
+        .flat(2),
+      assets: assetsBundler
+        ? {
+            serve: this.assets === false ? false : true,
+            driver: assetsBundler.name,
+            cmd: assetsBundler.devServerCommand,
+            args: this.assetsArgs || [],
+          }
+        : {
+            serve: false,
+          },
+      filters: {
+        suites: this.suites,
+        files: this.files,
+        groups: this.groups,
+        tags: this.tags,
+        ignoreTags: this.ignoreTags,
+        tests: this.tests,
+      },
+      suites: this.app.rcFile.tests.suites.map((suite) => {
+        return {
+          name: suite.name,
+          files: Array.isArray(suite.files) ? suite.files : [suite.files],
+        }
+      }),
+      metaFiles: this.app.rcFile.metaFiles,
+    })
+
+    /**
+     * Share command logger with assembler, so that CLI flags like --no-ansi has
+     * similar impact for assembler logs as well.
+     */
+    testRunner.setLogger(this.logger)
+
+    /**
+     * Exit command when the test runner is closed
+     */
+    testRunner.onClose((exitCode) => {
+      this.exitCode = exitCode
+    })
+
+    /**
+     * Exit command when the dev server crashes
+     */
+    testRunner.onError(() => {
+      this.exitCode = 1
+    })
+
+    /**
+     * Start the test runner in watch mode
+     */
+    if (this.watch) {
+      const ts = await importTypeScript(this.app)
+      if (!ts) {
+        this.#logMissingDevelopmentDependency('typescript')
+        this.exitCode = 1
+        return
+      }
+
+      await testRunner.runAndWatch(ts, { poll: this.poll || false })
+    } else {
+      await testRunner.run()
+    }
+  }
+}

package/factories/app.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/application/factories'