@adonisjs/assembler 6.1.3-22 → 6.1.3-24

package/build/src/types.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="node" resolution-mode="require"/>
 /**
  * Options needed to run a script file
  */
-export type RunOptions = {
+type RunOptions = {
     script: string;
     scriptArgs: string[];
     nodeArgs: string[];
@@ -12,27 +11,27 @@ export type RunOptions = {
 /**
  * Watcher options
  */
-export type WatchOptions = {
+type WatchOptions = {
     poll?: boolean;
 };
 /**
  * Meta file config defined in ".adonisrc.json" file
  */
-export type MetaFile = {
+type MetaFile = {
     pattern: string;
     reloadServer: boolean;
 };
 /**
  * Test suite defined in ".adonisrc.json" file
  */
-export type Suite = {
+type Suite = {
     files: string | string[];
     name: string;
 };
 /**
  * Options accepted by assets bundler
  */
-export type AssetsBundlerOptions = {
+type AssetsBundlerOptions = {
     serve: false;
     args?: string[];
     driver?: string;
@@ -46,7 +45,7 @@ export type AssetsBundlerOptions = {
 /**
  * Options accepted by the dev server
  */
-export type DevServerOptions = {
+type DevServerOptions = {
     scriptArgs: string[];
     nodeArgs: string[];
     clearScreen?: boolean;
@@ -57,7 +56,7 @@ export type DevServerOptions = {
 /**
  * Options accepted by the test runner
  */
-export type TestRunnerOptions = {
+type TestRunnerOptions = {
     /**
      * Filter arguments are provided as a key-value
      * pair, so that we can mutate them (if needed)
@@ -88,7 +87,7 @@ export type TestRunnerOptions = {
 /**
  * Options accepted by the project bundler
  */
-export type BundlerOptions = {
+type BundlerOptions = {
     metaFiles?: MetaFile[];
     assets?: AssetsBundlerOptions;
 };
@@ -96,7 +95,7 @@ export type BundlerOptions = {
  * Entry to add a middleware to a given middleware stack
  * via the CodeTransformer
  */
-export type AddMiddlewareEntry = {
+type AddMiddlewareEntry = {
     /**
      * If you are adding a named middleware, then you must
      * define the name.
@@ -123,7 +122,7 @@ export type AddMiddlewareEntry = {
  * Defines the structure of an environment variable validation
  * definition
  */
-export type EnvValidationDefinition = {
+type EnvValidationDefinition = {
     /**
      * Write a leading comment on top of your variables
      */
@@ -136,3 +135,5 @@ export type EnvValidationDefinition = {
      */
     variables: Record<string, string>;
 };
+
+export { AddMiddlewareEntry, AssetsBundlerOptions, BundlerOptions, DevServerOptions, EnvValidationDefinition, MetaFile, RunOptions, Suite, TestRunnerOptions, WatchOptions };

package/build/src/types.js

@@ -1,9 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export {};

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "@adonisjs/assembler",
   "description": "Provides utilities to run AdonisJS development server and build project for production",
-  "version": "6.1.3-22",
+  "version": "6.1.3-24",
   "engines": {
     "node": ">=18.16.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build/src",
-    "build/index.d.ts",
-    "build/index.js"
+    "build"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -23,7 +21,7 @@
     "lint": "eslint . --ext=.ts",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
-    "compile": "npm run lint && npm run clean && tsc",
+    "compile": "npm run lint && npm run clean && tsup-node",
     "build": "npm run compile",
     "release": "np",
     "version": "npm run build",
@@ -33,17 +31,17 @@
     "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts"
   },
   "devDependencies": {
-    "@adonisjs/application": "^7.1.2-12",
+    "@adonisjs/application": "^8.0.0-0",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
     "@adonisjs/tsconfig": "^1.1.8",
     "@commitlint/cli": "^17.6.7",
     "@commitlint/config-conventional": "^17.6.7",
-    "@japa/assert": "^2.0.0-1",
-    "@japa/file-system": "^2.0.0-1",
-    "@japa/runner": "^3.0.0-6",
-    "@japa/snapshot": "2.0.0-1",
-    "@swc/core": "^1.3.71",
+    "@japa/assert": "^2.0.0",
+    "@japa/file-system": "^2.0.0",
+    "@japa/runner": "^3.0.2",
+    "@japa/snapshot": "^2.0.0",
+    "@swc/core": "1.3.82",
     "@types/node": "^20.4.5",
     "@types/picomatch": "^2.3.0",
     "c8": "^8.0.1",
@@ -57,20 +55,21 @@
     "p-event": "^6.0.0",
     "prettier": "^3.0.0",
     "ts-node": "^10.9.1",
+    "tsup": "^7.2.0",
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@adonisjs/env": "^4.2.0-3",
-    "@poppinss/chokidar-ts": "^4.1.0-6",
-    "@poppinss/cliui": "^6.1.1-3",
+    "@adonisjs/env": "^4.2.0-6",
+    "@poppinss/chokidar-ts": "^4.1.0",
+    "@poppinss/cliui": "^6.2.0",
     "cpy": "^10.1.0",
-    "execa": "^7.1.1",
+    "execa": "^8.0.1",
     "fast-glob": "^3.3.1",
     "get-port": "^7.0.0",
     "junk": "^4.0.1",
     "picomatch": "^2.3.1",
     "slash": "^5.1.0",
-    "ts-morph": "^19.0.0"
+    "ts-morph": "^20.0.0"
   },
   "peerDependencies": {
     "typescript": "^4.0.0 || ^5.0.0"
@@ -122,5 +121,17 @@
       "src/test_runner.ts",
       "src/assets_dev_server.ts"
     ]
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/code_transformer/main.ts",
+      "./src/types.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
   }
 }

package/build/src/assets_dev_server.d.ts

@@ -1,32 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { type Logger } from '@poppinss/cliui';
-import type { AssetsBundlerOptions } from './types.js';
-/**
- * Exposes the API to start the development server for processing assets during
- * development.
- *
- * - Here we are running the assets dev server in a child process.
- * - Piping the output from the child process and reformatting it before writing it to
- *   process streams.
- *
- * AssetsDevServer is agnostic and can run any assets dev server. Be it Vite or Encore or
- * even Webpack directly.
- */
-export declare class AssetsDevServer {
-    #private;
-    constructor(cwd: URL, options?: AssetsBundlerOptions);
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger: Logger): this;
-    /**
-     * Starts the assets bundler server. The assets bundler server process is
-     * considered as the secondary process and therefore we do not perform
-     * any cleanup if it dies.
-     */
-    start(): void;
-    /**
-     * Stop the dev server
-     */
-    stop(): void;
-}

package/build/src/assets_dev_server.js

@@ -1,158 +0,0 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { cliui } from '@poppinss/cliui';
-import { run } from './helpers.js';
-/**
- * Instance of CLIUI
- */
-const ui = cliui();
-/**
- * Exposes the API to start the development server for processing assets during
- * development.
- *
- * - Here we are running the assets dev server in a child process.
- * - Piping the output from the child process and reformatting it before writing it to
- *   process streams.
- *
- * AssetsDevServer is agnostic and can run any assets dev server. Be it Vite or Encore or
- * even Webpack directly.
- */
-export class AssetsDevServer {
-    #cwd;
-    #logger = ui.logger;
-    #options;
-    #devServer;
-    /**
-     * Getting reference to colors library from logger
-     */
-    get #colors() {
-        return this.#logger.getColors();
-    }
-    constructor(cwd, options) {
-        this.#cwd = cwd;
-        this.#options = options;
-    }
-    /**
-     * Logs messages from vite dev server stdout and stderr
-     */
-    #logViteDevServerMessage(data) {
-        const dataString = data.toString();
-        const lines = dataString.split('\n');
-        /**
-         * Logging VITE ready in message with proper
-         * spaces and newlines
-         */
-        if (dataString.includes('ready in')) {
-            console.log('');
-            console.log(dataString.trim());
-            return;
-        }
-        /**
-         * Put a wrapper around vite network address log
-         */
-        if (dataString.includes('Local') && dataString.includes('Network')) {
-            const sticker = ui.sticker().useColors(this.#colors).useRenderer(this.#logger.getRenderer());
-            lines.forEach((line) => {
-                if (line.trim()) {
-                    sticker.add(line);
-                }
-            });
-            sticker.render();
-            return;
-        }
-        /**
-         * Log rest of the lines
-         */
-        lines.forEach((line) => {
-            if (line.trim()) {
-                console.log(line);
-            }
-        });
-    }
-    /**
-     * Logs messages from assets dev server stdout and stderr
-     */
-    #logAssetsDevServerMessage(data) {
-        const dataString = data.toString();
-        const lines = dataString.split('\n');
-        lines.forEach((line) => {
-            if (line.trim()) {
-                console.log(line);
-            }
-        });
-    }
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger) {
-        this.#logger = logger;
-        return this;
-    }
-    /**
-     * Starts the assets bundler server. The assets bundler server process is
-     * considered as the secondary process and therefore we do not perform
-     * any cleanup if it dies.
-     */
-    start() {
-        if (!this.#options?.serve) {
-            return;
-        }
-        this.#logger.info(`starting "${this.#options.driver}" dev server...`);
-        /**
-         * Create child process
-         */
-        this.#devServer = run(this.#cwd, {
-            script: this.#options.cmd,
-            /**
-             * We do not inherit the stdio for vite and encore, because in
-             * inherit mode they own the stdin and interrupts the
-             * `Ctrl + C` command.
-             */
-            stdio: 'pipe',
-            scriptArgs: this.#options.args,
-        });
-        /**
-         * Log child process messages
-         */
-        this.#devServer.stdout?.on('data', (data) => {
-            if (this.#options.driver === 'vite') {
-                this.#logViteDevServerMessage(data);
-            }
-            else {
-                this.#logAssetsDevServerMessage(data);
-            }
-        });
-        this.#devServer.stderr?.on('data', (data) => {
-            if (this.#options.driver === 'vite') {
-                this.#logViteDevServerMessage(data);
-            }
-            else {
-                this.#logAssetsDevServerMessage(data);
-            }
-        });
-        this.#devServer
-            .then((result) => {
-            this.#logger.warning(`"${this.#options.driver}" dev server closed with status code "${result.exitCode}"`);
-        })
-            .catch((error) => {
-            this.#logger.warning(`unable to connect to "${this.#options.driver}" dev server`);
-            this.#logger.fatal(error);
-        });
-    }
-    /**
-     * Stop the dev server
-     */
-    stop() {
-        if (this.#devServer) {
-            this.#devServer.removeAllListeners();
-            this.#devServer.kill('SIGKILL');
-            this.#devServer = undefined;
-        }
-    }
-}

package/build/src/bundler.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type tsStatic from 'typescript';
-import { type Logger } from '@poppinss/cliui';
-import type { BundlerOptions } from './types.js';
-/**
- * The bundler class exposes the API to build an AdonisJS project.
- */
-export declare class Bundler {
-    #private;
-    constructor(cwd: URL, ts: typeof tsStatic, options: BundlerOptions);
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger: Logger): this;
-    /**
-     * Bundles the application to be run in production
-     */
-    bundle(stopOnError?: boolean, client?: 'npm' | 'yarn' | 'pnpm'): Promise<boolean>;
-}

package/build/src/bundler.js

@@ -1,205 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import slash from 'slash';
-import fs from 'node:fs/promises';
-import { relative } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { cliui } from '@poppinss/cliui';
-import { run, parseConfig, copyFiles } from './helpers.js';
-/**
- * Instance of CLIUI
- */
-const ui = cliui();
-/**
- * The bundler class exposes the API to build an AdonisJS project.
- */
-export class Bundler {
-    #cwd;
-    #cwdPath;
-    #ts;
-    #logger = ui.logger;
-    #options;
-    /**
-     * Getting reference to colors library from logger
-     */
-    get #colors() {
-        return this.#logger.getColors();
-    }
-    constructor(cwd, ts, options) {
-        this.#cwd = cwd;
-        this.#cwdPath = fileURLToPath(this.#cwd);
-        this.#ts = ts;
-        this.#options = options;
-    }
-    #getRelativeName(filePath) {
-        return slash(relative(this.#cwdPath, filePath));
-    }
-    /**
-     * Cleans up the build directory
-     */
-    async #cleanupBuildDirectory(outDir) {
-        await fs.rm(outDir, { recursive: true, force: true, maxRetries: 5 });
-    }
-    /**
-     * Runs assets bundler command to build assets.
-     */
-    async #buildAssets() {
-        const assetsBundler = this.#options.assets;
-        if (!assetsBundler?.serve) {
-            return true;
-        }
-        try {
-            this.#logger.info('compiling frontend assets', { suffix: assetsBundler.cmd });
-            await run(this.#cwd, {
-                stdio: 'inherit',
-                script: assetsBundler.cmd,
-                scriptArgs: assetsBundler.args,
-            });
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Runs tsc command to build the source.
-     */
-    async #runTsc(outDir) {
-        try {
-            await run(this.#cwd, {
-                stdio: 'inherit',
-                script: 'tsc',
-                scriptArgs: ['--outDir', outDir],
-            });
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Copy files to destination directory
-     */
-    async #copyFiles(files, outDir) {
-        try {
-            await copyFiles(files, this.#cwdPath, outDir);
-        }
-        catch (error) {
-            if (!error.message.includes("the file doesn't exist")) {
-                throw error;
-            }
-        }
-    }
-    /**
-     * Copy meta files to the output directory
-     */
-    async #copyMetaFiles(outDir, additionalFilesToCopy) {
-        const metaFiles = (this.#options.metaFiles || [])
-            .map((file) => file.pattern)
-            .concat(additionalFilesToCopy);
-        await this.#copyFiles(metaFiles, outDir);
-    }
-    /**
-     * Returns the lock file name for a given packages client
-     */
-    #getClientLockFile(client) {
-        switch (client) {
-            case 'npm':
-                return 'package-lock.json';
-            case 'yarn':
-                return 'yarn.lock';
-            case 'pnpm':
-                return 'pnpm-lock.yaml';
-        }
-    }
-    /**
-     * Returns the installation command for a given packages client
-     */
-    #getClientInstallCommand(client) {
-        switch (client) {
-            case 'npm':
-                return 'npm ci --omit="dev"';
-            case 'yarn':
-                return 'yarn install --production';
-            case 'pnpm':
-                return 'pnpm i --prod';
-        }
-    }
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger) {
-        this.#logger = logger;
-        return this;
-    }
-    /**
-     * Bundles the application to be run in production
-     */
-    async bundle(stopOnError = true, client = 'npm') {
-        /**
-         * Step 1: Parse config file to get the build output directory
-         */
-        const config = parseConfig(this.#cwd, this.#ts);
-        if (!config) {
-            return false;
-        }
-        /**
-         * Step 2: Cleanup existing build directory (if any)
-         */
-        const outDir = config.options.outDir || fileURLToPath(new URL('build/', this.#cwd));
-        this.#logger.info('cleaning up output directory', { suffix: this.#getRelativeName(outDir) });
-        await this.#cleanupBuildDirectory(outDir);
-        /**
-         * Step 3: Build frontend assets
-         */
-        if (!(await this.#buildAssets())) {
-            return false;
-        }
-        /**
-         * Step 4: Build typescript source code
-         */
-        this.#logger.info('compiling typescript source', { suffix: 'tsc' });
-        const buildCompleted = await this.#runTsc(outDir);
-        await this.#copyFiles(['ace.js'], outDir);
-        /**
-         * Remove incomplete build directory when tsc build
-         * failed and stopOnError is set to true.
-         */
-        if (!buildCompleted && stopOnError) {
-            await this.#cleanupBuildDirectory(outDir);
-            const instructions = ui
-                .sticker()
-                .fullScreen()
-                .drawBorder((borderChar, colors) => colors.red(borderChar));
-            instructions.add(this.#colors.red('Cannot complete the build process as there are TypeScript errors.'));
-            instructions.add(this.#colors.red('Use "--ignore-ts-errors" flag to ignore TypeScript errors and continue the build.'));
-            this.#logger.logError(instructions.prepare());
-            return false;
-        }
-        /**
-         * Step 5: Copy meta files to the build directory
-         */
-        const pkgFiles = ['package.json', this.#getClientLockFile(client)];
-        this.#logger.info('copying meta files to the output directory');
-        await this.#copyMetaFiles(outDir, pkgFiles);
-        this.#logger.success('build completed');
-        this.#logger.log('');
-        /**
-         * Next steps
-         */
-        ui.instructions()
-            .useRenderer(this.#logger.getRenderer())
-            .heading('Run the following commands to start the server in production')
-            .add(this.#colors.cyan(`cd ${this.#getRelativeName(outDir)}`))
-            .add(this.#colors.cyan(this.#getClientInstallCommand(client)))
-            .add(this.#colors.cyan('node bin/server.js'))
-            .render();
-        return true;
-    }
-}

package/build/src/code_transformer/rc_file_transformer.d.ts

@@ -1,43 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { Project } from 'ts-morph';
-import type { AppEnvironments } from '@adonisjs/application/types';
-/**
- * RcFileTransformer is used to transform the `adonisrc.ts` file
- * for adding new commands, providers, meta files etc
- */
-export declare class RcFileTransformer {
-    #private;
-    constructor(cwd: URL, project: Project);
-    /**
-     * Add a new command to the rcFile
-     */
-    addCommand(commandPath: string): this;
-    /**
-     * Add a new preloaded file to the rcFile
-     */
-    addPreloadFile(modulePath: string, environments?: AppEnvironments[]): this;
-    /**
-     * Add a new provider to the rcFile
-     */
-    addProvider(providerPath: string, environments?: AppEnvironments[]): this;
-    /**
-     * Add a new meta file to the rcFile
-     */
-    addMetaFile(globPattern: string, reloadServer?: boolean): this;
-    /**
-     * Set directory name and path
-     */
-    setDirectory(key: string, value: string): this;
-    /**
-     * Set command alias
-     */
-    setCommandAlias(alias: string, command: string): this;
-    /**
-     * Add a new test suite to the rcFile
-     */
-    addSuite(suiteName: string, files: string | string[], timeout?: number): this;
-    /**
-     * Save the adonisrc.ts file
-     */
-    save(): Promise<void>;
-}