@adonisjs/assembler 6.1.3-23 → 6.1.3-24

package/build/src/helpers.js

@@ -1,183 +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 cpy from 'cpy';
-import { isNotJunk } from 'junk';
-import fastGlob from 'fast-glob';
-import getRandomPort from 'get-port';
-import { fileURLToPath } from 'node:url';
-import { execaNode, execa } from 'execa';
-import { isAbsolute, relative } from 'node:path';
-import { EnvLoader, EnvParser } from '@adonisjs/env';
-import { ConfigParser, Watcher } from '@poppinss/chokidar-ts';
-import debug from './debug.js';
-/**
- * Default set of args to pass in order to run TypeScript
- * source. Used by "run" and "runNode" scripts
- */
-const DEFAULT_NODE_ARGS = [
-    // Use ts-node/esm loader. The project must install it
-    '--loader=ts-node/esm',
-    // Disable annonying warnings
-    '--no-warnings',
-    // Enable expiremental meta resolve for cases where someone uses magic import string
-    '--experimental-import-meta-resolve',
-    // Enable source maps, since TSNode source maps are broken
-    '--enable-source-maps',
-];
-/**
- * Parses tsconfig.json and prints errors using typescript compiler
- * host
- */
-export function parseConfig(cwd, ts) {
-    const { config, error } = new ConfigParser(cwd, 'tsconfig.json', ts).parse();
-    if (error) {
-        const compilerHost = ts.createCompilerHost({});
-        console.log(ts.formatDiagnosticsWithColorAndContext([error], compilerHost));
-        return;
-    }
-    if (config.errors.length) {
-        const compilerHost = ts.createCompilerHost({});
-        console.log(ts.formatDiagnosticsWithColorAndContext(config.errors, compilerHost));
-        return;
-    }
-    return config;
-}
-/**
- * Runs a Node.js script as a child process and inherits the stdio streams
- */
-export function runNode(cwd, options) {
-    const childProcess = execaNode(options.script, options.scriptArgs, {
-        nodeOptions: DEFAULT_NODE_ARGS.concat(options.nodeArgs),
-        preferLocal: true,
-        windowsHide: false,
-        localDir: cwd,
-        cwd,
-        buffer: false,
-        stdio: options.stdio || 'inherit',
-        env: {
-            ...(options.stdio === 'pipe' ? { FORCE_COLOR: 'true' } : {}),
-            ...options.env,
-        },
-    });
-    return childProcess;
-}
-/**
- * Runs a script as a child process and inherits the stdio streams
- */
-export function run(cwd, options) {
-    const childProcess = execa(options.script, options.scriptArgs, {
-        preferLocal: true,
-        windowsHide: false,
-        localDir: cwd,
-        cwd,
-        buffer: false,
-        stdio: options.stdio || 'inherit',
-        env: {
-            ...(options.stdio === 'pipe' ? { FORCE_COLOR: 'true' } : {}),
-            ...options.env,
-        },
-    });
-    return childProcess;
-}
-/**
- * Watches the file system using tsconfig file
- */
-export function watch(cwd, ts, options) {
-    const config = parseConfig(cwd, ts);
-    if (!config) {
-        return;
-    }
-    const watcher = new Watcher(typeof cwd === 'string' ? cwd : fileURLToPath(cwd), config);
-    const chokidar = watcher.watch(['.'], { usePolling: options.poll });
-    return { watcher, chokidar };
-}
-/**
- * Check if file is an .env file
- */
-export function isDotEnvFile(filePath) {
-    if (filePath === '.env') {
-        return true;
-    }
-    return filePath.includes('.env.');
-}
-/**
- * Check if file is .adonisrc.json file
- */
-export function isRcFile(filePath) {
-    return filePath === '.adonisrc.json';
-}
-/**
- * Returns the port to use after inspect the dot-env files inside
- * a given directory.
- *
- * A random port is used when the specified port is in use. Following
- * is the logic for finding a specified port.
- *
- * - The "process.env.PORT" value is used if exists.
- * - The dot-env files are loaded using the "EnvLoader" and the PORT
- *   value is by iterating over all the loaded files. The iteration
- *   stops after first find.
- */
-export async function getPort(cwd) {
-    /**
-     * Use existing port if exists
-     */
-    if (process.env.PORT) {
-        return getRandomPort({ port: Number(process.env.PORT) });
-    }
-    /**
-     * Loop over files and use the port from their contents. Stops
-     * after first match
-     */
-    const files = await new EnvLoader(cwd).load();
-    for (let file of files) {
-        const envVariables = new EnvParser(file.contents).parse();
-        if (envVariables.PORT) {
-            return getRandomPort({ port: Number(envVariables.PORT) });
-        }
-    }
-    /**
-     * Use 3333 as the port
-     */
-    return getRandomPort({ port: 3333 });
-}
-/**
- * Helper function to copy files from relative paths or glob
- * patterns
- */
-export async function copyFiles(files, cwd, outDir) {
-    /**
-     * Looping over files and create a new collection with paths
-     * and glob patterns
-     */
-    const { paths, patterns } = files.reduce((result, file) => {
-        if (fastGlob.isDynamicPattern(file)) {
-            result.patterns.push(file);
-        }
-        else {
-            result.paths.push(file);
-        }
-        return result;
-    }, { patterns: [], paths: [] });
-    debug('copyFiles inputs: %O, paths: %O, patterns: %O', files, paths, patterns);
-    /**
-     * Getting list of relative paths from glob patterns
-     */
-    const filePaths = paths.concat(await fastGlob(patterns, { cwd }));
-    /**
-     * Computing relative destination. This is because, cpy is buggy when
-     * outDir is an absolute path.
-     */
-    const destination = isAbsolute(outDir) ? relative(cwd, outDir) : outDir;
-    debug('copying files %O to destination "%s"', filePaths, destination);
-    return cpy(filePaths.filter(isNotJunk), destination, {
-        cwd: cwd,
-        flat: false,
-    });
-}

