@adonisjs/assembler 6.0.0-0 → 6.1.1-0

package/README.md

@@ -1,49 +1,36 @@
-<div align="center">
-  <img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
-</div>
+# @adonisjs/assembler
 
 <br />
 
-<div align="center">
-  <h3> Core Commands for building AdonisJS projects </h3>
-  <p>
-    Assembler contains a set of core commands to <strong>build and serve the AdonisJS typescript project</strong>, along with scaffolding <code>make</code> commands.
-  </p>
-</div>
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
 
-<br />
+## Introduction
+Assembler exports the API for starting the **AdonisJS development server**, **building project for production** and **running tests** in watch mode. Assembler must be used during development only.
+
+## Official Documentation
+The documentation is available on the official website
+
+## Contributing
+One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
+
+We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
 
-<div align="center">
-
-[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] [![synk-image]][synk-url]
-
-</div>
-
-<div align="center">
-  <h3>
-    <a href="https://adonisjs.com">
-      Website
-    </a>
-    <span> | </span>
-    <a href="https://docs.adonisjs.com/guides/installation">
-      Guides
-    </a>
-    <span> | </span>
-    <a href="CONTRIBUTING.md">
-      Contributing
-    </a>
-  </h3>
-</div>
-
-<div align="center">
-  <sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a>
-</div>
-
-[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/assembler/test?style=for-the-badge
+## Code of Conduct
+In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
+
+## License
+AdonisJS Assembler is open-sourced software licensed under the [MIT license](LICENSE.md).
+
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/assembler/test.yml?style=for-the-badge
 [gh-workflow-url]: https://github.com/adonisjs/assembler/actions/workflows/test.yml "Github action"
 
 [npm-image]: https://img.shields.io/npm/v/@adonisjs/assembler/latest.svg?style=for-the-badge&logo=npm
 [npm-url]: https://npmjs.org/package/@adonisjs/assembler/v/latest "npm"
 
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/github/license/adonisjs/ace?style=for-the-badge
+
 [synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/assembler?label=Synk%20Vulnerabilities&style=for-the-badge
 [synk-url]: https://snyk.io/test/github/adonisjs/assembler?targetFile=package.json "synk"

package/build/src/bundler.js

@@ -28,9 +28,9 @@ export class Bundler {
     async #cleanupBuildDirectory(outDir) {
         await fs.remove(outDir);
     }
-    async #runTsc() {
+    async #runTsc(outDir) {
         try {
-            await execa('tsc', [], {
+            await execa('tsc', ['--outDir', outDir], {
                 cwd: this.#cwd,
                 preferLocal: true,
                 localDir: this.#cwd,
@@ -93,7 +93,17 @@ export class Bundler {
         return this;
     }
     async bundle(stopOnError = true, client = 'npm') {
-        const { config } = new ConfigParser(this.#cwd, 'tsconfig.json', this.#ts).parse();
+        const { config, error } = new ConfigParser(this.#cwd, 'tsconfig.json', this.#ts).parse();
+        if (error) {
+            const compilerHost = this.#ts.createCompilerHost({});
+            this.#logger.logError(this.#ts.formatDiagnosticsWithColorAndContext([error], compilerHost));
+            return false;
+        }
+        if (config.errors.length) {
+            const compilerHost = this.#ts.createCompilerHost({});
+            this.#logger.logError(this.#ts.formatDiagnosticsWithColorAndContext(config.errors, compilerHost));
+            return false;
+        }
         if (!config) {
             return false;
         }
@@ -101,7 +111,7 @@ export class Bundler {
         this.#logger.info('cleaning up output directory', { suffix: this.#getRelativeName(outDir) });
         await this.#cleanupBuildDirectory(outDir);
         this.#logger.info('compiling typescript source', { suffix: 'tsc' });
-        const buildCompleted = await this.#runTsc();
+        const buildCompleted = await this.#runTsc(outDir);
         await this.#copyFiles(['ace.js'], outDir);
         if (!buildCompleted && stopOnError) {
             await this.#cleanupBuildDirectory(outDir);

package/build/src/dev_server.d.ts

@@ -6,6 +6,8 @@ export declare class DevServer {
     #private;
     constructor(cwd: URL, options: DevServerOptions);
     setLogger(logger: Logger): this;
+    onClose(callback: (exitCode: number) => any): this;
+    onError(callback: (error: any) => any): this;
     start(): Promise<void>;
     startAndWatch(ts: typeof tsStatic, options?: {
         poll: boolean;

package/build/src/dev_server.js

@@ -2,8 +2,8 @@ import getPort from 'get-port';
 import picomatch from 'picomatch';
 import { cliui } from '@poppinss/cliui';
 import { EnvLoader, EnvParser } from '@adonisjs/env';
-import { run } from './run.js';
 import { watch } from './watch.js';
+import { run, runNode } from './run.js';
 const ui = cliui();
 export class DevServer {
     #cwd;
@@ -14,6 +14,10 @@ export class DevServer {
     #httpServerProcess;
     #isMetaFileWithReloadsEnabled;
     #isMetaFileWithReloadsDisabled;
+    #watcher;
+    #assetsServerProcess;
+    #onError;
+    #onClose;
     get #colors() {
         return this.#logger.getColors();
     }
@@ -61,8 +65,8 @@ export class DevServer {
         }
         return getPort({ port: 3333 });
     }
-    #startHTTPServer(port) {
-        this.#httpServerProcess = run(this.#cwd, {
+    #startHTTPServer(port, mode) {
+        this.#httpServerProcess = runNode(this.#cwd, {
             script: this.#scriptFile,
             env: { PORT: port, ...this.#options.env },
             nodeArgs: this.#options.nodeArgs,
@@ -78,13 +82,38 @@ export class DevServer {
                     .render();
             }
         });
-        this.#httpServerProcess.on('error', (error) => {
+        this.#httpServerProcess
+            .then((result) => {
+            this.#logger.warning(`underlying HTTP server closed with status code "${result.exitCode}"`);
+            if (mode === 'nonblocking') {
+                this.#onClose?.(result.exitCode);
+                this.#watcher?.close();
+            }
+        })
+            .catch((error) => {
             this.#logger.warning('unable to connect to underlying HTTP server process');
             this.#logger.fatal(error);
+            this.#onError?.(error);
+            this.#watcher?.close();
+        });
+    }
+    #startAssetsServer() {
+        const assetsBundler = this.#options.assets;
+        if (!assetsBundler?.serve) {
+            return;
+        }
+        this.#logger.info(`starting "${assetsBundler.driver}" dev server...`);
+        this.#assetsServerProcess = run(assetsBundler.cmd, {
+            script: this.#scriptFile,
+            scriptArgs: this.#options.scriptArgs,
         });
-        this.#httpServerProcess.on('close', (exitCode) => {
-            this.#logger.warning(`underlying HTTP server closed with status code "${exitCode}"`);
-            this.#logger.info('watching file system and waiting for application to recover');
+        this.#assetsServerProcess
+            .then((result) => {
+            this.#logger.warning(`"${assetsBundler.driver}" dev server closed with status code "${result.exitCode}"`);
+        })
+            .catch((error) => {
+            this.#logger.warning(`unable to connect to "${assetsBundler.driver}" dev server`);
+            this.#logger.fatal(error);
         });
     }
     #restart(port) {
@@ -92,30 +121,48 @@ export class DevServer {
             this.#httpServerProcess.removeAllListeners();
             this.#httpServerProcess.kill('SIGKILL');
         }
-        this.#startHTTPServer(port);
+        this.#startHTTPServer(port, 'blocking');
     }
     setLogger(logger) {
         this.#logger = logger;
         return this;
     }
+    onClose(callback) {
+        this.#onClose = callback;
+        return this;
+    }
+    onError(callback) {
+        this.#onError = callback;
+        return this;
+    }
     async start() {
         this.#clearScreen();
         this.#logger.info('starting HTTP server...');
-        this.#startHTTPServer(String(await this.#getPort()));
+        this.#startHTTPServer(String(await this.#getPort()), 'nonblocking');
+        this.#startAssetsServer();
     }
     async startAndWatch(ts, options) {
         const port = String(await this.#getPort());
         this.#isWatching = true;
         this.#clearScreen();
         this.#logger.info('starting HTTP server...');
-        this.#startHTTPServer(port);
+        this.#startHTTPServer(port, 'blocking');
+        this.#startAssetsServer();
         const output = watch(this.#cwd, ts, options || {});
         if (!output) {
+            this.#onClose?.(1);
             return;
         }
+        this.#watcher = output.chokidar;
         output.watcher.on('watcher:ready', () => {
             this.#logger.info('watching file system for changes...');
         });
+        output.chokidar.on('error', (error) => {
+            this.#logger.warning('file system watcher failure');
+            this.#logger.fatal(error);
+            this.#onError?.(error);
+            output.chokidar.close();
+        });
         output.watcher.on('source:add', ({ relativePath }) => {
             this.#clearScreen();
             this.#logger.log(`${this.#colors.green('add')} ${relativePath}`);

package/build/src/run.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { RunOptions } from './types.js';
-export declare function run(cwd: string | URL, options: RunOptions): import("execa").ExecaChildProcess<string>;
+export declare function runNode(cwd: string | URL, options: RunOptions): import("execa").ExecaChildProcess<string>;
+export declare function run(cwd: string | URL, options: Omit<RunOptions, 'nodeArgs'>): import("execa").ExecaChildProcess<string>;

package/build/src/run.js

@@ -1,10 +1,10 @@
-import { execaNode } from 'execa';
+import { execaNode, execa } from 'execa';
 const DEFAULT_NODE_ARGS = [
     '--loader=ts-node/esm',
     '--no-warnings',
     '--experimental-import-meta-resolve',
 ];
-export function run(cwd, options) {
+export function runNode(cwd, options) {
     const childProces = execaNode(options.script, options.scriptArgs, {
         nodeOptions: DEFAULT_NODE_ARGS.concat(options.nodeArgs),
         preferLocal: true,
@@ -17,3 +17,15 @@ export function run(cwd, options) {
     });
     return childProces;
 }
+export function run(cwd, options) {
+    const childProces = execa(options.script, options.scriptArgs, {
+        preferLocal: true,
+        windowsHide: false,
+        localDir: cwd,
+        cwd,
+        buffer: false,
+        stdio: 'inherit',
+        env: options.env,
+    });
+    return childProces;
+}

package/build/src/types.d.ts

@@ -17,6 +17,15 @@ export type DevServerOptions = {
         pattern: string;
         reloadServer: boolean;
     }[];
+    assets?: {
+        serve: false;
+        driver?: string;
+        cmd?: string;
+    } | {
+        serve: true;
+        driver: string;
+        cmd: string;
+    };
 };
 export type BundlerOptions = {
     metaFiles?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "6.0.0-0",
+  "version": "6.1.1-0",
   "description": "Provides utilities to run AdonisJS development server and build project for production",
   "main": "build/index.js",
   "type": "module",
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "cross-env NODE_DEBUG=adonisjs:assembler c8 npm run vscode:test",
+    "test": "cross-env NODE_DEBUG=chokidar:ts c8 npm run vscode:test",
     "lint": "eslint . --ext=.ts",
     "clean": "del-cli build",
     "compile": "npm run lint && npm run clean && tsc",
@@ -45,7 +45,7 @@
     "@poppinss/cliui": "^6.1.1-0",
     "@poppinss/dev-utils": "^2.0.3",
     "@swc/core": "^1.3.36",
-    "@types/node": "^18.14.1",
+    "@types/node": "^18.14.3",
     "c8": "^7.13.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -64,7 +64,7 @@
   },
   "dependencies": {
     "@adonisjs/env": "^4.2.0-0",
-    "@poppinss/chokidar-ts": "^4.0.0-0",
+    "@poppinss/chokidar-ts": "^4.1.0-0",
     "@types/fs-extra": "^11.0.1",
     "@types/picomatch": "^2.3.0",
     "cpy": "^9.0.1",
@@ -74,6 +74,9 @@
     "picomatch": "^2.3.1",
     "slash": "^5.0.0"
   },
+  "peerDependencies": {
+    "typescript": "^4.0.0 || ^5.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/adonisjs/assembler.git"