@adonisjs/assembler 5.4.2 → 5.5.2-0

package/build/ace-manifest.json

@@ -51,14 +51,14 @@
       "settings": {},
       "commandPath": "./commands/Invoke",
       "commandName": "configure",
-      "description": "Configure a given AdonisJS package",
+      "description": "Configure one or more AdonisJS packages",
       "args": [
         {
-          "type": "string",
-          "propertyName": "name",
-          "name": "name",
+          "type": "spread",
+          "propertyName": "packages",
+          "name": "packages",
           "required": true,
-          "description": "Name of the package you want to configure"
+          "description": "Name of the package(s) you want to configure"
         }
       ],
       "aliases": [
@@ -259,6 +259,38 @@
         }
       ]
     },
+    "make:test": {
+      "settings": {},
+      "commandPath": "./commands/Make/Test",
+      "commandName": "make:test",
+      "description": "Make a new test",
+      "args": [
+        {
+          "type": "string",
+          "propertyName": "suite",
+          "name": "suite",
+          "required": true,
+          "description": "Name of the test suite"
+        },
+        {
+          "type": "string",
+          "propertyName": "name",
+          "name": "name",
+          "required": true,
+          "description": "Name of the test file"
+        }
+      ],
+      "aliases": [],
+      "flags": [
+        {
+          "name": "exact",
+          "propertyName": "exact",
+          "type": "boolean",
+          "description": "Create the test file with the exact name as provided",
+          "alias": "e"
+        }
+      ]
+    },
     "make:validator": {
       "settings": {},
       "commandPath": "./commands/Make/Validator",
@@ -353,6 +385,76 @@
         }
       ]
     },
