@adonisjs/assembler 5.6.0 → 5.7.0

package/build/ace-manifest.json

@@ -259,6 +259,37 @@
         }
       ]
     },
+    "make:suite": {
+      "settings": {},
+      "commandPath": "./commands/Make/Suite",
+      "commandName": "make:suite",
+      "description": "Create a new test suite",
+      "args": [
+        {
+          "type": "string",
+          "propertyName": "suite",
+          "name": "suite",
+          "required": true,
+          "description": "Name of the test suite"
+        },
+        {
+          "type": "string",
+          "propertyName": "location",
+          "name": "location",
+          "required": false,
+          "description": "Path to the test suite directory"
+        }
+      ],
+      "aliases": [],
+      "flags": [
+        {
+          "name": "with-example-test",
+          "propertyName": "withExampleTest",
+          "type": "boolean",
+          "description": "Add a sample test file"
+        }
+      ]
+    },
     "make:test": {
       "settings": {},
       "commandPath": "./commands/Make/Test",
@@ -441,6 +472,12 @@
           "type": "array",
           "description": "Filter tests by ignoring tags"
         },
+        {
+          "name": "tests",
+          "propertyName": "tests",
+          "type": "array",
+          "description": "Filter tests by title"
+        },
         {
           "name": "timeout",
           "propertyName": "timeout",

package/build/commands/Invoke.js

@@ -115,6 +115,7 @@ class Configure extends standalone_1.BaseCommand {
                 },
             ],
         });
+        rcFile.addTestProvider('@japa/preset-adonis/TestsProvider');
         rcFile.commit();
         sink_1.logger.action('update').succeeded('.adonisrc.json');
         /**
@@ -132,6 +133,25 @@ class Configure extends standalone_1.BaseCommand {
             testEnvFile.commit();
             sink_1.logger.action('create').succeeded('.env.test');
         }
+        /**
+         * Update "tsconfig.json"
+         */
+        const tsConfig = new sink_1.files.JsonFile(this.application.appRoot, 'tsconfig.json');
+        const existingTypes = tsConfig.get('compilerOptions.types') || [];
+        if (!existingTypes.includes('@japa/preset-adonis/build/adonis-typings')) {
+            existingTypes.push('@japa/preset-adonis/build/adonis-typings');
+        }
+        tsConfig.set('compilerOptions.types', existingTypes);
+        tsConfig.commit();
+        sink_1.logger.action('update').succeeded('tsconfig.json');
+        /**
+         * Set additional .env variables for "web" boilerplate
+         */
+        if (this.appType === 'web') {
+            testEnvFile.add(['ASSETS_DRIVER=fake', 'SESSION_DRIVER=memory']);
+        }
+        testEnvFile.commit();
+        sink_1.logger.action('create').succeeded('.env.test');
         /**
          * Install required dependencies
          */

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

@@ -0,0 +1,41 @@
+import { BaseCommand } from '@adonisjs/core/build/standalone';
+/**
+ * Create a new test suite
+ */
+export default class CreateSuite extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    /**
+     * Name of the test suite to be created
+     */
+    suite: string;
+    /**
+     * Glob pattern for the test suite, or only location to the test suite
+     */
+    location: string;
+    /**
+     * Should add a sample test file
+     */
+    withExampleTest: boolean;
+    /**
+     * Get the destination path for the sample test file
+     */
+    private getExampleTestDestinationPath;
+    /**
+     * Generate suite glob pattern based on `location` argument
+     */
+    private generateSuiteGlobPattern;
+    /**
+     * Check if the suite name is already defined in RcFile
+     */
+    private checkIfSuiteExists;
+    /**
+     * Add the new test suite to the AdonisRC File and save it
+     */
+    private addSuiteToRcFile;
+    /**
+     * Add a sample test file to the new suite folder
+     */
+    private createSampleTestFile;
+    run(): Promise<void>;
+}

package/build/commands/Make/Suite.js

