@adonisjs/core 6.1.5-3 → 6.1.5-30

package/commands/configure.ts

@@ -1,179 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { slash } from '@poppinss/utils'
-import { EnvEditor } from '../modules/env.js'
-import type { ApplicationService } from '../src/types.js'
-import { args, BaseCommand } from '../modules/ace/main.js'
-
-/**
- * The configure command is used to configure packages after installation
- */
-export default class Configure extends BaseCommand {
-  static commandName = 'configure'
-  static description = 'Configure a package post installation'
-
-  @args.string({ description: 'Package name' })
-  declare name: string
-
-  /**
-   * The root of the stubs directory. The value is defined after we import
-   * the package
-   */
-  declare stubsRoot: string
-
-  /**
-   * Returns the package main exports
-   */
-  #getPackageSource(packageName: string) {
-    return this.app.import(packageName)
-  }
-
-  /**
-   * Returns the installation command for different
-   * package managers
-   */
-  #getInstallationCommands(
-    packages: string[],
-    packageManager: 'npm' | 'pnpm' | 'yarn',
-    isDev: boolean
-  ) {
-    if (!packages.length) {
-      return ''
-    }
-
-    const devFlag = isDev ? ' -D' : ''
-
-    switch (packageManager) {
-      case 'npm':
-        return `${this.colors.yellow(`npm i${devFlag}`)} ${packages.join(' ')}`
-      case 'yarn':
-        return `${this.colors.yellow(`yarn add${devFlag}`)} ${packages.join(' ')}`
-      case 'pnpm':
-        return `${this.colors.yellow(`pnpm add${devFlag}`)} ${packages.join(' ')}`
-    }
-  }
-
-  /**
-   * Publish a stub file to the user project
-   */
-  async publishStub(stubPath: string, stubData?: Record<string, any>) {
-    const stub = await this.app.stubs.build(stubPath, {
-      source: this.stubsRoot,
-    })
-
-    const output = await stub.generate(stubData || {})
-
-    /**
-     * Log message
-     */
-    const entityFileName = slash(this.app.relativePath(output.destination))
-    if (output.status === 'skipped') {
-      return this.logger.action(`create ${entityFileName}`).skipped(output.skipReason)
-    }
-
-    this.logger.action(`create ${entityFileName}`).succeeded()
-  }
-
-  /**
-   * Define one or more environment variables
-   */
-  async defineEnvVariables(environmentVariables: Record<string, number | string | boolean>) {
-    const logs: string[] = []
-    const editor = new EnvEditor(this.app.appRoot)
-    await editor.load()
-
-    Object.keys(environmentVariables).forEach((key) => {
-      const value = environmentVariables[key]
-      editor.add(key, value)
-      logs.push(`               ${this.colors.dim(`${key}=${value}`)}`)
-    })
-
-    await editor.save()
-    this.logger.action('update .env file').succeeded()
-    this.logger.log(logs.join('\n'))
-  }
-
-  /**
-   * Update rcFile
-   */
-  async updateRcFile(
-    callback: (rcFileEditor: ApplicationService['rcFileEditor']) => Promise<void> | void
-  ) {
-    await callback(this.app.rcFileEditor)
-    await this.app.rcFileEditor.save()
-    this.logger.action('update .adonisrc.json file').succeeded()
-  }
-
-  /**
-   * List the packages one should install before using the packages
-   */
-  listPackagesToInstall(packages: { name: string; isDevDependency: boolean }[]) {
-    const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name)
-    const prodDependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name)
-    const instructions = this.ui.sticker().heading('Please install following packages')
-
-    ;[
-      this.colors.dim('# npm'),
-      this.#getInstallationCommands(devDependencies, 'npm', true),
-      this.#getInstallationCommands(prodDependencies, 'npm', false),
-      ' ',
-    ]
-      .concat([
-        this.colors.dim('# yarn'),
-        this.#getInstallationCommands(devDependencies, 'yarn', true),
-        this.#getInstallationCommands(prodDependencies, 'yarn', false),
-        ' ',
-      ])
-      .concat([
-        this.colors.dim('# pnpm'),
-        this.#getInstallationCommands(devDependencies, 'pnpm', true),
-        this.#getInstallationCommands(prodDependencies, 'pnpm', false),
-      ])
-      .filter((line) => line.length)
-      .forEach((line) => instructions.add(line))
-
-    instructions.render()
-  }
-
-  /**
-   * Run method is invoked by ace automatically
-   */
-  async run() {
-    const packageExports = await this.#getPackageSource(this.name)
-
-    /**
-     * Warn, there are not instructions to run
-     */
-    if (!packageExports.configure) {
-      this.logger.warning(
-        `Cannot configure "${this.name}" package. The package does not export the configure hook`
-      )
-      return
-    }
-
-    /**
-     * Instructions needs stubs root
-     */
-    if (!packageExports.stubsRoot) {
-      this.logger.error(
-        `Missing "stubsRoot" export from "${this.name}" package. The stubsRoot variable is required to lookup package stubs`
-      )
-      this.exitCode = 1
-      return
-    }
-
-    this.stubsRoot = packageExports.stubsRoot
-
-    /**
-     * Run instructions
-     */
-    await packageExports.configure(this)
-  }
-}

