@adonisjs/assembler 5.9.5 → 6.0.0-0

package/build/src/Compiler/index.js

@@ -1,287 +0,0 @@
-"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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Compiler = void 0;
-const slash_1 = __importDefault(require("slash"));
-const cpy_1 = __importDefault(require("cpy"));
-const path_1 = require("path");
-const fs_extra_1 = require("fs-extra");
-const ioc_transformer_1 = require("@adonisjs/ioc-transformer");
-const cliui_1 = require("@poppinss/cliui");
-const Ts_1 = require("../Ts");
-const RcFile_1 = require("../RcFile");
-const Manifest_1 = require("../Manifest");
-const paths_1 = require("../../config/paths");
-const AssetsBundler_1 = require("../AssetsBundler");
-/**
- * Exposes the API to build the AdonisJs project for development or
- * production. The production build has it's own set of node_modules
- */
-class Compiler {
-    constructor(appRoot, encoreArgs, buildAssets, logger = cliui_1.logger, tsconfig) {
-        this.appRoot = appRoot;
-        this.encoreArgs = encoreArgs;
-        this.buildAssets = buildAssets;
-        this.logger = logger;
-        /**
-         * Reference to rc File
-         */
-        this.rcFile = new RcFile_1.RcFile(this.appRoot);
-        this.ts = new Ts_1.Ts(this.appRoot, this.logger, tsconfig);
-        this.ts.tsCompiler.use(() => {
-            return (0, ioc_transformer_1.iocTransformer)(this.ts.tsCompiler.ts, this.rcFile.application.rcFile);
-        }, 'after');
-    }
-    /**
-     * Returns relative unix path from the project root. Used for
-     * display only
-     */
-    getRelativeUnixPath(absPath) {
-        return (0, slash_1.default)((0, path_1.relative)(this.appRoot, absPath));
-    }
-    /**
-     * Cleans up the build directory
-     */
-    async cleanupBuildDirectory(outDir) {
-        this.getRelativeUnixPath(outDir);
-        this.logger.info(`cleaning up ${this.logger.colors
-            .dim()
-            .yellow(`"./${this.getRelativeUnixPath(outDir)}"`)} directory`);
-        await (0, fs_extra_1.remove)(outDir);
-    }
-    /**
-     * Copies .adonisrc.json file to the destination
-     */
-    async copyAdonisRcFile(outDir) {
-        this.logger.info(`copy { ${this.logger.colors
-            .dim()
-            .yellow(`${paths_1.RCFILE_NAME} => ${this.getRelativeUnixPath(outDir)}`)} }`);
-        await (0, fs_extra_1.outputJSON)((0, path_1.join)(outDir, paths_1.RCFILE_NAME), Object.assign({}, this.rcFile.getDiskContents(), {
-            typescript: false,
-            lastCompiledAt: new Date().toISOString(),
-        }), { spaces: 2 });
-    }
-    /**
-     * Copy all meta files to the build directory
-     */
-    async copyMetaFiles(outDir, extraFiles) {
-        const metaFiles = this.rcFile.getMetaFilesGlob().concat(extraFiles || []);
-        this.logger.info(`copy { ${this.logger.colors
-            .dim()
-            .yellow(`${metaFiles.join(',')} => ${this.getRelativeUnixPath(outDir)}`)} }`);
-        await this.copyFiles(metaFiles, outDir);
-    }
-    /**
-     * Copy files to destination directory
-     */
-    async copyFiles(files, outDir) {
-        try {
-            await (0, cpy_1.default)(files, outDir, { cwd: this.appRoot, parents: true });
-        }
-        catch (error) {
-            if (!error.message.includes("the file doesn't exist")) {
-                throw error;
-            }
-        }
-    }
-    /**
-     * Build typescript source files
-     */
-    buildTypescriptSource(config) {
-        this.logger.info('compiling typescript source files');
-        const builder = this.ts.tsCompiler.builder(config);
-        const { skipped, diagnostics } = builder.build();
-        if (skipped) {
-            this.logger.warning('typescript emit skipped');
-        }
-        if (diagnostics.length) {
-            this.logger.error('typescript compiler errors');
-            this.ts.renderDiagnostics(diagnostics, builder.host);
-        }
-        return {
-            skipped,
-            hasErrors: diagnostics.length > 0,
-        };
-    }
-    /**
-     * Log the message that ts build and failed
-     */
-    logTsBuildFailed() {
-        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
-     */
-    async compile(stopOnError = true, extraFiles) {
-        const config = this.ts.parseConfig();
-        if (!config) {
-            return false;
-        }
-        /**
-         * Bundle frontend assets when encore is installed
-         */
-        const encore = await new AssetsBundler_1.AssetsBundler(this.appRoot, this.encoreArgs, this.buildAssets, this.logger).build();
-        /**
-         * Skipped, coz of frontend errors
-         */
-        if (encore.hasErrors) {
-            return false;
-        }
-        /**
-         * Always cleanup the out directory
-         */
-        await this.cleanupBuildDirectory(config.options.outDir);
-        /**
-         * Build typescript source
-         */
-        const ts = this.buildTypescriptSource(config);
-        /**
-         * Do not continue when output was skipped
-         */
-        if (ts.skipped) {
-            return false;
-        }
-        /**
-         * Do not continue when has errors and "stopOnError" is true
-         */
-        if (stopOnError && ts.hasErrors) {
-            this.logTsBuildFailed();
-            await this.cleanupBuildDirectory(config.options.outDir);
-            return false;
-        }
-        /**
-         * Begin by copying meta files
-         */
-        await this.copyMetaFiles(config.options.outDir, extraFiles);
-        /**
-         * Copy `.adonisrc.json` file
-         */
-        await this.copyAdonisRcFile(config.options.outDir);
-        /**
-         * Manifest instance to generate ace manifest file
-         */
-        const manifest = new Manifest_1.Manifest(config.options.outDir, this.logger);
-        const created = await manifest.generate();
-        /**
-         * Do not continue when unable to generate the manifest file as commands
-         * won't be available
-         */
-        if (!created) {
-            await this.cleanupBuildDirectory(config.options.outDir);
-            return false;
-        }
-        this.logger.success('built successfully');
-        return true;
-    }
-    /**
-     * Compile project. See [[Compiler.compile]] for development build
-     */
-    async compileForProduction(stopOnError = true, client) {
-        const config = this.ts.parseConfig();
-        if (!config) {
-            return false;
-        }
-        /**
-         * Bundle frontend assets when encore is installed
-         */
-        const encore = await new AssetsBundler_1.AssetsBundler(this.appRoot, this.encoreArgs, this.buildAssets, this.logger).buildForProduction();
-        /**
-         * Skipped, coz of frontend errors
-         */
-        if (encore.hasErrors) {
-            return false;
-        }
-        const pkgFiles = client === 'npm' ? ['package.json', 'package-lock.json'] : ['package.json', 'yarn.lock'];
-        /**
-         * Always cleanup the out directory
-         */
-        await this.cleanupBuildDirectory(config.options.outDir);
-        /**
-         * Build typescript source
-         */
-        const { skipped, hasErrors } = this.buildTypescriptSource(config);
-        /**
-         * Do not continue when output was skipped
-         */
-        if (skipped) {
-            return false;
-        }
-        /**
-         * Do not continue when has errors and "stopOnError" is true and cleanup
-         * the build directory
-         */
-        if (stopOnError && hasErrors) {
-            this.logTsBuildFailed();
-            await this.cleanupBuildDirectory(config.options.outDir);
-            return false;
-        }
-        /**
-         * Begin by copying meta files
-         */
-        await this.copyMetaFiles(config.options.outDir, pkgFiles);
-        /**
-         * Copy `.adonisrc.json` file
-         */
-        await this.copyAdonisRcFile(config.options.outDir);
-        /**
-         * Generate commands manifest
-         */
-        const manifest = new Manifest_1.Manifest(config.options.outDir, this.logger);
-        const created = await manifest.generate();
-        /**
-         * Do not continue when unable to generate the manifest file as commands
-         * won't be available
-         */
-        if (!created) {
-            await this.cleanupBuildDirectory(config.options.outDir);
-            return false;
-        }
-        /**
-         * Print usage instructions
-         */
-        const installCommand = client === 'npm' ? 'npm ci --production' : 'yarn install --production';
-        const relativeBuildPath = this.getRelativeUnixPath(config.options.outDir);
-        this.logger.success('built successfully');
-        this.logger.log('');
-        (0, cliui_1.instructions)()
-            .heading('Run the following commands to start the server in production')
-            .add(this.logger.colors.cyan(`cd ${relativeBuildPath}`))
-            .add(this.logger.colors.cyan(installCommand))
-            .add(this.logger.colors.cyan('node server.js'))
-            .render();
-        return true;
-    }
-}
-exports.Compiler = Compiler;

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

@@ -1,8 +0,0 @@
-export type JapaFlags = Partial<{
-    '_': string[];
-    '--tags': string[];
-    '--ignore-tags': string[];
-    '--files': string[];
-    '--timeout': number;
-    '--force-exit': boolean;
-}>;

package/build/src/Contracts/index.js

@@ -1,10 +0,0 @@
-"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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,70 +0,0 @@
-import { logger as uiLogger } from '@poppinss/cliui';
-/**
- * Exposes the API to watch project for compilition changes.
- */
-export declare class DevServer {
-    private appRoot;
-    private nodeArgs;
-    private encoreArgs;
-    private buildAssets;
-    private logger;
-    private httpServer;
-    /**
-     * HTTP server port
-     */
-    private serverPort?;
-    /**
-     * HTTP server host
-     */
-    private serverHost?;
-    /**
-     * Encore dev server host
-     */
-    private encoreDevServerResponse;
-    /**
-     * A boolean to know if we are watching for filesystem
-     */
-    private watchingFileSystem;
-    /**
-     * Watcher state
-     */
-    private watcherState;
-    /**
-     * Reference to the typescript compiler
-     */
-    private ts;
-    /**
-     * Reference to the RCFile
-     */
-    private rcFile;
-    /**
-     * Manifest instance to generate ace manifest file
-     */
-    private manifest;
-    /**
-     * Require-ts watch helpers
-     */
-    private watchHelpers;
-    constructor(appRoot: string, nodeArgs: string[], encoreArgs: string[], buildAssets: boolean, logger?: typeof uiLogger);
-    /**
-     * Kill current process
-     */
-    private kill;
-    /**
-     * Create the http server
-     */
-    private createHttpServer;
-    /**
-     * Renders box to notify about the server state
-     */
-    private renderServerIsReady;
-    /**
-     * Start the dev server. Use [[watch]] to also watch for file
-     * changes
-     */
-    start(): Promise<void>;
-    /**
-     * Build and watch for file changes
-     */
-    watch(poll?: boolean): Promise<void>;
-}

package/build/src/DevServer/index.js

@@ -1,306 +0,0 @@
-"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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DevServer = void 0;
-const get_port_1 = __importDefault(require("get-port"));
-const require_ts_1 = require("@adonisjs/require-ts");
-const cliui_1 = require("@poppinss/cliui");
-const Ts_1 = require("../Ts");
-const RcFile_1 = require("../RcFile");
-const Manifest_1 = require("../Manifest");
-const EnvParser_1 = require("../EnvParser");
-const HttpServer_1 = require("../HttpServer");
-const paths_1 = require("../../config/paths");
-const AssetsBundler_1 = require("../AssetsBundler");
-/**
- * Exposes the API to watch project for compilition changes.
- */
-class DevServer {
-    constructor(appRoot, nodeArgs = [], encoreArgs, buildAssets, logger = cliui_1.logger) {
-        this.appRoot = appRoot;
-        this.nodeArgs = nodeArgs;
-        this.encoreArgs = encoreArgs;
-        this.buildAssets = buildAssets;
-        this.logger = logger;
-        /**
-         * A boolean to know if we are watching for filesystem
-         */
-        this.watchingFileSystem = false;
-        /**
-         * Watcher state
-         */
-        this.watcherState = 'pending';
-        /**
-         * Reference to the typescript compiler
-         */
-        this.ts = new Ts_1.Ts(this.appRoot, this.logger);
-        /**
-         * Reference to the RCFile
-         */
-        this.rcFile = new RcFile_1.RcFile(this.appRoot);
-        /**
-         * Manifest instance to generate ace manifest file
-         */
-        this.manifest = new Manifest_1.Manifest(this.appRoot, this.logger);
-        /**
-         * Require-ts watch helpers
-         */
-        this.watchHelpers = (0, require_ts_1.getWatcherHelpers)(this.appRoot);
-    }
-    /**
-     * Kill current process
-     */
-    kill() {
-        this.logger.info('shutting down');
-        process.exit();
-    }
-    /**
-     * Create the http server
-     */
-    async createHttpServer() {
-        if (this.httpServer) {
-            return;
-        }
-        const envParser = new EnvParser_1.EnvParser();
-        await envParser.parse(this.appRoot);
-        const envOptions = envParser.asEnvObject(['PORT', 'TZ', 'HOST']);
-        const HOST = process.env.HOST || envOptions.HOST || '0.0.0.0';
-        let PORT = process.env.PORT || envOptions.PORT || '3333';
-        /**
-         * Obtains a random port by giving preference to the one defined inside
-         * the `.env` file. This eases the process of running the application
-         * without manually changing ports inside the `.env` file when
-         * original port is in use.
-         */
-        if (!isNaN(Number(PORT))) {
-            PORT = String(await (0, get_port_1.default)({
-                port: [Number(PORT)],
-                host: HOST,
-            }));
-        }
-        this.httpServer = new HttpServer_1.HttpServer(paths_1.SERVER_ENTRY_FILE, this.appRoot, this.nodeArgs, this.logger, {
-            PORT,
-            HOST,
-            TZ: envOptions.TZ,
-        });
-    }
-    /**
-     * Renders box to notify about the server state
-     */
-    renderServerIsReady() {
-        if (!this.serverHost || !this.serverPort) {
-            return;
-        }
-        if (this.watchingFileSystem && this.watcherState === 'pending') {
-            return;
-        }
-        const stickerInstance = (0, cliui_1.sticker)();
-        stickerInstance
-            .add(`Server address: ${this.logger.colors.cyan(`http://${this.serverHost === '0.0.0.0' ? '127.0.0.1' : this.serverHost}:${this.serverPort}`)}`)
-            .add(`Watching filesystem for changes: ${this.logger.colors.cyan(this.watchingFileSystem ? 'YES' : 'NO')}`);
-        /**
-         * Running the encore dev server
-         */
-        if (this.encoreDevServerResponse.state === 'running') {
-            stickerInstance.add(`Encore server address: ${this.logger.colors.cyan(`http://${this.encoreDevServerResponse.host}:${this.encoreDevServerResponse.port}`)}`);
-        }
-        stickerInstance.render();
-    }
-    /**
-     * Start the dev server. Use [[watch]] to also watch for file
-     * changes
-     */
-    async start() {
-        /**
-         * Log getting ready
-         */
-        this.logger.info('building project...');
-        /**
-         * Start the HTTP server right away
-         */
-        await this.createHttpServer();
-        this.httpServer.start();
-        /**
-         * Notify that the http server has died
-         */
-        this.httpServer.on('exit', ({ code }) => {
-            this.logger.warning(`Underlying HTTP server died with "${code} code"`);
-        });
-        /**
-         * Notify that the http server is running
-         */
-        this.httpServer.on('ready', ({ port, host }) => {
-            this.serverPort = port;
-            this.serverHost = host;
-            this.renderServerIsReady();
-        });
-        const encore = new AssetsBundler_1.AssetsBundler(this.appRoot, this.encoreArgs, this.buildAssets, this.logger);
-        encore.on('exit', ({ code }) => {
-            this.logger.warning(`Underlying encore dev server died with "${code} code"`);
-        });
-        this.encoreDevServerResponse = await encore.startDevServer();
-    }
-    /**
-     * Build and watch for file changes
-     */
-    async watch(poll = false) {
-        this.watchingFileSystem = true;
-        /**
-         * Clear require-ts cache
-         */
-        this.watchHelpers.clear();
-        /**
-         * Start HTTP server
-         */
-        await this.start();
-        /**
-         * Parse config to find the files excluded inside
-         * tsconfig file
-         */
-        const config = this.ts.parseConfig();
-        if (!config) {
-            this.logger.warning('Cannot start watcher because of errors in the config file');
-            this.watcherState = 'error';
-            this.renderServerIsReady();
-            return;
-        }
-        /**
-         * Stick file watcher
-         */
-        const watcher = this.ts.tsCompiler.watcher(config, 'raw');
-        /**
-         * Watcher is ready after first compile
-         */
-        watcher.on('watcher:ready', () => {
-            this.logger.info('watching file system for changes');
-            this.watcherState = 'ready';
-            this.renderServerIsReady();
-        });
-        /**
-         * Source file removed
-         */
-        watcher.on('source:unlink', async ({ absPath, relativePath }) => {
-            this.watchHelpers.clear(absPath);
-            this.logger.action('delete').succeeded(relativePath);
-            /**
-             * Generate manifest when filePath is a commands path
-             */
-            if (this.rcFile.isCommandsPath(relativePath)) {
-                this.manifest.generate();
-            }
-            this.httpServer.restart();
-        });
-        /**
-         * Source file added
-         */
-        watcher.on('source:add', async ({ absPath, relativePath }) => {
-            this.watchHelpers.clear(absPath);
-            this.logger.action('add').succeeded(relativePath);
-            /**
-             * Generate manifest when filePath if file is in commands path
-             */
-            if (this.rcFile.isCommandsPath(relativePath)) {
-                this.manifest.generate();
-            }
-            this.httpServer.restart();
-        });
-        /**
-         * Source file changed
-         */
-        watcher.on('source:change', async ({ absPath, relativePath }) => {
-            this.watchHelpers.clear(absPath);
-            this.logger.action('update').succeeded(relativePath);
-            /**
-             * Generate manifest when filePath is a commands path
-             */
-            if (this.rcFile.isCommandsPath(relativePath)) {
-                this.manifest.generate();
-            }
-            this.httpServer.restart();
-        });
-        /**
-         * New file added
-         */
-        watcher.on('add', async ({ relativePath }) => {
-            if (paths_1.ENV_FILES.includes(relativePath)) {
-                this.logger.action('create').succeeded(relativePath);
-                this.httpServer.restart();
-                return;
-            }
-            const metaData = this.rcFile.getMetaData(relativePath);
-            if (!metaData.metaFile) {
-                return;
-            }
-            this.logger.action('create').succeeded(relativePath);
-            if (metaData.reload) {
-                this.httpServer.restart();
-            }
-        });
-        /**
-         * File changed
-         */
-        watcher.on('change', async ({ relativePath }) => {
-            if (paths_1.ENV_FILES.includes(relativePath)) {
-                this.logger.action('update').succeeded(relativePath);
-                this.httpServer.restart();
-                return;
-            }
-            const metaData = this.rcFile.getMetaData(relativePath);
-            if (!metaData.metaFile) {
-                return;
-            }
-            this.logger.action('update').succeeded(relativePath);
-            if (metaData.reload || metaData.rcFile) {
-                this.httpServer.restart();
-            }
-        });
-        /**
-         * File removed
-         */
-        watcher.on('unlink', async ({ relativePath }) => {
-            if (paths_1.ENV_FILES.includes(relativePath)) {
-                this.logger.action('delete').succeeded(relativePath);
-                this.httpServer.restart();
-                return;
-            }
-            const metaData = this.rcFile.getMetaData(relativePath);
-            if (!metaData.metaFile) {
-                return;
-            }
-            if (metaData.rcFile) {
-                this.logger.info('cannot continue after deletion of .adonisrc.json file');
-                watcher.chokidar.close();
-                this.kill();
-                return;
-            }
-            this.logger.action('delete').succeeded(relativePath);
-            if (metaData.reload) {
-                this.httpServer.restart();
-            }
-        });
-        /**
-         * Start the watcher
-         */
-        watcher.watch(['.'], {
-            usePolling: poll,
-        });
-        /**
-         * Kill when watcher recieves an error
-         */
-        watcher.chokidar.on('error', (error) => {
-            this.logger.fatal(error);
-            this.kill();
-        });
-    }
-}
-exports.DevServer = DevServer;

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

@@ -1,21 +0,0 @@
-/**
- * Parses the env file inside the project root.
- */
-export declare class EnvParser {
-    private envContents;
-    constructor();
-    /**
-     * Parse .env file contents
-     */
-    parse(rootDir: string): Promise<void>;
-    /**
-     * Returns value for a key inside the `.env` file
-     */
-    get(key: string): string | undefined;
-    /**
-     * Returns an env object for the keys that has defined values
-     */
-    asEnvObject(keys: string[]): {
-        [key: string]: string;
-    };
-}