@@ -0,0 +1,120 @@
+"use strict";
+/*
+ * @adonisjs/assembler
+ *
+ * (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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const standalone_1 = require("@adonisjs/core/build/standalone");
+const sink_1 = require("@adonisjs/sink");
+const glob_parent_1 = __importDefault(require("glob-parent"));
+const path_1 = require("path");
+/**
+ * Create a new test suite
+ */
+class CreateSuite extends standalone_1.BaseCommand {
+    constructor() {
+        super(...arguments);
+        /**
+         * Glob pattern for the test suite, or only location to the test suite
+         */
+        this.location = '';
+        /**
+         * Should add a sample test file
+         */
+        this.withExampleTest = true;
+    }
+    /**
+     * Get the destination path for the sample test file
+     */
+    getExampleTestDestinationPath() {
+        return (0, glob_parent_1.default)(this.location) + '/test.spec.ts';
+    }
+    /**
+     * Generate suite glob pattern based on `location` argument
+     */
+    generateSuiteGlobPattern() {
+        if (!this.location) {
+            this.location = `tests/${this.suite}`;
+        }
+        if (!['*', '.js', '.ts'].find((keyword) => this.location.includes(keyword))) {
+            this.location = `${this.location}/**/*.spec(.ts|.js)`;
+        }
+    }
+    /**
+     * Check if the suite name is already defined in RcFile
+     */
+    checkIfSuiteExists(rcFile) {
+        const existingSuites = rcFile.get('tests.suites') || [];
+        const existingSuitesNames = existingSuites.map((suite) => suite.name);
+        return existingSuitesNames.includes(this.suite);
+    }
+    /**
+     * Add the new test suite to the AdonisRC File and save it
+     */
+    async addSuiteToRcFile() {
+        const rcFile = new sink_1.files.AdonisRcFile(this.application.appRoot);
+        const existingSuites = rcFile.get('tests.suites') || [];
+        if (this.checkIfSuiteExists(rcFile)) {
+            return sink_1.logger.action('update').skipped(`Suite ${this.suite} already exists`);
+        }
+        rcFile.set('tests.suites', [
+            ...existingSuites,
+            {
+                name: this.suite,
+                files: [this.location],
+                timeout: 60 * 1000,
+            },
+        ]);
+        rcFile.commit();
+        sink_1.logger.action('update').succeeded('.adonisrc.json');
+    }
+    /**
+     * Add a sample test file to the new suite folder
+     */
+    createSampleTestFile() {
+        const path = this.getExampleTestDestinationPath();
+        const testFile = new sink_1.files.MustacheFile(this.application.appRoot, path, (0, path_1.join)(__dirname, '../..', 'templates/test.txt'));
+        if (!testFile.exists()) {
+            testFile.apply({}).commit();
+            sink_1.logger.action('create').succeeded(path);
+        }
+    }
+    async run() {
+        this.generateSuiteGlobPattern();
+        await this.addSuiteToRcFile();
+        if (this.withExampleTest) {
+            this.createSampleTestFile();
+        }
+    }
+}
+CreateSuite.commandName = 'make:suite';
+CreateSuite.description = 'Create a new test suite';
+__decorate([
+    standalone_1.args.string({ description: 'Name of the test suite' }),
+    __metadata("design:type", String)
+], CreateSuite.prototype, "suite", void 0);
+__decorate([
+    standalone_1.args.string({ description: 'Path to the test suite directory', required: false }),
+    __metadata("design:type", String)
+], CreateSuite.prototype, "location", void 0);
+__decorate([
+    standalone_1.flags.boolean({ description: 'Add a sample test file' }),
+    __metadata("design:type", Boolean)
+], CreateSuite.prototype, "withExampleTest", void 0);
+exports.default = CreateSuite;

package/build/commands/Test.d.ts