package/commands/eject.ts

@@ -1,39 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { slash } from '@poppinss/utils'
-import { args, BaseCommand, flags } from '../modules/ace/main.js'
-
-/**
- * The eject command is used to eject templates to the user
- * application codebase for customizing them
- */
-export default class Eject extends BaseCommand {
-  static commandName = 'eject'
-  static description = 'Eject scaffolding stubs to your application root'
-
-  @args.string({ description: 'Path to the stubs directory or a single stub file' })
-  declare stubPath: string
-
-  @flags.string({
-    description: 'Mention package name for searching stubs',
-    default: '@adonisjs/core',
-  })
-  declare pkg: string
-
-  async run() {
-    const copied = await this.app.stubs.copy(this.stubPath, {
-      pkg: this.pkg,
-    })
-
-    copied.forEach((stubPath) => {
-      this.logger.success(`eject ${slash(this.app.relativePath(stubPath))}`)
-    })
-  }
-}

package/commands/generate_key.ts

@@ -1,53 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import string from '@poppinss/utils/string'
-import { EnvEditor } from '../modules/env.js'
-import { BaseCommand, flags } from '../modules/ace/main.js'
-
-/**
- * The generate key command is used to generate the app key
- * and write it inside the .env file.
- */
-export default class GenerateKey extends BaseCommand {
-  static commandName = 'generate:key'
-  static description = 'Generate a secure random application key'
-
-  @flags.boolean({
-    description: 'Display the key on the terminal, instead of writing it to .env file',
-  })
-  declare show: boolean
-
-  @flags.boolean({
-    description: 'Force update .env file in production environment',
-  })
-  declare force: boolean
-
-  async run() {
-    let writeToFile = process.env.NODE_ENV !== 'production'
-    if (this.force) {
-      writeToFile = true
-    }
-
-    if (this.show) {
-      writeToFile = false
-    }
-
-    const secureKey = string.random(32)
-
-    if (writeToFile) {
-      const editor = await EnvEditor.create(this.app.appRoot)
-      editor.add('APP_KEY', secureKey)
-      await editor.save()
-      this.logger.action('add APP_KEY to .env').succeeded()
-    } else {
-      this.logger.log(`APP_KEY = ${secureKey}`)
-    }
-  }
-}

package/commands/inspect_rcfile.ts

@@ -1,23 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import lodash from '@poppinss/utils/lodash'
-import { BaseCommand } from '../modules/ace/main.js'
-
-/**
- * Prints the RcFile file contents to the terminal
- */
-export default class InspectRCFile extends BaseCommand {
-  static commandName = 'inspect:rcfile'
-  static description = 'Inspect the RC file with its default values'
-
-  async run() {
-    this.logger.log(JSON.stringify(lodash.omit(this.app.rcFile, ['raw']), null, 2))
-  }
-}

package/commands/list/routes.ts

@@ -1,121 +0,0 @@
-/*
- * @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 { args, BaseCommand, flags } from '../../modules/ace/main.js'
-import { RoutesListFormatter } from '../../src/cli_formatters/routes_list.js'
-
-/**
- * The list routes command is used to view the list of registered routes
- */
-export default class ListRoutes extends BaseCommand {
-  static commandName = 'list:routes'
-  static description =
-    'List application routes. This command will boot the application in the console environment'
-
-  /**
-   * Making sure to start the application so that the routes are
-   * imported
-   */
-  static options: CommandOptions = {
-    startApp: true,
-  }
-
-  /**
-   * The match filter is used to find route by name, pattern and controller name that
-   * includes the match keyword
-   */
-  @args.string({
-    description:
-      'Find routes matching the given keyword. Route name, pattern and controller name will be searched against the keyword',
-    required: false,
-  })
-  declare match: string
-
-  /**
-   * The middleware flag searches for the routes using all the mentioned middleware
-   */
-  @flags.array({
-    description:
-      'View routes that includes all the mentioned middleware names. Use * to see routes that are using one or more middleware',
-  })
-  declare middleware: string[]
-
-  /**
-   * The ignoreMiddleware flag searches for the routes not using all the mentioned middleware
-   */
-  @flags.array({
-    description:
-      'View routes that does not include all the mentioned middleware names. Use * to see routes that are using zero middleware',
-  })
-  declare ignoreMiddleware: string[]
-
-  /**
-   * The json flag is used to view list of routes as a JSON string.
-   */
-  @flags.boolean({ description: 'Get routes list as a JSON string' })
-  declare json: boolean
-
-  /**
-   * The table flag is used to view list of routes as a classic CLI table
-   */
-  @flags.boolean({ description: 'View list of routes as a table' })
-  declare table: boolean
-
-  async run() {
-    const router = await this.app.container.make('router')
-    const formatter = new RoutesListFormatter(
-      router,
-      this.ui,
-      {},
-      {
-        ignoreMiddleware: this.ignoreMiddleware,
-        middleware: this.middleware,
-        match: this.match,
-      }
-    )
-
-    /**
-     * Display as JSON
-     */
-    if (this.json) {
-      this.logger.log(JSON.stringify(await formatter.formatAsJSON(), null, 2))
-      return
-    }
-
-    /**
-     * Display as a standard table
-     */
-    if (this.table) {
-      const tables = await formatter.formatAsAnsiTable()
-      tables.forEach((table) => {
-        this.logger.log('')
-        if (table.heading) {
-          this.logger.log(table.heading)
-          this.logger.log('')
-        }
-        table.table.render()
-      })
-      return
-    }
-
-    /**
-     * Display as a list
-     */
-    const list = await formatter.formatAsAnsiList()
-    list.forEach((item) => {
-      this.logger.log('')
-      if (item.heading) {
-        this.logger.log(item.heading)
-        this.logger.log('')
-      }
-      this.logger.log(item.rows.join('\n'))
-    })
-  }
-}

