@adonisjs/assembler 5.3.6 → 5.4.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright 2021 Harminder Virk, contributors
+Copyright 2022 Harminder Virk, contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/build/ace-manifest.json

@@ -352,6 +352,22 @@
           "description": "CLI options to pass to the encore command line"
         }
       ]
+    },
+    "type-check": {
+      "settings": {},
+      "commandPath": "./commands/TypeCheck",
+      "commandName": "type-check",
+      "description": "Type check TypeScript source without writing the compiled output on disk",
+      "args": [],
+      "aliases": [],
+      "flags": [
+        {
+          "name": "tsconfig",
+          "propertyName": "tsconfig",
+          "type": "string",
+          "description": "Path to the TypeScript project configuration file"
+        }
+      ]
     }
   },
   "aliases": {

package/build/commands/TypeCheck.d.ts

@@ -0,0 +1,16 @@
+import { BaseCommand } from '@adonisjs/core/build/standalone';
+/**
+ * TypeCheck project without writing the compiled output to the disk
+ */
+export default class TypeCheck extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    /**
+     * Path to the TypeScript project configuration file. Defaults to "tsconfig.json"
+     */
+    tsconfig: string;
+    /**
+     * Invoked automatically by ace
+     */
+    run(): Promise<void>;
+}

package/build/commands/TypeCheck.js

@@ -0,0 +1,81 @@
+"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;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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");
+const paths_1 = require("../config/paths");
+/**
+ * TypeCheck project without writing the compiled output to the disk
+ */
+class TypeCheck extends standalone_1.BaseCommand {
+    constructor() {
+        super(...arguments);
+        /**
+         * Path to the TypeScript project configuration file. Defaults to "tsconfig.json"
+         */
+        this.tsconfig = paths_1.TSCONFIG_FILE_NAME;
+    }
+    /**
+     * Invoked automatically by ace
+     */
+    async run() {
+        const { Compiler } = await Promise.resolve().then(() => __importStar(require('../src/Compiler')));
+        try {
+            const compiler = new Compiler(this.application.appRoot, [], false, this.logger, this.tsconfig);
+            const success = await compiler.typeCheck();
+            /**
+             * Set exitCode based upon the typecheck status
+             */
+            if (!success) {
+                this.exitCode = 1;
+            }
+        }
+        catch (error) {
+            this.logger.fatal(error);
+            this.exitCode = 1;
+        }
+    }
+}
+TypeCheck.commandName = 'type-check';
+TypeCheck.description = 'Type check TypeScript source without writing the compiled output on disk';
+__decorate([
+    standalone_1.flags.string({
+        description: 'Path to the TypeScript project configuration file',
+    }),
+    __metadata("design:type", String)
+], TypeCheck.prototype, "tsconfig", void 0);
+exports.default = TypeCheck;

package/build/src/AssetsBundler/index.js

