@adonisjs/assembler 5.5.1-0 → 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",
@@ -371,6 +403,12 @@
       ],
       "aliases": [],
       "flags": [
+        {
+          "name": "files",
+          "propertyName": "files",
+          "type": "array",
+          "description": "Run tests for the mentioned files only"
+        },
         {
           "name": "watch",
           "propertyName": "watch",

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

@@ -9,6 +9,10 @@ export default class Test extends BaseCommand {
         stayAlive: boolean;
     };
     suites: string[];
+    /**
+     * Allows watching for file changes
+     */
+    files: string[];
     /**
      * Allows watching for file changes
      */

package/build/commands/Test.js

@@ -60,6 +60,9 @@ class Test extends standalone_1.BaseCommand {
         if (this.forceExit) {
             filters['--force-exit'] = true;
         }
+        if (this.files) {
+            filters['--files'] = this.files;
+        }
         if (this.timeout !== undefined) {
             filters['--timeout'] = this.timeout;
         }
@@ -99,6 +102,12 @@ __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',

package/build/src/Test/index.js

@@ -253,9 +253,7 @@ class TestsServer {
                 return;
             }
             this.logger.action('create').succeeded(relativePath);
-            if (metaData.reload) {
-                await this.run();
-            }
+            await this.run();
         });
         /**
          * File changed
@@ -274,9 +272,7 @@ class TestsServer {
                 return;
             }
             this.logger.action('update').succeeded(relativePath);
-            if (metaData.reload || metaData.rcFile) {
-                await this.run();
-            }
+            await this.run();
         });
         /**
          * File removed
@@ -301,9 +297,7 @@ class TestsServer {
                 return;
             }
             this.logger.action('delete').succeeded(relativePath);
-            if (metaData.reload) {
-                await this.run();
-            }
+            await this.run();
         });
         /**
          * Start the watcher

package/build/templates/test-entrypoint.txt

@@ -0,0 +1,45 @@
+/*
+|--------------------------------------------------------------------------
+| Tests
+|--------------------------------------------------------------------------
+|
+| The contents in this file boots the AdonisJS application and configures
+| the Japa tests runner.
+|
+| For the most part you will never edit this file. The configuration
+| for the tests can be controlled via ".adonisrc.json" and
+| "tests/bootstrap.ts" files.
+|
+*/
+
+process.env.NODE_ENV = 'testing'
+
+import 'reflect-metadata'
+import sourceMapSupport from 'source-map-support'
+import { Ignitor } from '@adonisjs/core/build/standalone'
+import { configure, processCliArgs, run, RunnerHooksHandler } from '@japa/runner'
+
+sourceMapSupport.install({ handleUncaughtExceptions: false })
+
+const kernel = new Ignitor(__dirname).kernel('test')
+
+kernel
+  .boot()
+  .then(() => import('./tests/bootstrap'))
+  .then(({ runnerHooks, ...config }) => {
+    const app: RunnerHooksHandler[] = [() => kernel.start()]
+
+    configure({
+      ...kernel.application.rcFile.tests,
+      ...processCliArgs(process.argv.slice(2)),
+      ...config,
+      ...{
+        importer: (filePath) => import(filePath),
+        setup: app.concat(runnerHooks.setup),
+        teardown: runnerHooks.teardown,
+      },
+      cwd: kernel.application.appRoot
+    })
+
+    run()
+  })

package/build/templates/test.txt

@@ -0,0 +1,5 @@
+import { test } from '@japa/runner'
+
+test.group('{{ name }}', () => {
+  // Write your test here
+})

package/build/templates/tests-contract.txt

@@ -0,0 +1,18 @@
+/**
+ * Contract source: https://github.com/adonisjs/core/blob/master/templates/contracts/tests.txt
+ *
+ * Feel free to let us know via PR, if you find something broken in this contract
+ * file.
+ */
+
+import '@japa/runner'
+
+declare module '@japa/runner' {
+  interface TestContext {
+    // Extend context
+  }
+
+  interface Test<DataSet> {
+    // Extend test
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "5.5.1-0",
+  "version": "5.5.2-0",
   "description": "Core commands to compiler and build AdonisJs project",
   "main": "build/ace-manifest.json",
   "files": [
@@ -44,27 +44,27 @@
   },
   "homepage": "https://github.com/adonisjs/assembler#readme",
   "devDependencies": {
-    "@adonisjs/ace": "^11.2.2",
-    "@adonisjs/core": "^5.5.3",
-    "@adonisjs/mrm-preset": "^5.0.2",
-    "@poppinss/dev-utils": "^2.0.2",
-    "@types/node": "^17.0.21",
+    "@adonisjs/ace": "^11.2.3",
+    "@adonisjs/core": "^5.6.2",
+    "@adonisjs/mrm-preset": "^5.0.3",
+    "@poppinss/dev-utils": "^2.0.3",
+    "@types/node": "^17.0.23",
     "commitizen": "^4.2.4",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
-    "eslint": "^8.10.0",
+    "eslint": "^8.12.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "github-label-sync": "^2.0.2",
+    "github-label-sync": "^2.2.0",
     "husky": "^7.0.4",
     "japa": "^4.0.0",
-    "mrm": "^3.0.10",
-    "np": "^7.6.0",
-    "prettier": "^2.5.1",
-    "typescript": "^4.6.2"
+    "mrm": "^4.0.0",
+    "np": "^7.6.1",
+    "prettier": "^2.6.2",
+    "typescript": "^4.6.3"
   },
   "nyc": {
     "exclude": [
@@ -89,19 +89,20 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@adonisjs/application": "^5.2.0",
-    "@adonisjs/env": "^3.0.7",
+    "@adonisjs/application": "^5.2.1",
+    "@adonisjs/env": "^3.0.8",
     "@adonisjs/ioc-transformer": "^2.3.3",
-    "@adonisjs/require-ts": "^2.0.10",
+    "@adonisjs/require-ts": "^2.0.11",
     "@adonisjs/sink": "^5.2.2",
-    "@poppinss/chokidar-ts": "^3.3.4",
-    "@poppinss/cliui": "^3.0.1",
-    "@poppinss/utils": "^4.0.2",
+    "@poppinss/chokidar-ts": "^3.3.5",
+    "@poppinss/cliui": "^3.0.2",
+    "@poppinss/utils": "^4.0.3",
     "cpy": "^8.1.2",
-    "emittery": "^0.10.1",
+    "emittery": "^0.10.2",
     "execa": "^5.1.1",
     "fs-extra": "^10.0.1",
     "get-port": "^5.1.1",
+    "glob-parent": "^6.0.2",
     "has-yarn": "^2.1.0",
     "picomatch": "^2.3.1",
     "slash": "^3.0.0"