@@ -33,6 +33,10 @@ export default class Test extends BaseCommand {
      * Filter by tags
      */
     ignoreTags: string[];
+    /**
+     * Filter by test title
+     */
+    tests: string[];
     /**
      * Customize tests timeout
      */

package/build/commands/Test.js

@@ -75,6 +75,9 @@ class Test extends standalone_1.BaseCommand {
         if (this.ignoreTags) {
             filters['--ignore-tags'] = this.ignoreTags;
         }
+        if (this.tests) {
+            filters['--tests'] = this.tests;
+        }
         return filters;
     }
     async run() {
@@ -134,6 +137,10 @@ __decorate([
     standalone_1.flags.array({ description: 'Filter tests by ignoring tags' }),
     __metadata("design:type", Array)
 ], Test.prototype, "ignoreTags", void 0);
+__decorate([
+    standalone_1.flags.array({ description: 'Filter tests by title' }),
+    __metadata("design:type", Array)
+], Test.prototype, "tests", void 0);
 __decorate([
     standalone_1.flags.number({ description: 'Customize tests timeout' }),
     __metadata("design:type", Number)

package/build/src/Test/index.d.ts

@@ -44,6 +44,10 @@ export declare class TestsServer {
      */
     private isTestFile;
     constructor(appRoot: string, filters: JapaFlags, nodeArgs?: string[], logger?: typeof uiLogger);
+    /**
+     * Clear terminal screen
+     */
+    private clearScreen;
     /**
      * Returns the glob paths for test suites. Returns all if no
      * filter is applied. Otherwise only the filtered suites

package/build/src/Test/index.js

@@ -79,6 +79,12 @@ class TestsServer {
             });
         };
     }
+    /**
+     * Clear terminal screen
+     */
+    clearScreen() {
+        process.stdout.write('\u001Bc');
+    }
     /**
      * Returns the glob paths for test suites. Returns all if no
      * filter is applied. Otherwise only the filtered suites
@@ -129,6 +135,7 @@ class TestsServer {
         if (this.busy) {
             return;
         }
+        this.clearScreen();
         const filters = { ...this.filters };
         /**
          * Overwrite files filter when a specific file path

package/build/src/Test/process.js

@@ -35,11 +35,13 @@ class TestProcess {
         this.logger.info('running tests...');
         const filters = Object.keys(this.filters).reduce((result, filter) => {
             const value = this.filters[filter];
-            if (filter !== '_') {
-                result.push(filter);
+            if (filter === '_') {
+                result.push(...value);
+                return result;
             }
+            result.push(filter);
             if (Array.isArray(value)) {
-                result.push(...value);
+                result.push(value.join(','));
             }
             else {
                 result.push(value);

package/build/templates/validator.txt

@@ -1,4 +1,4 @@
-import { schema } from '@ioc:Adonis/Core/Validator'
+import { schema, CustomMessages } from '@ioc:Adonis/Core/Validator'
 import type { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
 export default class {{ filename }} {
@@ -36,5 +36,5 @@ export default class {{ filename }} {
    * }
    *
    */
-  public messages = {}
+  public messages: CustomMessages = {}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "Core commands to compiler and build AdonisJs project",
   "main": "build/ace-manifest.json",
   "files": [
@@ -15,9 +15,9 @@
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "cross-env FORCE_COLOR=true node .bin/test.js",
+    "test": "cross-env FORCE_COLOR=true node -r @adonisjs/require-ts/build/register ./bin/test.ts",
     "lint": "eslint . --ext=.ts",
-    "clean": "del build",
+    "clean": "del-cli build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile && node build/bin/index.js && copyfiles \"templates/**\" build",
     "commit": "git-cz",
@@ -44,23 +44,26 @@
   },
   "homepage": "https://github.com/adonisjs/assembler#readme",
   "devDependencies": {
-    "@adonisjs/ace": "^11.2.3",
-    "@adonisjs/core": "^5.6.2",
+    "@adonisjs/ace": "^11.3.1",
+    "@adonisjs/core": "^5.8.2",
     "@adonisjs/mrm-preset": "^5.0.3",
+    "@japa/assert": "^1.3.4",
+    "@japa/run-failed-tests": "^1.0.7",
+    "@japa/runner": "^2.0.8",
+    "@japa/spec-reporter": "^1.1.12",
     "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.23",
+    "@types/node": "^17.0.35",
     "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.12.0",
+    "eslint": "^8.16.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "github-label-sync": "^2.2.0",
-    "husky": "^7.0.4",
-    "japa": "^4.0.0",
+    "husky": "^8.0.1",
     "mrm": "^4.0.0",
     "np": "^7.6.1",
     "prettier": "^2.6.2",
@@ -89,16 +92,16 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@adonisjs/application": "^5.2.1",
-    "@adonisjs/env": "^3.0.8",
-    "@adonisjs/ioc-transformer": "^2.3.3",
-    "@adonisjs/require-ts": "^2.0.11",
-    "@adonisjs/sink": "^5.2.2",
+    "@adonisjs/application": "^5.2.4",
+    "@adonisjs/env": "^3.0.9",
+    "@adonisjs/ioc-transformer": "^2.3.4",
+    "@adonisjs/require-ts": "^2.0.12",
+    "@adonisjs/sink": "^5.3.2",
     "@poppinss/chokidar-ts": "^3.3.5",
     "@poppinss/cliui": "^3.0.2",
-    "@poppinss/utils": "^4.0.3",
+    "@poppinss/utils": "^4.0.4",
     "cpy": "^8.1.2",
-    "emittery": "^0.10.2",
+    "emittery": "^0.11.0",
     "execa": "^5.1.1",
     "fs-extra": "^10.0.1",
     "get-port": "^5.1.1",