package/build/src/test_runner.d.ts

@@ -1,47 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type tsStatic from 'typescript';
-import { type Logger } from '@poppinss/cliui';
-import type { TestRunnerOptions } from './types.js';
-/**
- * Exposes the API to start the development. Optionally, the watch API can be
- * used to watch for file changes and restart the development server.
- *
- * The Dev server performs the following actions
- *
- * - Assigns a random PORT, when PORT inside .env file is in use
- * - Uses tsconfig.json file to collect a list of files to watch.
- * - Uses metaFiles from .adonisrc.json file to collect a list of files to watch.
- * - Restart HTTP server on every file change.
- */
-export declare class TestRunner {
-    #private;
-    constructor(cwd: URL, options: TestRunnerOptions);
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger: Logger): this;
-    /**
-     * Add listener to get notified when dev server is
-     * closed
-     */
-    onClose(callback: (exitCode: number) => any): this;
-    /**
-     * Add listener to get notified when dev server exists
-     * with an error
-     */
-    onError(callback: (error: any) => any): this;
-    /**
-     * Close watchers and running child processes
-     */
-    close(): Promise<void>;
-    /**
-     * Runs tests
-     */
-    run(): Promise<void>;
-    /**
-     * Run tests in watch mode
-     */
-    runAndWatch(ts: typeof tsStatic, options?: {
-        poll: boolean;
-    }): Promise<void>;
-}

package/build/src/test_runner.js