@@ -201,7 +201,7 @@ class AssetsBundler extends emittery_1.default {
          */
         let customPort = this.findCustomPort();
         if (!customPort) {
-            const randomPort = await (0, get_port_1.default)({ port: 8080 });
+            const randomPort = await (0, get_port_1.default)({ port: 8080, host: 'localhost' });
             customPort = String(randomPort);
             this.encoreArgs.push('--port', customPort);
         }

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

@@ -46,6 +46,10 @@ export declare class Compiler {
      * Log the message that ts build and failed
      */
     private logTsBuildFailed;
+    /**
+     * Typecheck the project without emit
+     */
+    typeCheck(): Promise<boolean>;
     /**
      * Compile project. See [[Compiler.compileForProduction]] for
      * production build

package/build/src/Compiler/index.js

@@ -120,6 +120,26 @@ class Compiler {
         this.logger.logError('');
         this.logger.logError(this.logger.colors.bgRed(`Cannot complete the build process as there are typescript errors. Use "--ignore-ts-errors" flag to ignore Typescript errors`));
     }
+    /**
+     * Typecheck the project without emit
+     */
+    async typeCheck() {
+        const config = this.ts.parseConfig();
+        if (!config) {
+            return false;
+        }
+        this.logger.info('type checking typescript source files');
+        config.options.noEmit = true;
+        const builder = this.ts.tsCompiler.builder(config);
+        const { diagnostics } = builder.build();
+        if (diagnostics.length) {
+            this.logger.error('typescript compiler errors');
+            this.ts.renderDiagnostics(diagnostics, builder.host);
+            return false;
+        }
+        this.logger.success('built successfully');
+        return true;
+    }
     /**
      * Compile project. See [[Compiler.compileForProduction]] for
      * production build

package/build/templates/command.txt

@@ -1,7 +1,6 @@
 import { BaseCommand } from '@adonisjs/core/build/standalone'
 
 export default class {{ filename }} extends BaseCommand {
-
   /**
    * Command name is used to run the command
    */
@@ -15,18 +14,20 @@ export default class {{ filename }} extends BaseCommand {
   public static settings = {
     /**
      * Set the following value to true, if you want to load the application
-     * before running the command
+     * before running the command. Don't forget to call `node ace generate:manifest` 
+     * afterwards.
      */
     loadApp: false,
 
     /**
      * Set the following value to true, if you want this command to keep running until
-     * you manually decide to exit the process
+     * you manually decide to exit the process. Don't forget to call 
+     * `node ace generate:manifest` afterwards.
      */
     stayAlive: false,
   }
 
-  public async run () {
+  public async run() {
     this.logger.info('Hello world!')
   }
 }

package/build/templates/controller.txt

@@ -1,4 +1,3 @@
 // import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
-export default class {{ filename }} {
-}
+export default class {{ filename }} {}

package/build/templates/event-listener.txt

@@ -1,4 +1,3 @@
 import { EventsList } from '@ioc:Adonis/Core/Event'
 
-export default class {{ filename }} {
-}
+export default class {{ filename }} {}

package/build/templates/exception.txt

@@ -12,5 +12,4 @@ import { Exception } from '@adonisjs/core/build/standalone'
 | new {{ filename }}('message', 500, 'E_RUNTIME_EXCEPTION')
 |
 */
-export default class {{ filename }} extends Exception {
-}
+export default class {{ filename }} extends Exception {}

package/build/templates/middleware.txt

@@ -1,7 +1,7 @@
 import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
 export default class {{ filename }} {
-  public async handle ({}: HttpContextContract, next: () => Promise<void>) {
+  public async handle({}: HttpContextContract, next: () => Promise<void>) {
     // code for middleware goes here. ABOVE THE NEXT CALL
     await next()
   }

package/build/templates/provider.txt

@@ -20,22 +20,21 @@ import { ApplicationContract } from '@ioc:Adonis/Core/Application'
 |
 */
 export default class {{ filename }} {
-  constructor (protected app: ApplicationContract) {
-  }
+  constructor(protected app: ApplicationContract) {}
 
-  public register () {
+  public register() {
     // Register your own bindings
   }
 
-  public async boot () {
+  public async boot() {
     // All bindings are ready, feel free to use them
   }
 
-  public async ready () {
+  public async ready() {
     // App is ready
   }
 
-  public async shutdown () {
+  public async shutdown() {
     // Cleanup, since app is going down
   }
 }

package/build/templates/resource-controller.txt

@@ -1,24 +1,17 @@
 import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
 export default class {{ filename }} {
-  public async index ({}: HttpContextContract) {
-  }
+  public async index({}: HttpContextContract) {}
 
-  public async create ({}: HttpContextContract) {
-  }
+  public async create({}: HttpContextContract) {}
 
-  public async store ({}: HttpContextContract) {
-  }
+  public async store({}: HttpContextContract) {}
 
-  public async show ({}: HttpContextContract) {
-  }
+  public async show({}: HttpContextContract) {}
 
-  public async edit ({}: HttpContextContract) {
-  }
+  public async edit({}: HttpContextContract) {}
 
-  public async update ({}: HttpContextContract) {
-  }
+  public async update({}: HttpContextContract) {}
 
-  public async destroy ({}: HttpContextContract) {
-  }
+  public async destroy({}: HttpContextContract) {}
 }

package/build/templates/self-handle-exception.txt

@@ -26,7 +26,7 @@ export default class {{ filename }} extends Exception {
    *   Giving you a chance to convert the exception to response.
    *
    */
-  public async handle (error: this, ctx: HttpContextContract) {
+  public async handle(error: this, ctx: HttpContextContract) {
     ctx.response.status(error.status || 500).send(error.message)
   }
 }

package/build/templates/validator.txt

@@ -2,41 +2,39 @@ import { schema } from '@ioc:Adonis/Core/Validator'
 import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
 export default class {{ filename }} {
-  constructor (protected ctx: HttpContextContract) {
-  }
+  constructor(protected ctx: HttpContextContract) {}
 
-	/*
-	 * Define schema to validate the "shape", "type", "formatting" and "integrity" of data.
-	 *
-	 * For example:
-	 * 1. The username must be of data type string. But then also, it should
-	 *    not contain special characters or numbers.
-	 *    ```
-	 *     schema.string({}, [ rules.alpha() ])
-	 *    ```
-	 *
-	 * 2. The email must be of data type string, formatted as a valid
-	 *    email. But also, not used by any other user.
-	 *    ```
-	 *     schema.string({}, [
-	 *       rules.email(),
-	 *       rules.unique({ table: 'users', column: 'email' }),
-	 *     ])
-	 *    ```
-	 */
-  public schema = schema.create({
-  })
+  /*
+   * Define schema to validate the "shape", "type", "formatting" and "integrity" of data.
+   *
+   * For example:
+   * 1. The username must be of data type string. But then also, it should
+   *    not contain special characters or numbers.
+   *    ```
+   *     schema.string({}, [ rules.alpha() ])
+   *    ```
+   *
+   * 2. The email must be of data type string, formatted as a valid
+   *    email. But also, not used by any other user.
+   *    ```
+   *     schema.string({}, [
+   *       rules.email(),
+   *       rules.unique({ table: 'users', column: 'email' }),
+   *     ])
+   *    ```
+   */
+  public schema = schema.create({})
 
-	/**
-	 * Custom messages for validation failures. You can make use of dot notation `(.)`
-	 * for targeting nested fields and array expressions `(*)` for targeting all
-	 * children of an array. For example:
-	 *
-	 * {
-	 *   'profile.username.required': 'Username is required',
-	 *   'scores.*.number': 'Define scores as valid numbers'
-	 * }
-	 *
-	 */
+  /**
+   * Custom messages for validation failures. You can make use of dot notation `(.)`
+   * for targeting nested fields and array expressions `(*)` for targeting all
+   * children of an array. For example:
+   *
+   * {
+   *   'profile.username.required': 'Username is required',
+   *   'scores.*.number': 'Define scores as valid numbers'
+   * }
+   *
+   */
   public messages = {}
 }

package/build/templates/webpack.config.txt

@@ -145,12 +145,6 @@ Encore.configureDevServerOptions((options) => {
     directory: join(__dirname, './resources/views'),
     watch: true,
   })
-
-  /**
-   * Reset client as webpack encore is using an unallowed "host"
-   * property.
-   */
-  options.client = {}
 })
 
 /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "5.3.6",
+  "version": "5.4.0",
   "description": "Core commands to compiler and build AdonisJs project",
   "main": "build/ace-manifest.json",
   "files": [
@@ -15,16 +15,17 @@
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "cross-env FORCE_COLOR=true node japaFile.js",
+    "test": "cross-env FORCE_COLOR=true node .bin/test.js",
     "lint": "eslint . --ext=.ts",
     "clean": "del build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile && node build/bin/index.js && copyfiles \"templates/*\" build",
     "commit": "git-cz",
-    "release": "np",
+    "release": "np --message=\"chore(release): %s\"",
     "version": "npm run build",
     "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/assembler",
-    "format": "prettier --write ."
+    "format": "prettier --write .",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -43,25 +44,28 @@
   },
   "homepage": "https://github.com/adonisjs/assembler#readme",
   "devDependencies": {
-    "@adonisjs/ace": "^11.0.4",
-    "@adonisjs/core": "^5.3.1",
-    "@adonisjs/mrm-preset": "^4.1.2",
-    "@poppinss/dev-utils": "^1.1.5",
-    "@types/node": "^16.7.6",
+    "@adonisjs/ace": "^11.0.6",
+    "@adonisjs/core": "^5.4.2",
+    "@adonisjs/mrm-preset": "^5.0.2",
+    "@adonisjs/require-ts": "^2.0.9",
+    "@poppinss/dev-utils": "^2.0.1",
+    "@types/node": "^17.0.9",
+    "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": "^7.32.0",
+    "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-adonis": "^1.3.3",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-adonis": "^2.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "github-label-sync": "^2.0.2",
-    "husky": "^7.0.2",
-    "japa": "^3.1.1",
-    "mrm": "^3.0.8",
-    "np": "^7.5.0",
-    "prettier": "^2.3.2",
-    "typescript": "^4.4.2"
+    "husky": "^7.0.4",
+    "japa": "^4.0.0",
+    "mrm": "^3.0.10",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.4"
   },
   "nyc": {
     "exclude": [
@@ -86,21 +90,20 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@adonisjs/application": "^5.1.6",
-    "@adonisjs/env": "^3.0.5",
+    "@adonisjs/application": "^5.1.9",
+    "@adonisjs/env": "^3.0.6",
     "@adonisjs/ioc-transformer": "^2.3.2",
-    "@adonisjs/require-ts": "^2.0.8",
-    "@adonisjs/sink": "^5.1.6",
-    "@poppinss/chokidar-ts": "^3.3.2",
-    "@poppinss/cliui": "^2.2.5",
-    "@poppinss/utils": "^3.2.0",
+    "@adonisjs/sink": "^5.2.1",
+    "@poppinss/chokidar-ts": "^3.3.3",
+    "@poppinss/cliui": "^3.0.0",
+    "@poppinss/utils": "^4.0.1",
     "cpy": "^8.1.2",
-    "emittery": "^0.9.2",
+    "emittery": "^0.10.0",
     "execa": "^5.1.1",
     "fs-extra": "^10.0.0",
     "get-port": "^5.1.1",
     "has-yarn": "^2.1.0",
-    "picomatch": "^2.3.0",
+    "picomatch": "^2.3.1",
     "slash": "^3.0.0"
   },
   "peerDependencies": {
@@ -109,5 +112,48 @@
   "publishConfig": {
     "access": "public",
     "tag": "latest"
+  },
+  "mrmConfig": {
+    "core": true,
+    "license": "MIT",
+    "services": [
+      "github-actions"
+    ],
+    "minNodeVersion": "14.15.4",
+    "probotApps": [
+      "stale",
+      "lock"
+    ],
+    "runGhActionsOnWindows": true
+  },
+  "eslintConfig": {
+    "extends": [
+      "plugin:adonis/typescriptPackage",
+      "prettier"
+    ],
+    "plugins": [
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "endOfLine": "auto"
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "build"
+  ],
+  "prettier": {
+    "trailingComma": "es5",
+    "semi": false,
+    "singleQuote": true,
+    "useTabs": false,
+    "quoteProps": "consistent",
+    "bracketSpacing": true,
+    "arrowParens": "always",
+    "printWidth": 100
   }
 }