package/commands/make/_base.ts

@@ -1,55 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { slash } from '@poppinss/utils'
-import { stubsRoot } from '../../stubs/index.js'
-import { BaseCommand } from '../../modules/ace/main.js'
-import type { CommandOptions } from '../../types/ace.js'
-
-/**
- * Base command for make commands
- */
-export default abstract class extends BaseCommand {
-  /**
-   * Allowing unknown flags to enable custom workflows
-   */
-  static options: CommandOptions = {
-    allowUnknownFlags: true,
-  }
-
-  /**
-   * Generates the resource from stub
-   */
-  protected async generate(stubPath: string, stubState: Record<string, any>) {
-    const stub = await this.app.stubs.build(stubPath, { source: stubsRoot })
-    const output = await stub.generate(
-      Object.assign(
-        {
-          flags: this.parsed.flags,
-        },
-        stubState
-      )
-    )
-
-    const entityFileName = slash(this.app.relativePath(output.destination))
-    if (output.status === 'skipped') {
-      this.logger.action(`create ${entityFileName}`).skipped(output.skipReason)
-      return {
-        ...output,
-        relativeFileName: entityFileName,
-      }
-    }
-
-    this.logger.action(`create ${entityFileName}`).succeeded()
-    return {
-      ...output,
-      relativeFileName: entityFileName,
-    }
-  }
-}

package/commands/make/command.ts

@@ -1,33 +0,0 @@
-/*
- * @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 ace command
- */
-export default class MakeCommand extends BaseCommand {
-  static commandName = 'make:command'
-  static description = 'Create a new ace command class'
-
-  @args.string({ description: 'Name of the command' })
-  declare name: string
-
-  /**
-   * The stub to use for generating the command class
-   */
-  protected stubPath: string = 'make/command/main.stub'
-
-  async run() {
-    await this.generate(this.stubPath, {
-      entity: this.app.generators.createEntity(this.name),
-    })
-  }
-}

package/commands/make/controller.ts

@@ -1,77 +0,0 @@
-/*
- * @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 controller command to create an HTTP controller
- */
-export default class MakeController extends BaseCommand {
-  static commandName = 'make:controller'
-  static description = 'Create a new HTTP controller class'
-
-  @args.string({ description: 'The name of the controller' })
-  declare name: string
-
-  @flags.boolean({
-    description: 'Convert controller class and file name to its singular form',
-    alias: 'r',
-  })
-  declare singular: boolean
-
-  @flags.boolean({
-    description: 'Generate controller with resource actions',
-    alias: 'r',
-  })
-  declare resource: boolean
-
-  @flags.boolean({
-    description: 'Generate controller with api resource actions',
-    alias: 'a',
-  })
-  declare api: boolean
-
-  /**
-   * The stub to use for generating the controller
-   */
-  protected stubPath: string = 'make/controller/main.stub'
-
-  /**
-   * Preparing the command state
-   */
-  async prepare() {
-    /**
-     * Use resource stub
-     */
-    if (this.resource) {
-      this.stubPath = 'make/controller/resource.stub'
-    }
-
-    /**
-     * Use api stub
-     */
-    if (this.api) {
-      this.stubPath = 'make/controller/api.stub'
-    }
-
-    /**
-     * Log warning when both flags are used together
-     */
-    if (this.resource && this.api) {
-      this.logger.warning('--api and --resource flags cannot be used together. Ignoring --resource')
-    }
-  }
-
-  async run() {
-    await this.generate(this.stubPath, {
-      entity: this.app.generators.createEntity(this.name),
-    })
-  }
-}

package/commands/make/event.ts

@@ -1,33 +0,0 @@
-/*
- * @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

@@ -1,63 +0,0 @@
-/*
- * @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),
-    })
-  }
-}