@@ -1,310 +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 picomatch from 'picomatch';
-import { cliui } from '@poppinss/cliui';
-import { AssetsDevServer } from './assets_dev_server.js';
-import { getPort, isDotEnvFile, runNode, watch } from './helpers.js';
-/**
- * Instance of CLIUI
- */
-const ui = cliui();
-/**
- * Exposes the API to start the development. Optionally, the watch API can be
- * used to watch for file changes and restart the development server.
- *
- * The Dev server performs the following actions
- *
- * - Assigns a random PORT, when PORT inside .env file is in use
- * - Uses tsconfig.json file to collect a list of files to watch.
- * - Uses metaFiles from .adonisrc.json file to collect a list of files to watch.
- * - Restart HTTP server on every file change.
- */
-export class TestRunner {
-    #cwd;
-    #logger = ui.logger;
-    #options;
-    #scriptFile = 'bin/test.js';
-    #isMetaFile;
-    #isTestFile;
-    #scriptArgs;
-    #initialFiltersArgs;
-    /**
-     * In watch mode, after a file is changed, we wait for the current
-     * set of tests to finish before triggering a re-run. Therefore,
-     * we use this flag to know if we are already busy in running
-     * tests and ignore file-changes.
-     */
-    #isBusy = false;
-    #onError;
-    #onClose;
-    #testScript;
-    #watcher;
-    #assetsServer;
-    /**
-     * Getting reference to colors library from logger
-     */
-    get #colors() {
-        return this.#logger.getColors();
-    }
-    constructor(cwd, options) {
-        this.#cwd = cwd;
-        this.#options = options;
-        this.#isMetaFile = picomatch((this.#options.metaFiles || []).map(({ pattern }) => pattern));
-        this.#isTestFile = picomatch(this.#options.suites
-            .filter((suite) => {
-            if (this.#options.filters.suites) {
-                return this.#options.filters.suites.includes(suite.name);
-            }
-            return true;
-        })
-            .map((suite) => suite.files)
-            .flat(1));
-        this.#scriptArgs = this.#convertOptionsToArgs().concat(this.#options.scriptArgs);
-        this.#initialFiltersArgs = this.#convertFiltersToArgs(this.#options.filters);
-    }
-    /**
-     * Converts options to CLI args
-     */
-    #convertOptionsToArgs() {
-        const args = [];
-        if (this.#options.reporters) {
-            args.push('--reporters');
-            args.push(this.#options.reporters.join(','));
-        }
-        if (this.#options.timeout !== undefined) {
-            args.push('--timeout');
-            args.push(String(this.#options.timeout));
-        }
-        if (this.#options.failed) {
-            args.push('--failed');
-        }
-        if (this.#options.retries !== undefined) {
-            args.push('--retries');
-            args.push(String(this.#options.retries));
-        }
-        return args;
-    }
-    /**
-     * Converts all known filters to CLI args.
-     *
-     * The following code snippet may seem like repetitive code. But, it
-     * is done intentionally to have visibility around how each filter
-     * is converted to an arg.
-     */
-    #convertFiltersToArgs(filters) {
-        const args = [];
-        if (filters.suites) {
-            args.push(...filters.suites);
-        }
-        if (filters.files) {
-            args.push('--files');
-            args.push(filters.files.join(','));
-        }
-        if (filters.groups) {
-            args.push('--groups');
-            args.push(filters.groups.join(','));
-        }
-        if (filters.tags) {
-            args.push('--tags');
-            args.push(filters.tags.join(','));
-        }
-        if (filters.tests) {
-            args.push('--tests');
-            args.push(filters.tests.join(','));
-        }
-        return args;
-    }
-    /**
-     * Conditionally clear the terminal screen
-     */
-    #clearScreen() {
-        if (this.#options.clearScreen) {
-            process.stdout.write('\u001Bc');
-        }
-    }
-    /**
-     * Runs tests
-     */
-    #runTests(port, mode, filters) {
-        this.#isBusy = true;
-        const scriptArgs = filters
-            ? this.#convertFiltersToArgs(filters).concat(this.#scriptArgs)
-            : this.#initialFiltersArgs.concat(this.#scriptArgs);
-        this.#testScript = runNode(this.#cwd, {
-            script: this.#scriptFile,
-            env: { PORT: port, ...this.#options.env },
-            nodeArgs: this.#options.nodeArgs,
-            scriptArgs,
-        });
-        this.#testScript
-            .then((result) => {
-            if (mode === 'nonblocking') {
-                this.#onClose?.(result.exitCode);
-                this.close();
-            }
-        })
-            .catch((error) => {
-            if (mode === 'nonblocking') {
-                this.#onError?.(error);
-                this.close();
-            }
-        })
-            .finally(() => {
-            this.#isBusy = false;
-        });
-    }
-    /**
-     * Restarts the HTTP server
-     */
-    #rerunTests(port, filters) {
-        if (this.#testScript) {
-            this.#testScript.removeAllListeners();
-            this.#testScript.kill('SIGKILL');
-        }
-        this.#runTests(port, 'blocking', filters);
-    }
-    /**
-     * Starts the assets server
-     */
-    #startAssetsServer() {
-        this.#assetsServer = new AssetsDevServer(this.#cwd, this.#options.assets);
-        this.#assetsServer.setLogger(this.#logger);
-        this.#assetsServer.start();
-    }
-    /**
-     * Handles a non TypeScript file change
-     */
-    #handleFileChange(action, port, relativePath) {
-        if (this.#isBusy) {
-            return;
-        }
-        if (isDotEnvFile(relativePath) || this.#isMetaFile(relativePath)) {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-            this.#rerunTests(port);
-        }
-    }
-    /**
-     * Handles TypeScript source file change
-     */
-    #handleSourceFileChange(action, port, relativePath) {
-        if (this.#isBusy) {
-            return;
-        }
-        this.#clearScreen();
-        this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-        /**
-         * If changed file is a test file after considering the initial filters,
-         * then only run that file
-         */
-        if (this.#isTestFile(relativePath)) {
-            this.#rerunTests(port, {
-                ...this.#options.filters,
-                files: [relativePath],
-            });
-            return;
-        }
-        this.#rerunTests(port);
-    }
-    /**
-     * Set a custom CLI UI logger
-     */
-    setLogger(logger) {
-        this.#logger = logger;
-        this.#assetsServer?.setLogger(logger);
-        return this;
-    }
-    /**
-     * Add listener to get notified when dev server is
-     * closed
-     */
-    onClose(callback) {
-        this.#onClose = callback;
-        return this;
-    }
-    /**
-     * Add listener to get notified when dev server exists
-     * with an error
-     */
-    onError(callback) {
-        this.#onError = callback;
-        return this;
-    }
-    /**
-     * Close watchers and running child processes
-     */
-    async close() {
-        await this.#watcher?.close();
-        this.#assetsServer?.stop();
-        if (this.#testScript) {
-            this.#testScript.removeAllListeners();
-            this.#testScript.kill('SIGKILL');
-        }
-    }
-    /**
-     * Runs tests
-     */
-    async run() {
-        const port = String(await getPort(this.#cwd));
-        this.#clearScreen();
-        this.#startAssetsServer();
-        this.#logger.info('booting application to run tests...');
-        this.#runTests(port, 'nonblocking');
-    }
-    /**
-     * Run tests in watch mode
-     */
-    async runAndWatch(ts, options) {
-        const port = String(await getPort(this.#cwd));
-        this.#clearScreen();
-        this.#startAssetsServer();
-        this.#logger.info('booting application to run tests...');
-        this.#runTests(port, 'blocking');
-        /**
-         * Create watcher using tsconfig.json file
-         */
-        const output = watch(this.#cwd, ts, options || {});
-        if (!output) {
-            this.#onClose?.(1);
-            return;
-        }
-        /**
-         * Storing reference to watcher, so that we can close it
-         * when HTTP server exists with error
-         */
-        this.#watcher = output.chokidar;
-        /**
-         * Notify the watcher is ready
-         */
-        output.watcher.on('watcher:ready', () => {
-            this.#logger.info('watching file system for changes...');
-        });
-        /**
-         * Cleanup when watcher dies
-         */
-        output.chokidar.on('error', (error) => {
-            this.#logger.warning('file system watcher failure');
-            this.#logger.fatal(error);
-            this.#onError?.(error);
-            output.chokidar.close();
-        });
-        /**
-         * Changes in TypeScript source file
-         */
-        output.watcher.on('source:add', ({ relativePath }) => this.#handleSourceFileChange('add', port, relativePath));
-        output.watcher.on('source:change', ({ relativePath }) => this.#handleSourceFileChange('update', port, relativePath));
-        output.watcher.on('source:unlink', ({ relativePath }) => this.#handleSourceFileChange('delete', port, relativePath));
-        /**
-         * Changes in non-TypeScript source files
-         */
-        output.watcher.on('add', ({ relativePath }) => this.#handleFileChange('add', port, relativePath));
-        output.watcher.on('change', ({ relativePath }) => this.#handleFileChange('update', port, relativePath));
-        output.watcher.on('unlink', ({ relativePath }) => this.#handleFileChange('delete', port, relativePath));
-    }
-}