@adonisjs/assembler 6.1.3-22 → 6.1.3-24

package/build/src/code_transformer/rc_file_transformer.js

@@ -1,272 +0,0 @@
-import { fileURLToPath } from 'node:url';
-import { Node, SyntaxKind, } from 'ts-morph';
-/**
- * RcFileTransformer is used to transform the `adonisrc.ts` file
- * for adding new commands, providers, meta files etc
- */
-export class RcFileTransformer {
-    #cwd;
-    #project;
-    /**
-     * Settings to use when persisting files
-     */
-    #editorSettings = {
-        indentSize: 2,
-        convertTabsToSpaces: true,
-        trimTrailingWhitespace: true,
-    };
-    constructor(cwd, project) {
-        this.#cwd = cwd;
-        this.#project = project;
-    }
-    /**
-     * Get the `adonisrc.ts` source file
-     */
-    #getRcFileOrThrow() {
-        const kernelUrl = fileURLToPath(new URL('./adonisrc.ts', this.#cwd));
-        return this.#project.getSourceFileOrThrow(kernelUrl);
-    }
-    /**
-     * Check if environments array has a subset of available environments
-     */
-    #isInSpecificEnvironment(environments) {
-        if (!environments)
-            return false;
-        return !!['web', 'console', 'test', 'repl'].find((env) => !environments.includes(env));
-    }
-    /**
-     * Locate the `defineConfig` call inside the `adonisrc.ts` file
-     */
-    #locateDefineConfigCallOrThrow(file) {
-        const call = file
-            .getDescendantsOfKind(SyntaxKind.CallExpression)
-            .find((statement) => statement.getExpression().getText() === 'defineConfig');
-        if (!call) {
-            throw new Error('Could not locate the defineConfig call.');
-        }
-        return call;
-    }
-    /**
-     * Return the ObjectLiteralExpression of the defineConfig call
-     */
-    #getDefineConfigObjectOrThrow(defineConfigCall) {
-        const configObject = defineConfigCall
-            .getArguments()[0]
-            .asKindOrThrow(SyntaxKind.ObjectLiteralExpression);
-        return configObject;
-    }
-    /**
-     * Check if the defineConfig() call has the property assignment
-     * inside it or not. If not, it will create one and return it.
-     */
-    #getPropertyAssignmentInDefineConfigCall(propertyName, initializer) {
-        const file = this.#getRcFileOrThrow();
-        const defineConfigCall = this.#locateDefineConfigCallOrThrow(file);
-        const configObject = this.#getDefineConfigObjectOrThrow(defineConfigCall);
-        let property = configObject.getProperty(propertyName);
-        if (!property) {
-            configObject.addPropertyAssignment({ name: propertyName, initializer });
-            property = configObject.getProperty(propertyName);
-        }
-        return property;
-    }
-    /**
-     * Extract list of imported modules from an ArrayLiteralExpression
-     *
-     * It assumes that the array can have two types of elements:
-     *
-     * - Simple lazy imported modules: [() => import('path/to/file')]
-     * - Or an object entry: [{ file: () => import('path/to/file'), environment: ['web', 'console'] }]
-     *   where the `file` property is a lazy imported module.
-     */
-    #extractModulesFromArray(array) {
-        const modules = array.getElements().map((element) => {
-            /**
-             * Simple lazy imported module
-             */
-            if (Node.isArrowFunction(element)) {
-                const importExp = element.getFirstDescendantByKindOrThrow(SyntaxKind.CallExpression);
-                const literal = importExp.getFirstDescendantByKindOrThrow(SyntaxKind.StringLiteral);
-                return literal.getLiteralValue();
-            }
-            /**
-             * Object entry
-             */
-            if (Node.isObjectLiteralExpression(element)) {
-                const fileProp = element.getPropertyOrThrow('file');
-                const arrowFn = fileProp.getFirstDescendantByKindOrThrow(SyntaxKind.ArrowFunction);
-                const importExp = arrowFn.getFirstDescendantByKindOrThrow(SyntaxKind.CallExpression);
-                const literal = importExp.getFirstDescendantByKindOrThrow(SyntaxKind.StringLiteral);
-                return literal.getLiteralValue();
-            }
-        });
-        return modules.filter(Boolean);
-    }
-    /**
-     * Extract a specific property from an ArrayLiteralExpression
-     * that contains object entries.
-     *
-     * This function is mainly used for extractring the `pattern` property
-     * when adding a new meta files entry, or the `name` property when
-     * adding a new test suite.
-     */
-    #extractPropertyFromArray(array, propertyName) {
-        const property = array.getElements().map((el) => {
-            if (!Node.isObjectLiteralExpression(el))
-                return;
-            const nameProp = el.getPropertyOrThrow(propertyName);
-            if (!Node.isPropertyAssignment(nameProp))
-                return;
-            const name = nameProp.getInitializerIfKindOrThrow(SyntaxKind.StringLiteral);
-            return name.getLiteralValue();
-        });
-        return property.filter(Boolean);
-    }
-    /**
-     * Build a new module entry for the preloads and providers array
-     * based upon the environments specified
-     */
-    #buildNewModuleEntry(modulePath, environments) {
-        if (!this.#isInSpecificEnvironment(environments)) {
-            return `() => import('${modulePath}')`;
-        }
-        return `{
-      file: () => import('${modulePath}'),
-      environment: [${environments?.map((env) => `'${env}'`).join(', ')}],
-    }`;
-    }
-    /**
-     * Add a new command to the rcFile
-     */
-    addCommand(commandPath) {
-        const commandsProperty = this.#getPropertyAssignmentInDefineConfigCall('providers', '[]');
-        const commandsArray = commandsProperty.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression);
-        const commandString = `() => import('${commandPath}')`;
-        /**
-         * If the command already exists, do nothing
-         */
-        if (commandsArray.getElements().some((el) => el.getText() === commandString)) {
-            return this;
-        }
-        /**
-         * Add the command to the array
-         */
-        commandsArray.addElement(commandString);
-        return this;
-    }
-    /**
-     * Add a new preloaded file to the rcFile
-     */
-    addPreloadFile(modulePath, environments) {
-        const preloadsProperty = this.#getPropertyAssignmentInDefineConfigCall('preloads', '[]');
-        const preloadsArray = preloadsProperty.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression);
-        /**
-         * Check for duplicates
-         */
-        const existingPreloadedFiles = this.#extractModulesFromArray(preloadsArray);
-        const isDuplicate = existingPreloadedFiles.includes(modulePath);
-        if (isDuplicate) {
-            return this;
-        }
-        /**
-         * Add the preloaded file to the array
-         */
-        preloadsArray.addElement(this.#buildNewModuleEntry(modulePath, environments));
-        return this;
-    }
-    /**
-     * Add a new provider to the rcFile
-     */
-    addProvider(providerPath, environments) {
-        const property = this.#getPropertyAssignmentInDefineConfigCall('providers', '[]');
-        const providersArray = property.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression);
-        /**
-         * Check for duplicates
-         */
-        const existingProviderPaths = this.#extractModulesFromArray(providersArray);
-        const isDuplicate = existingProviderPaths.includes(providerPath);
-        if (isDuplicate) {
-            return this;
-        }
-        /**
-         * Add the provider to the array
-         */
-        providersArray.addElement(this.#buildNewModuleEntry(providerPath, environments));
-        return this;
-    }
-    /**
-     * Add a new meta file to the rcFile
-     */
-    addMetaFile(globPattern, reloadServer = false) {
-        const property = this.#getPropertyAssignmentInDefineConfigCall('metaFiles', '[]');
-        const metaFilesArray = property.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression);
-        /**
-         * Check for duplicates
-         */
-        const alreadyDefinedPatterns = this.#extractPropertyFromArray(metaFilesArray, 'pattern');
-        if (alreadyDefinedPatterns.includes(globPattern)) {
-            return this;
-        }
-        /**
-         * Add the meta file to the array
-         */
-        metaFilesArray.addElement(`{
-        pattern: '${globPattern}',
-        reloadServer: ${reloadServer},
-      }`);
-        return this;
-    }
-    /**
-     * Set directory name and path
-     */
-    setDirectory(key, value) {
-        const property = this.#getPropertyAssignmentInDefineConfigCall('directories', '{}');
-        const directories = property.getInitializerIfKindOrThrow(SyntaxKind.ObjectLiteralExpression);
-        directories.addPropertyAssignment({ name: key, initializer: `'${value}'` });
-        return this;
-    }
-    /**
-     * Set command alias
-     */
-    setCommandAlias(alias, command) {
-        const aliasProperty = this.#getPropertyAssignmentInDefineConfigCall('commandsAliases', '{}');
-        const aliases = aliasProperty.getInitializerIfKindOrThrow(SyntaxKind.ObjectLiteralExpression);
-        aliases.addPropertyAssignment({ name: alias, initializer: `'${command}'` });
-        return this;
-    }
-    /**
-     * Add a new test suite to the rcFile
-     */
-    addSuite(suiteName, files, timeout) {
-        const testProperty = this.#getPropertyAssignmentInDefineConfigCall('tests', `{ suites: [], forceExit: true, timeout: 2000 }`);
-        const property = testProperty
-            .getInitializerIfKindOrThrow(SyntaxKind.ObjectLiteralExpression)
-            .getPropertyOrThrow('suites');
-        const suitesArray = property.getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression);
-        /**
-         * Check for duplicates
-         */
-        const existingSuitesNames = this.#extractPropertyFromArray(suitesArray, 'name');
-        if (existingSuitesNames.includes(suiteName)) {
-            return this;
-        }
-        /**
-         * Add the suite to the array
-         */
-        const filesArray = Array.isArray(files) ? files : [files];
-        suitesArray.addElement(`{
-        name: '${suiteName}',
-        files: [${filesArray.map((file) => `'${file}'`).join(', ')}],
-        timeout: ${timeout ?? 2000},
-      }`);
-        return this;
-    }
-    /**
-     * Save the adonisrc.ts file
-     */
-    save() {
-        const file = this.#getRcFileOrThrow();
-        file.formatText(this.#editorSettings);
-        return file.save();
-    }
-}