+    "test": {
+      "settings": {
+        "stayAlive": true
+      },
+      "commandPath": "./commands/Test",
+      "commandName": "test",
+      "description": "Run AdonisJS tests",
+      "args": [
+        {
+          "type": "spread",
+          "propertyName": "suites",
+          "name": "suites",
+          "required": false,
+          "description": "Run tests for only the specified suites"
+        }
+      ],
+      "aliases": [],
+      "flags": [
+        {
+          "name": "files",
+          "propertyName": "files",
+          "type": "array",
+          "description": "Run tests for the mentioned files only"
+        },
+        {
+          "name": "watch",
+          "propertyName": "watch",
+          "type": "boolean",
+          "description": "Watch for file changes and re-run tests on file change",
+          "alias": "w"
+        },
+        {
+          "name": "poll",
+          "propertyName": "poll",
+          "type": "boolean",
+          "description": "Detect file changes by polling files instead of listening to filesystem events",
+          "alias": "p"
+        },
+        {
+          "name": "node-args",
+          "propertyName": "nodeArgs",
+          "type": "array",
+          "description": "CLI options to pass to the node command line"
+        },
+        {
+          "name": "tags",
+          "propertyName": "tags",
+          "type": "array",
+          "description": "Filter tests by tags"
+        },
+        {
+          "name": "ignore-tags",
+          "propertyName": "ignoreTags",
+          "type": "array",
+          "description": "Filter tests by ignoring tags"
+        },
+        {
+          "name": "timeout",
+          "propertyName": "timeout",
+          "type": "number",
+          "description": "Customize tests timeout"
+        },
+        {
+          "name": "force-exit",
+          "propertyName": "forceExit",
+          "type": "boolean",
+          "description": "Force exit the tests runner process"
+        }
+      ]
+    },
     "type-check": {
       "settings": {},
       "commandPath": "./commands/TypeCheck",

package/build/commands/Invoke.d.ts

@@ -9,11 +9,19 @@ export default class Configure extends BaseCommand {
     /**
      * Use yarn when building for production to install dependencies
      */
-    name: string;
+    packages: string[];
     /**
      * Configure encore
      */
     private configureEncore;
+    /**
+     * Configure tests
+     */
+    private configureTests;
+    /**
+     * Configure a give package
+     */
+    private configurePackage;
     /**
      * Invoked automatically by ace
      */

package/build/commands/Invoke.js

@@ -7,40 +7,18 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 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 __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = require("path");
+const sink_1 = require("@adonisjs/sink");
 const standalone_1 = require("@adonisjs/core/build/standalone");
 const Manifest_1 = require("../src/Manifest");
 /**
@@ -51,55 +29,139 @@ class Configure extends standalone_1.BaseCommand {
      * Configure encore
      */
     async configureEncore() {
-        const { files, logger } = await Promise.resolve().then(() => __importStar(require('@adonisjs/sink')));
         /**
          * Create the webpack config file
          */
-        const webpackConfigFile = new files.MustacheFile(this.application.appRoot, 'webpack.config.js', (0, path_1.join)(__dirname, '..', 'templates/webpack.config.txt'));
+        const webpackConfigFile = new sink_1.files.MustacheFile(this.application.appRoot, 'webpack.config.js', (0, path_1.join)(__dirname, '..', 'templates/webpack.config.txt'));
         if (!webpackConfigFile.exists()) {
             webpackConfigFile.apply({}).commit();
-            logger.action('create').succeeded('webpack.config.js');
+            sink_1.logger.action('create').succeeded('webpack.config.js');
         }
         /**
          * Create app.js entrypoint
          */
-        const entryPointFile = new files.NewLineFile(this.application.appRoot, 'resources/js/app.js');
+        const entryPointFile = new sink_1.files.NewLineFile(this.application.appRoot, 'resources/js/app.js');
         if (!entryPointFile.exists()) {
             entryPointFile.add('// app entrypoint').commit();
-            logger.action('create').succeeded('resources/js/app.js');
+            sink_1.logger.action('create').succeeded('resources/js/app.js');
         }
-        const pkgFile = new files.PackageJsonFile(this.application.appRoot);
+        /**
+         * Install Encore
+         */
+        const pkgFile = new sink_1.files.PackageJsonFile(this.application.appRoot);
         pkgFile.install('@symfony/webpack-encore');
-        const spinner = logger.await(logger.colors.gray('installing @symfony/webpack-encore'));
+        const spinner = sink_1.logger.await(sink_1.logger.colors.gray('installing @symfony/webpack-encore'));
         try {
             await pkgFile.commitAsync();
             spinner.update('Installed');
+            spinner.stop();
         }
         catch (error) {
             spinner.update('Unable to install the package');
-            logger.fatal(error);
+            spinner.stop();
+            sink_1.logger.fatal(error);
         }
     }
     /**
-     * Invoked automatically by ace
+     * Configure tests
      */
-    async run() {
-        if (this.name === 'encore') {
+    async configureTests() {
+        /**
+         * Create "test.ts" file
+         */
+        const testsEntryPointFile = new sink_1.files.MustacheFile(this.application.appRoot, 'test.ts', (0, path_1.join)(__dirname, '..', 'templates/test-entrypoint.txt'));
+        if (!testsEntryPointFile.exists()) {
+            testsEntryPointFile.apply({}).commit();
+            sink_1.logger.action('create').succeeded('test.ts');
+        }
+        /**
+         * Create "tests/bootstrap.ts" file
+         */
+        const testsBootstrapFile = new sink_1.files.MustacheFile(this.application.appRoot, 'tests/bootstrap.ts', (0, path_1.join)(__dirname, '..', 'templates/tests/bootstrap.txt'));
+        if (!testsBootstrapFile.exists()) {
+            testsBootstrapFile.apply({}).commit();
+            sink_1.logger.action('create').succeeded('tests/bootstrap.ts');
+        }
+        /**
+         * Create "tests/functional/hello_world.spec.ts" file
+         */
+        const helloWorldTestFile = new sink_1.files.MustacheFile(this.application.appRoot, 'tests/functional/hello_world.spec.ts', (0, path_1.join)(__dirname, '..', 'templates/tests/functional/hello_world.spec.txt'));
+        if (!helloWorldTestFile.exists()) {
+            helloWorldTestFile.apply({}).commit();
+            sink_1.logger.action('create').succeeded('tests/functional/hello_world.spec.ts');
+        }
+        /**
+         * Create "contracts/tests.ts" file
+         */
+        const testsContractsFile = new sink_1.files.MustacheFile(this.application.appRoot, 'contracts/tests.ts', (0, path_1.join)(__dirname, '..', 'templates/tests-contract.txt'));
+        if (!testsContractsFile.exists()) {
+            testsContractsFile.apply({}).commit();
+            sink_1.logger.action('create').succeeded('contracts/tests.ts');
+        }
+        /**
+         * Update AdonisRc file with test suites
+         */
+        const rcFile = new sink_1.files.AdonisRcFile(this.application.appRoot);
+        rcFile.set('tests', {
+            suites: [
+                {
+                    name: 'functional',
+                    files: ['tests/functional/**/*.spec(.ts|.js)'],
+                    timeout: 60 * 1000,
+                },
+            ],
+        });
+        rcFile.commit();
+        sink_1.logger.action('update').succeeded('.adonisrc.json');
+        /**
+         * Install required dependencies
+         */
+        const pkgFile = new sink_1.files.PackageJsonFile(this.application.appRoot);
+        pkgFile.install('@japa/runner');
+        pkgFile.install('@japa/preset-adonis');
+        const spinner = sink_1.logger.await(sink_1.logger.colors.gray('installing @japa/runner, @japa/preset-adonis'));
+        try {
+            await pkgFile.commitAsync();
+            spinner.update('Installed');
+            spinner.stop();
+        }
+        catch (error) {
+            spinner.update('Unable to install packages');
+            spinner.stop();
+            sink_1.logger.fatal(error);
+        }
+    }
+    /**
+     * Configure a give package
+     */
+    async configurePackage(name) {
+        if (name === 'encore') {
             await this.configureEncore();
             return;
         }
-        const { tasks } = await Promise.resolve().then(() => __importStar(require('@adonisjs/sink')));
-        await new tasks.Instructions(this.name, this.application.appRoot, this.application, true).execute();
+        if (name === 'tests') {
+            await this.configureTests();
+            return;
+        }
+        await new sink_1.tasks.Instructions(name, this.application.appRoot, this.application, true).execute();
         await new Manifest_1.Manifest(this.application.appRoot, this.logger).generate();
     }
+    /**
+     * Invoked automatically by ace
+     */
+    async run() {
+        for (let name of this.packages) {
+            await this.configurePackage(name);
+        }
+    }
 }
 Configure.commandName = 'configure';
-Configure.description = 'Configure a given AdonisJS package';
+Configure.description = 'Configure one or more AdonisJS packages';
 Configure.aliases = ['invoke'];
 __decorate([
-    standalone_1.args.string({
-        description: 'Name of the package you want to configure',
+    standalone_1.args.spread({
+        description: 'Name of the package(s) you want to configure',
     }),
-    __metadata("design:type", String)
-], Configure.prototype, "name", void 0);
+    __metadata("design:type", Array)
+], Configure.prototype, "packages", void 0);
 exports.default = Configure;

package/build/commands/Make/Test.d.ts

@@ -0,0 +1,35 @@
+import { BaseGenerator } from './Base';
+/**
+ * Command to make a new test
+ */
+export default class MakeTest extends BaseGenerator {
+    /**
+     * Required by BaseGenerator
+     */
+    protected extname: string;
+    protected form: "singular";
+    protected pattern: "snakecase";
+    protected resourceName: string;
+    protected createExact: boolean;
+    /**
+     * Command meta data
+     */
+    static commandName: string;
+    static description: string;
+    suite: string;
+    name: string;
+    exact: boolean;
+    /**
+     * Returns the template stub path
+     */
+    protected getStub(): string;
+    /**
+     * The file is created inside the parent directory of the first
+     * glob pattern
+     */
+    protected getDestinationPath(): string;
+    protected templateData(): {
+        name: string;
+    };
+    run(): Promise<void>;
+}

package/build/commands/Make/Test.js

@@ -0,0 +1,96 @@
+"use strict";
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * 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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const glob_parent_1 = __importDefault(require("glob-parent"));
+const helpers_1 = require("@poppinss/utils/build/helpers");
+const standalone_1 = require("@adonisjs/core/build/standalone");
+const Base_1 = require("./Base");
+/**
+ * Command to make a new test
+ */
+class MakeTest extends Base_1.BaseGenerator {
+    constructor() {
+        super(...arguments);
+        /**
+         * Required by BaseGenerator
+         */
+        this.extname = '.spec.ts';
+        this.form = 'singular';
+        this.pattern = 'snakecase';
+    }
+    /**
+     * Returns the template stub path
+     */
+    getStub() {
+        return (0, path_1.join)(__dirname, '..', '..', 'templates', 'test.txt');
+    }
+    /**
+     * The file is created inside the parent directory of the first
+     * glob pattern
+     */
+    getDestinationPath() {
+        const testSuites = this.application.rcFile.tests.suites;
+        const mentionedSuite = testSuites.find(({ name }) => this.suite === name);
+        const suiteGlob = Array.isArray(mentionedSuite.files)
+            ? mentionedSuite.files[0]
+            : mentionedSuite.files;
+        return (0, glob_parent_1.default)(suiteGlob);
+    }
+    templateData() {
+        return {
+            name: helpers_1.string.sentenceCase(this.name),
+        };
+    }
+    async run() {
+        const testSuites = this.application.rcFile.tests.suites;
+        const mentionedSuite = testSuites.find(({ name }) => this.suite === name);
+        if (!mentionedSuite) {
+            this.logger.error(`Invalid suite "${this.suite}". Make sure the suite is registered inside the .adonisrc.json file`);
+            return;
+        }
+        this.resourceName = this.name;
+        this.createExact = this.exact;
+        await super.generate();
+    }
+}
+/**
+ * Command meta data
+ */
+MakeTest.commandName = 'make:test';
+MakeTest.description = 'Make a new test';
+__decorate([
+    standalone_1.args.string({ description: 'Name of the test suite' }),
+    __metadata("design:type", String)
+], MakeTest.prototype, "suite", void 0);
+__decorate([
+    standalone_1.args.string({ description: 'Name of the test file' }),
+    __metadata("design:type", String)
+], MakeTest.prototype, "name", void 0);
+__decorate([
+    standalone_1.flags.boolean({
+        description: 'Create the test file with the exact name as provided',
+        alias: 'e',
+    }),
+    __metadata("design:type", Boolean)
+], MakeTest.prototype, "exact", void 0);
+exports.default = MakeTest;

package/build/commands/Test.d.ts

@@ -0,0 +1,49 @@
+import { BaseCommand } from '@adonisjs/core/build/standalone';
+/**
+ * Run tests
+ */
+export default class Test extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static settings: {
+        stayAlive: boolean;
+    };
+    suites: string[];
+    /**
+     * Allows watching for file changes
+     */
+    files: string[];
+    /**
+     * Allows watching for file changes
+     */
+    watch: boolean;
+    /**
+     * Detect changes by polling files
+     */
+    poll: boolean;
+    /**
+     * Arguments to pass to the `node` binary
+     */
+    nodeArgs: string[];
+    /**
+     * Filter by tags
+     */
+    tags: string[];
+    /**
+     * Filter by tags
+     */
+    ignoreTags: string[];
+    /**
+     * Customize tests timeout
+     */
+    timeout: number;
+    /**
+     * Force exit the tests runner
+     */
+    forceExit: boolean;
+    /**
+     * Convert command flags to test filters
+     */
+    private getTestFilters;
+    run(): Promise<void>;
+}

package/build/commands/Test.js

@@ -0,0 +1,145 @@
+"use strict";
+/*
+ * @adonisjs/assembler
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const standalone_1 = require("@adonisjs/core/build/standalone");
+/**
+ * Run tests
+ */
+class Test extends standalone_1.BaseCommand {
+    constructor() {
+        super(...arguments);
+        /**
+         * Arguments to pass to the `node` binary
+         */
+        this.nodeArgs = [];
+    }
+    /**
+     * Convert command flags to test filters
+     */
+    getTestFilters() {
+        const filters = {};
+        if (this.forceExit) {
+            filters['--force-exit'] = true;
+        }
+        if (this.files) {
+            filters['--files'] = this.files;
+        }
+        if (this.timeout !== undefined) {
+            filters['--timeout'] = this.timeout;
+        }
+        if (this.tags) {
+            filters['--tags'] = this.tags;
+        }
+        if (this.suites) {
+            filters._ = this.suites;
+        }
+        if (this.ignoreTags) {
+            filters['--ignore-tags'] = this.ignoreTags;
+        }
+        return filters;
+    }
+    async run() {
+        const { TestsServer } = await Promise.resolve().then(() => __importStar(require('../src/Test')));
+        try {
+            if (this.watch) {
+                await new TestsServer(this.application.appRoot, this.getTestFilters(), this.nodeArgs, this.logger).watch();
+            }
+            else {
+                await new TestsServer(this.application.appRoot, this.getTestFilters(), this.nodeArgs, this.logger).run();
+            }
+        }
+        catch (error) {
+            this.exitCode = 1;
+            this.logger.fatal(error);
+        }
+    }
+}
+Test.commandName = 'test';
+Test.description = 'Run AdonisJS tests';
+Test.settings = {
+    stayAlive: true,
+};
+__decorate([
+    standalone_1.args.spread({ description: 'Run tests for only the specified suites', required: false }),
+    __metadata("design:type", Array)
+], Test.prototype, "suites", void 0);
+__decorate([
+    standalone_1.flags.array({
+        description: 'Run tests for the mentioned files only',
+    }),
+    __metadata("design:type", Array)
+], Test.prototype, "files", void 0);
+__decorate([
+    standalone_1.flags.boolean({
+        description: 'Watch for file changes and re-run tests on file change',
+        alias: 'w',
+    }),
+    __metadata("design:type", Boolean)
+], Test.prototype, "watch", void 0);
+__decorate([
+    standalone_1.flags.boolean({
+        description: 'Detect file changes by polling files instead of listening to filesystem events',
+        alias: 'p',
+    }),
+    __metadata("design:type", Boolean)
+], Test.prototype, "poll", void 0);
+__decorate([
+    standalone_1.flags.array({ description: 'CLI options to pass to the node command line' }),
+    __metadata("design:type", Array)
+], Test.prototype, "nodeArgs", void 0);
+__decorate([
+    standalone_1.flags.array({ description: 'Filter tests by tags' }),
+    __metadata("design:type", Array)
+], Test.prototype, "tags", void 0);
+__decorate([
+    standalone_1.flags.array({ description: 'Filter tests by ignoring tags' }),
+    __metadata("design:type", Array)
+], Test.prototype, "ignoreTags", void 0);
+__decorate([
+    standalone_1.flags.number({ description: 'Customize tests timeout' }),
+    __metadata("design:type", Number)
+], Test.prototype, "timeout", void 0);
+__decorate([
+    standalone_1.flags.boolean({ description: 'Force exit the tests runner process' }),
+    __metadata("design:type", Boolean)
+], Test.prototype, "forceExit", void 0);
+exports.default = Test;