@adonisjs/core 6.1.5-2 → 6.1.5-21

package/build/commands/serve.js

@@ -1,20 +1,45 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 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 = {
         staysAlive: true,
     };
+    /**
+     * Log a development dependency is missing
+     */
     #logMissingDevelopmentDependency(dependency) {
         this.logger.error([
             `Cannot find package "${dependency}"`,
@@ -24,6 +49,25 @@ export default class Serve extends BaseCommand {
             'If you are running your application in production, then use "node bin/server.js" command to start the HTTP server',
         ].join('\n'));
     }
+    /**
+     * Returns the assets bundler config
+     */
+    async #getAssetsBundlerConfig() {
+        const assetsBundler = await detectAssetsBundler(this.app);
+        return assetsBundler
+            ? {
+                serve: this.assets === false ? false : true,
+                driver: assetsBundler.name,
+                cmd: assetsBundler.devServer.command,
+                args: (assetsBundler.devServer.args || []).concat(this.assetsArgs || []),
+            }
+            : {
+                serve: false,
+            };
+    }
+    /**
+     * Runs the HTTP server
+     */
     async run() {
         const assembler = await importAssembler(this.app);
         if (!assembler) {
@@ -31,29 +75,35 @@ export default class Serve extends BaseCommand {
             this.exitCode = 1;
             return;
         }
-        const assetsBundler = await detectAssetsBundler(this.app);
-        const devServer = new assembler.DevServer(this.app.appRoot, {
+        this.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,
-                }
-                : {
-                    serve: false,
-                },
+            assets: await this.#getAssetsBundlerConfig(),
             metaFiles: this.app.rcFile.metaFiles,
         });
-        devServer.setLogger(this.logger);
-        devServer.onClose((exitCode) => {
+        /**
+         * Share command logger with assembler, so that CLI flags like --no-ansi has
+         * similar impact for assembler logs as well.
+         */
+        this.devServer.setLogger(this.logger);
+        /**
+         * Exit command when the dev server is closed
+         */
+        this.devServer.onClose((exitCode) => {
             this.exitCode = exitCode;
+            this.terminate();
         });
-        devServer.onError(() => {
+        /**
+         * Exit command when the dev server crashes
+         */
+        this.devServer.onError(() => {
             this.exitCode = 1;
+            this.terminate();
         });
+        /**
+         * Start the development server
+         */
         if (this.watch) {
             const ts = await importTypeScript(this.app);
             if (!ts) {
@@ -61,34 +111,35 @@ export default class Serve extends BaseCommand {
                 this.exitCode = 1;
                 return;
             }
-            await devServer.startAndWatch(ts, { poll: this.poll || false });
+            await this.devServer.startAndWatch(ts, { poll: this.poll || false });
         }
         else {
-            await devServer.start();
+            await this.devServer.start();
         }
     }
 }
 __decorate([
-    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' })
 ], Serve.prototype, "watch", void 0);
 __decorate([
-    flags.boolean({ description: 'Use polling to detect filesystem changes' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Use polling to detect filesystem changes' })
 ], Serve.prototype, "poll", void 0);
 __decorate([
     flags.boolean({
         description: 'Clear the terminal for new logs after file change',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Serve.prototype, "clear", void 0);
 __decorate([
     flags.boolean({
         description: 'Start assets bundler dev server',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Serve.prototype, "assets", void 0);
+__decorate([
+    flags.array({
+        description: 'Define CLI arguments to pass to the assets bundler',
+    })
+], Serve.prototype, "assetsArgs", void 0);

package/build/commands/test.d.ts

@@ -0,0 +1,32 @@
+import type { TestRunner } from '@adonisjs/assembler';
+import type { CommandOptions } from '../types/ace.js';
+import { BaseCommand } from '../modules/ace/main.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 {
+    #private;
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    testsRunner: TestRunner;
+    suites?: string[];
+    files?: string[];
+    tags?: string[];
+    groups?: string[];
+    tests?: string[];
+    reporters?: string[];
+    watch?: boolean;
+    poll?: boolean;
+    timeout?: number;
+    retries?: number;
+    failed?: boolean;
+    clear?: boolean;
+    assets?: boolean;
+    assetsArgs?: string[];
+    /**
+     * Runs tests
+     */
+    run(): Promise<void>;
+}

package/build/commands/test.js

@@ -0,0 +1,203 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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 = {
+        allowUnknownFlags: true,
+        staysAlive: true,
+    };
+    /**
+     * Log a development dependency is missing
+     */
+    #logMissingDevelopmentDependency(dependency) {
+        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'));
+    }
+    /**
+     * Collection of unknown flags to pass to Japa
+     */
+    #getPassthroughFlags() {
+        return this.parsed.unknownFlags
+            .map((flag) => {
+            const value = this.parsed.flags[flag];
+            /**
+             * Not mentioning value when value is "true"
+             */
+            if (value === true) {
+                return [`--${flag}`];
+            }
+            /**
+             * Repeating flag multiple times when value is an array
+             */
+            if (Array.isArray(value)) {
+                return value.map((v) => [`--${flag}`, v]);
+            }
+            return [`--${flag}`, value];
+        })
+            .flat(2);
+    }
+    /**
+     * Returns the assets bundler config
+     */
+    async #getAssetsBundlerConfig() {
+        const assetsBundler = await detectAssetsBundler(this.app);
+        return assetsBundler
+            ? {
+                serve: this.assets === false ? false : true,
+                driver: assetsBundler.name,
+                cmd: assetsBundler.devServer.command,
+                args: (assetsBundler.devServer.args || []).concat(this.assetsArgs || []),
+            }
+            : {
+                serve: false,
+            };
+    }
+    /**
+     * Runs tests
+     */
+    async run() {
+        const assembler = await importAssembler(this.app);
+        if (!assembler) {
+            this.#logMissingDevelopmentDependency('@adonisjs/assembler');
+            this.exitCode = 1;
+            return;
+        }
+        this.testsRunner = new assembler.TestRunner(this.app.appRoot, {
+            clearScreen: this.clear === false ? false : true,
+            nodeArgs: this.parsed.nodeArgs,
+            scriptArgs: this.#getPassthroughFlags(),
+            assets: await this.#getAssetsBundlerConfig(),
+            filters: {
+                suites: this.suites,
+                files: this.files,
+                groups: this.groups,
+                tags: this.tags,
+                tests: this.tests,
+            },
+            failed: this.failed,
+            retries: this.retries,
+            timeout: this.timeout,
+            reporters: this.reporters,
+            suites: this.app.rcFile.tests.suites.map((suite) => {
+                return {
+                    name: suite.name,
+                    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.
+         */
+        this.testsRunner.setLogger(this.logger);
+        /**
+         * Exit command when the test runner is closed
+         */
+        this.testsRunner.onClose((exitCode) => {
+            this.exitCode = exitCode;
+            this.terminate();
+        });
+        /**
+         * Exit command when the dev server crashes
+         */
+        this.testsRunner.onError(() => {
+            this.exitCode = 1;
+            this.terminate();
+        });
+        /**
+         * 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 this.testsRunner.runAndWatch(ts, { poll: this.poll || false });
+        }
+        else {
+            await this.testsRunner.run();
+        }
+    }
+}
+__decorate([
+    args.spread({
+        description: 'Mention suite names to run tests for selected suites',
+        required: false,
+    })
+], Test.prototype, "suites", void 0);
+__decorate([
+    flags.array({ description: 'Filter tests by the filename' })
+], Test.prototype, "files", void 0);
+__decorate([
+    flags.array({ description: 'Filter tests by tags' })
+], Test.prototype, "tags", void 0);
+__decorate([
+    flags.array({ description: 'Filter tests by parent group title' })
+], Test.prototype, "groups", void 0);
+__decorate([
+    flags.array({ description: 'Filter tests by test title' })
+], Test.prototype, "tests", void 0);
+__decorate([
+    flags.array({ description: 'Activate one or more test reporters' })
+], Test.prototype, "reporters", void 0);
+__decorate([
+    flags.boolean({ description: 'Watch filesystem and re-run tests on file change' })
+], Test.prototype, "watch", void 0);
+__decorate([
+    flags.boolean({ description: 'Use polling to detect filesystem changes' })
+], Test.prototype, "poll", void 0);
+__decorate([
+    flags.number({ description: 'Define default timeout for all tests' })
+], Test.prototype, "timeout", void 0);
+__decorate([
+    flags.number({ description: 'Define default retries for all tests' })
+], Test.prototype, "retries", void 0);
+__decorate([
+    flags.boolean({ description: 'Execute tests failed during the last run' })
+], Test.prototype, "failed", void 0);
+__decorate([
+    flags.boolean({
+        description: 'Clear the terminal for new logs after file change',
+        showNegatedVariantInHelp: true,
+        default: true,
+    })
+], Test.prototype, "clear", void 0);
+__decorate([
+    flags.boolean({
+        description: 'Start assets bundler dev server.',
+        showNegatedVariantInHelp: true,
+        default: true,
+    })
+], Test.prototype, "assets", void 0);
+__decorate([
+    flags.array({
+        description: 'Define CLI arguments to pass to the assets bundler',
+    })
+], Test.prototype, "assetsArgs", void 0);

package/build/factories/app.js

@@ -1 +1,9 @@
+/*
+ * @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';

package/build/factories/bodyparser.js

@@ -1 +1,9 @@
+/*
+ * @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/bodyparser/factories';

package/build/factories/core/ace.d.ts

@@ -1,7 +1,10 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 import { Ignitor } from '../../src/ignitor/main.js';
 import type { IgnitorOptions } from '../../src/types.js';
 import type { Kernel } from '../../modules/ace/kernel.js';
+/**
+ * Creates an instance of Ace kernel
+ */
 export declare class AceFactory {
     make(ignitor: Ignitor): Promise<Kernel>;
     make(appRoot: URL, options: IgnitorOptions): Promise<Kernel>;

package/build/factories/core/ace.js

@@ -1,6 +1,17 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { IgnitorFactory } from './ignitor.js';
 import { Ignitor } from '../../src/ignitor/main.js';
 import { createAceKernel } from '../../modules/ace/create_kernel.js';
+/**
+ * Creates an instance of Ace kernel
+ */
 export class AceFactory {
     async make(ignitorOrAppRoot, options) {
         if (ignitorOrAppRoot instanceof Ignitor) {

package/build/factories/core/ignitor.d.ts

@@ -1,16 +1,35 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 import { Ignitor } from '../../src/ignitor/main.js';
 import type { ApplicationService, IgnitorOptions } from '../../src/types.js';
 type FactoryParameters = {
     rcFileContents: Record<string, any>;
     config: Record<string, any>;
 };
+/**
+ * Ignitor factory creates an instance of the AdonisJS ignitor
+ */
 export declare class IgnitorFactory {
     #private;
+    /**
+     * Define preload actions to run.
+     */
     preload(action: (app: ApplicationService) => void | Promise<void>): this;
+    /**
+     * Merge custom factory parameters
+     */
     merge(params: Partial<FactoryParameters>): this;
+    /**
+     * Load core provider when booting the app
+     */
     withCoreProviders(): this;
+    /**
+     * Merge default config for the core features. A shallow merge
+     * is performed.
+     */
     withCoreConfig(): this;
+    /**
+     * Create ignitor instance
+     */
     create(appRoot: URL, options: IgnitorOptions): Ignitor;
 }
 export {};

package/build/factories/core/ignitor.js

@@ -1,23 +1,47 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Ignitor } from '../../src/ignitor/main.js';
-import { defineConfig as defineHttpConfig } from '../../modules/http.js';
+import { defineConfig as defineHttpConfig } from '../../modules/http/main.js';
 import { defineConfig as defineLoggerConfig } from '../../modules/logger.js';
 import { defineConfig as defineHashConfig } from '../../modules/hash/main.js';
 import { defineConfig as defineBodyParserConfig } from '../../modules/bodyparser/main.js';
+/**
+ * Ignitor factory creates an instance of the AdonisJS ignitor
+ */
 export class IgnitorFactory {
     #preloadActions = [];
     #parameters = {};
+    /**
+     * A flag to know if we should load the core providers
+     */
     #loadCoreProviders = false;
+    /**
+     * Define preload actions to run.
+     */
     preload(action) {
         this.#preloadActions.push(action);
         return this;
     }
+    /**
+     * Merge core providers with user defined providers
+     */
     #mergeCoreProviders(providers) {
         return [
             '@adonisjs/core/providers/app_provider',
             '@adonisjs/core/providers/hash_provider',
             '@adonisjs/core/providers/http_provider',
+            '@adonisjs/core/providers/repl_provider',
         ].concat(providers || []);
     }
+    /**
+     * Merge custom factory parameters
+     */
     merge(params) {
         if (params.config) {
             this.#parameters.config = Object.assign(this.#parameters.config || {}, params.config);
@@ -27,10 +51,17 @@ export class IgnitorFactory {
         }
         return this;
     }
+    /**
+     * Load core provider when booting the app
+     */
     withCoreProviders() {
         this.#loadCoreProviders = true;
         return this;
     }
+    /**
+     * Merge default config for the core features. A shallow merge
+     * is performed.
+     */
     withCoreConfig() {
         this.merge({
             config: {
@@ -58,6 +89,9 @@ export class IgnitorFactory {
         });
         return this;
     }
+    /**
+     * Create ignitor instance
+     */
     create(appRoot, options) {
         return new Ignitor(appRoot, options).tap((app) => {
             app.booted(async () => {

package/build/factories/core/main.js

@@ -1,3 +1,11 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export { AceFactory } from './ace.js';
 export { StubsFactory } from '../stubs.js';
 export { IgnitorFactory } from './ignitor.js';

package/build/factories/core/test_utils.d.ts

@@ -1,7 +1,10 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="@types/node" resolution-mode="require"/>
 import { Ignitor } from '../../index.js';
 import type { IgnitorOptions } from '../../src/types.js';
 import { TestUtils } from '../../src/test_utils/main.js';
+/**
+ * Creates an instance of TestUtils class
+ */
 export declare class TestUtilsFactory {
     create(ignitor: Ignitor): TestUtils;
     create(appRoot: URL, options: IgnitorOptions): TestUtils;

package/build/factories/core/test_utils.js

@@ -1,6 +1,17 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { Ignitor } from '../../index.js';
 import { IgnitorFactory } from './ignitor.js';
 import { TestUtils } from '../../src/test_utils/main.js';
+/**
+ * Creates an instance of TestUtils class
+ */
 export class TestUtilsFactory {
     create(ignitorOrAppRoot, options) {
         if (ignitorOrAppRoot instanceof Ignitor) {

package/build/factories/encryption.js

@@ -1 +1,9 @@
+/*
+ * @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/encryption/factories';

package/build/factories/events.js

@@ -1 +1,9 @@
+/*
+ * @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/events/factories';

package/build/factories/hash.js

@@ -1 +1,9 @@
+/*
+ * @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/hash/factories';

package/build/factories/http.js

@@ -1 +1,9 @@
+/*
+ * @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/http-server/factories';

package/build/factories/logger.js

@@ -1 +1,9 @@
+/*
+ * @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/logger/factories';