package/build/src/debug.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-declare const _default: import("util").DebugLogger;
-export default _default;

package/build/src/debug.js

@@ -1,10 +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 { debuglog } from 'node:util';
-export default debuglog('adonisjs:assembler');

package/build/src/dev_server.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 { DevServerOptions } 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 DevServer {
-    #private;
-    constructor(cwd: URL, options: DevServerOptions);
-    /**
-     * 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>;
-    /**
-     * Start the development server
-     */
-    start(): Promise<void>;
-    /**
-     * Start the development server in watch mode
-     */
-    startAndWatch(ts: typeof tsStatic, options?: {
-        poll: boolean;
-    }): Promise<void>;
-}

package/build/src/dev_server.js

@@ -1,253 +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, isRcFile, 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 DevServer {
-    #cwd;
-    #logger = ui.logger;
-    #options;
-    #isWatching = false;
-    #scriptFile = 'bin/server.js';
-    #isMetaFileWithReloadsEnabled;
-    #isMetaFileWithReloadsDisabled;
-    #onError;
-    #onClose;
-    #httpServer;
-    #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.#isMetaFileWithReloadsEnabled = picomatch((this.#options.metaFiles || [])
-            .filter(({ reloadServer }) => reloadServer === true)
-            .map(({ pattern }) => pattern));
-        this.#isMetaFileWithReloadsDisabled = picomatch((this.#options.metaFiles || [])
-            .filter(({ reloadServer }) => reloadServer !== true)
-            .map(({ pattern }) => pattern));
-    }
-    /**
-     * Inspect if child process message is from AdonisJS HTTP server
-     */
-    #isAdonisJSReadyMessage(message) {
-        return (message !== null &&
-            typeof message === 'object' &&
-            'isAdonisJS' in message &&
-            'environment' in message &&
-            message.environment === 'web');
-    }
-    /**
-     * Conditionally clear the terminal screen
-     */
-    #clearScreen() {
-        if (this.#options.clearScreen) {
-            process.stdout.write('\u001Bc');
-        }
-    }
-    /**
-     * Starts the HTTP server
-     */
-    #startHTTPServer(port, mode) {
-        this.#httpServer = runNode(this.#cwd, {
-            script: this.#scriptFile,
-            env: { PORT: port, ...this.#options.env },
-            nodeArgs: this.#options.nodeArgs,
-            scriptArgs: this.#options.scriptArgs,
-        });
-        this.#httpServer.on('message', (message) => {
-            if (this.#isAdonisJSReadyMessage(message)) {
-                ui.sticker()
-                    .useColors(this.#colors)
-                    .useRenderer(this.#logger.getRenderer())
-                    .add(`Server address: ${this.#colors.cyan(`http://${message.host}:${message.port}`)}`)
-                    .add(`File system watcher: ${this.#colors.cyan(`${this.#isWatching ? 'enabled' : 'disabled'}`)}`)
-                    .render();
-            }
-        });
-        this.#httpServer
-            .then((result) => {
-            if (mode === 'nonblocking') {
-                this.#onClose?.(result.exitCode);
-                this.#watcher?.close();
-                this.#assetsServer?.stop();
-            }
-        })
-            .catch((error) => {
-            if (mode === 'nonblocking') {
-                this.#onError?.(error);
-                this.#watcher?.close();
-                this.#assetsServer?.stop();
-            }
-        });
-    }
-    /**
-     * Starts the assets server
-     */
-    #startAssetsServer() {
-        this.#assetsServer = new AssetsDevServer(this.#cwd, this.#options.assets);
-        this.#assetsServer.setLogger(this.#logger);
-        this.#assetsServer.start();
-    }
-    /**
-     * Restarts the HTTP server
-     */
-    #restartHTTPServer(port) {
-        if (this.#httpServer) {
-            this.#httpServer.removeAllListeners();
-            this.#httpServer.kill('SIGKILL');
-        }
-        this.#startHTTPServer(port, 'blocking');
-    }
-    /**
-     * Handles a non TypeScript file change
-     */
-    #handleFileChange(action, port, relativePath) {
-        if (isDotEnvFile(relativePath) || isRcFile(relativePath)) {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-            this.#restartHTTPServer(port);
-            return;
-        }
-        if (this.#isMetaFileWithReloadsEnabled(relativePath)) {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-            this.#restartHTTPServer(port);
-            return;
-        }
-        if (this.#isMetaFileWithReloadsDisabled(relativePath)) {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-        }
-    }
-    /**
-     * Handles TypeScript source file change
-     */
-    #handleSourceFileChange(action, port, relativePath) {
-        this.#clearScreen();
-        this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
-        this.#restartHTTPServer(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.#httpServer) {
-            this.#httpServer.removeAllListeners();
-            this.#httpServer.kill('SIGKILL');
-        }
-    }
-    /**
-     * Start the development server
-     */
-    async start() {
-        this.#clearScreen();
-        this.#logger.info('starting HTTP server...');
-        this.#startHTTPServer(String(await getPort(this.#cwd)), 'nonblocking');
-        this.#startAssetsServer();
-    }
-    /**
-     * Start the development server in watch mode
-     */
-    async startAndWatch(ts, options) {
-        const port = String(await getPort(this.#cwd));
-        this.#isWatching = true;
-        this.#clearScreen();
-        this.#logger.info('starting HTTP server...');
-        this.#startHTTPServer(port, 'blocking');
-        this.#startAssetsServer();
-        /**
-         * 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));
-    }
-}

package/build/src/helpers.d.ts

@@ -1,50 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type tsStatic from 'typescript';
-import { Watcher } from '@poppinss/chokidar-ts';
-import type { RunOptions, WatchOptions } from './types.js';
-/**
- * Parses tsconfig.json and prints errors using typescript compiler
- * host
- */
-export declare function parseConfig(cwd: string | URL, ts: typeof tsStatic): tsStatic.ParsedCommandLine | undefined;
-/**
- * Runs a Node.js script as a child process and inherits the stdio streams
- */
-export declare function runNode(cwd: string | URL, options: RunOptions): import("execa").ExecaChildProcess<string>;
-/**
- * Runs a script as a child process and inherits the stdio streams
- */
-export declare function run(cwd: string | URL, options: Omit<RunOptions, 'nodeArgs'>): import("execa").ExecaChildProcess<string>;
-/**
- * Watches the file system using tsconfig file
- */
-export declare function watch(cwd: string | URL, ts: typeof tsStatic, options: WatchOptions): {
-    watcher: Watcher;
-    chokidar: import("chokidar").FSWatcher;
-} | undefined;
-/**
- * Check if file is an .env file
- */
-export declare function isDotEnvFile(filePath: string): boolean;
-/**
- * Check if file is .adonisrc.json file
- */
-export declare function isRcFile(filePath: string): boolean;
-/**
- * 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 declare function getPort(cwd: URL): Promise<number>;
-/**
- * Helper function to copy files from relative paths or glob
- * patterns
- */
-export declare function copyFiles(files: string[], cwd: string, outDir: string): Promise<string[]>;