@breadstone-infrastructure/nx-tasks 0.0.258 → 0.0.259

package/src/executors/alias-replace/executor.task.ts

@@ -1,305 +0,0 @@
-// #region Imports
-
-import { ArrayExtensions, ConsoleLogger, File, gray, logPair, logSeparator, magenta, Path, StringExtensions, yellow } from '@breadstone-infrastructure/utilities';
-import * as dotenv from 'dotenv';
-import type { PackageJson, TsConfigJson } from 'type-fest';
-
-// #endregion
-
-/**
- * Task to replace all aliases in transpiled javascript.
- * This task is used to replace all aliases in the transpiled javascript files.
- * It uses also .env file to replace environment variables.
- *
- * @public
- */
-export namespace AliasReplaceTask {
-
-    /**
-     * @public
-     */
-    export const replaceNothing: string = 'nothing';
-
-    /**
-     * @public
-     */
-    export type AliasReplaceReplacerFn = (packageJson: PackageJson) => AliasReplaceReplacerResult;
-
-    /**
-     * @public
-     */
-    export type AliasReplaceReplacerKV = Record<string, string>;
-
-    /**
-     * @public
-     */
-    export type AliasReplaceReplacerResult = Array<{
-        key: string;
-        value: string;
-    }>;
-
-    /**
-     * @public
-     */
-    export interface IAliasReplaceTaskOptions {
-
-        /**
-         * Shows debug information.
-         */
-        debug?: boolean;
-
-        /**
-         * Appends process.env.configuration as segment in out path.
-         */
-        useMode?: boolean;
-        cwd: string;
-        glob: string;
-        replacer: AliasReplaceReplacerFn | Array<AliasReplaceReplacerFn> | AliasReplaceReplacerKV | Array<AliasReplaceReplacerKV>;
-        tsConfigJson: TsConfigJson;
-        packageJson: PackageJson;
-        verbose?: boolean;
-        dryRun?: boolean;
-    }
-
-    /**
-     * @public
-     */
-    export const DEFAULT_OPTIONS: Pick<IAliasReplaceTaskOptions, 'glob' | 'replacer'> = {
-        glob: '{G,g}lobals.{js,mjs,cjs}',
-        replacer: (packageJson: PackageJson): AliasReplaceReplacerResult => [
-            {
-                key: '@@NAME',
-                value: StringExtensions.replace((packageJson.name ?? '').split('/')[1], '-', '.')
-            },
-            {
-                key: '@@MODE',
-                value: (process.env.configuration ? process.env.configuration.toLowerCase().trim() : replaceNothing).toLowerCase()
-            },
-            {
-                key: '@@VERSION',
-                value: packageJson.version ?? ''
-            },
-            {
-                key: '@@DESCRIPTION',
-                value: packageJson.description ?? ''
-            },
-            {
-                key: '@@AUTHOR',
-                value: formatAuthor(packageJson.author ?? '')
-            },
-            {
-                key: '@@LICENSE',
-                value: packageJson.license ?? ''
-            },
-            {
-                key: '@@BUILDDATE',
-                value: Date.now().toString()
-            }
-        ]
-    };
-
-    /**
-     * Parses and resolves key-value pairs for replacement.
-     * @param replacerKV The key-value pair or array of key-value pairs.
-     * @param packageJson The package.json object.
-     * @returns Array of key-value pairs as expected by the replacer.
-     * @public
-     */
-    export function parseKeyValue(replacerKV: AliasReplaceReplacerKV | Array<AliasReplaceReplacerKV>, packageJson: PackageJson): AliasReplaceReplacerResult {
-        const replacements: AliasReplaceReplacerResult = [];
-        const kvReplacers = Array.isArray(replacerKV) ? replacerKV : [replacerKV];
-
-        kvReplacers.forEach((kv: AliasReplaceReplacerKV) => {
-            replacements.push({
-                key: kv.key,
-                value: resolveValue(kv.value, packageJson)
-            });
-        });
-
-        return replacements;
-    }
-
-    /**
-     * Resolves dynamic expressions in the value string.
-     * @param value The value string to resolve.
-     * @param packageJson The package.json object.
-     * @returns Resolved string.
-     */
-    function resolveValue(value: string, packageJson: PackageJson): string {
-        const envRegex = /\${env:([A-Z_]+)(:(\${.*}|[^}]+))?}/g;
-        const packageJsonRegex = /\${packageJson\.([a-zA-Z0-9_.|]+)}/g;
-        const dateRegex = /\${date:now}/g;
-
-        // Resolve environment variables
-        value = value.replace(envRegex, (_, envVar: string, __: string, fallback: string) => {
-            const envValue = process.env[envVar];
-            if (envValue) {
-                return envValue;
-            } else if (fallback.startsWith('${')) {
-                return resolveValue(fallback, packageJson); // Recursively parse fallback
-            }
-            return fallback || replaceNothing;
-        });
-
-        // Resolve packageJson fields
-        value = value.replace(packageJsonRegex, (_, path: string) => {
-            const keys = path.split('|');
-            let result: unknown = packageJson;
-            for (const key of keys) {
-                if (key.startsWith('split:')) {
-                    const [, delimiter, index] = key.split(':');
-                    result = (result as string).split(delimiter)[parseInt(index, 10)];
-                } else if (key.startsWith('replace:')) {
-                    const [, search, replace] = key.split(':');
-                    result = (result as string).replace(new RegExp(search, 'g'), replace);
-                } else {
-                    result = (result as Record<string, unknown>)[key];
-                }
-                if (result === undefined) {
-                    return '';
-                }
-            }
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            return (result as string) ?? '';
-        });
-
-        // Resolve date
-        value = value.replace(dateRegex, () => new Date().toISOString());
-
-        return value;
-    }
-
-    /**
-     * Parses function-based replacers.
-     * @param replacerFn The function replacer or array of function replacers.
-     * @param packageJson The package.json object.
-     * @returns Array of key-value pairs as expected by the replacer.
-     * @public
-     */
-    export function parseFunction(replacerFn: AliasReplaceReplacerFn | Array<AliasReplaceReplacerFn>, packageJson: PackageJson): AliasReplaceReplacerResult {
-        let replacements: AliasReplaceReplacerResult = [];
-        const replacerFns = Array.isArray(replacerFn) ? replacerFn : [replacerFn];
-        replacerFns.forEach((fn: AliasReplaceReplacerFn) => {
-            replacements = replacements.concat(fn(packageJson));
-        });
-        return replacements;
-    }
-
-    /**
-     * @public
-     */
-    export async function run(options: IAliasReplaceTaskOptions): Promise<void> {
-        const logger = new ConsoleLogger();
-        logSeparator(logger, 'Alias replace');
-
-        return new Promise<void>((resolve) => {
-            const env = dotenv.config();
-            const mode = options.useMode ? process.env.configuration ? process.env.configuration.toLowerCase().trim() : 'production' : '';
-            const path = Path.combine(options.cwd, options.tsConfigJson.compilerOptions?.outDir ?? '', mode, options.glob);
-
-            if (options.verbose) {
-                logger.log(gray(`  - cwd: ${options.cwd}`));
-                logger.log(gray(`  - glob: ${options.glob}`));
-                logger.log(gray(`  - tsConfigJson.compilerOptions.outDir: ${options.tsConfigJson.compilerOptions?.outDir}`));
-                logger.log(gray(`  - mode: ${mode}`));
-                logger.log(gray(`  - path: ${path}`));
-            }
-
-            const map = File.glob(path).map((x: string) => [x, File.readAllText(x)]);
-
-            if (options.verbose) {
-                logger.log(JSON.stringify(options, null, 4));
-                logger.log();
-            }
-
-            if (map.length) {
-                ArrayExtensions.arrayify(options.replacer).forEach((replacer: AliasReplaceReplacerFn | AliasReplaceReplacerKV) => {
-                    let replacements: AliasReplaceReplacerResult = [];
-
-                    if (typeof replacer === 'function') {
-                        replacements = parseFunction(replacer, options.packageJson);
-                    } else if (typeof replacer === 'object') {
-                        replacements = parseKeyValue(replacer, options.packageJson);
-                    }
-
-                    replacements.forEach((x: {
-                        key: string;
-                        value: string;
-                    }) => {
-                        let foundInAny = false;
-
-                        map.forEach((y) => {
-                            const regex = new RegExp(x.key, 'g');
-
-                            if (regex.test(y[1])) {
-                                foundInAny = true;
-
-                                if (x.value !== replaceNothing) {
-                                    y[1] = y[1].replace(regex, x.value);
-                                    if (!options.dryRun) {
-                                        File.writeAllText(y[0], y[1]);
-                                    }
-                                } else {
-                                    logger.log(yellow(`  - '${x.key}' skipped (resolved to nothing).`));
-                                }
-                            }
-                        });
-
-                        if (foundInAny && x.value !== replaceNothing) {
-                            logPair(logger, magenta(`from: '${x.key}'`), magenta(`to: '${x.value}'`), {
-                                prefixSpaceLength: 2
-                            });
-                        } else if (!foundInAny) {
-                            logger.log(yellow(`  - '${x.key}' not found in any file.`));
-                        }
-                    });
-                });
-
-                // Append replacer with env part.
-                Object.entries(env.parsed ?? {}).forEach(([envKey, envValue]: [string, string]) => {
-                    // Format the key to @@KEY
-                    const key = `@@${envKey}`;
-                    let foundInAny = false;
-
-                    map.forEach((y) => {
-                        const regex = new RegExp(key, 'g');
-
-                        if (regex.test(y[1])) {
-                            foundInAny = true;
-                            y[1] = y[1].replace(regex, envValue);
-                            if (!options.dryRun) {
-                                File.writeAllText(y[0], y[1]);
-                            }
-                        }
-                    });
-
-                    if (foundInAny) {
-                        logPair(logger, magenta(`from: '${key}'`), magenta(`to: '${envValue}'`), {
-                            prefixSpaceLength: 2
-                        });
-                    } else {
-                        logger.log(yellow(`  - '${key}' (from .env) not found in any file.`));
-                    }
-                });
-            } else {
-                logger.log(yellow('  No files found to replace.'));
-
-                if (options.useMode) {
-                    logger.log(yellow('  The reason could be that the \'useMode\' is set to \'true\'.'));
-                }
-            }
-
-            logSeparator(logger);
-            resolve();
-        });
-    }
-
-    function formatAuthor(author: PackageJson.Person): string {
-        if (typeof author === 'string') {
-            return author;
-        }
-
-        return `${author.name} <${author.email}>`;
-    }
-
-}

package/src/executors/alias-replace/executor.ts

@@ -1,35 +0,0 @@
-// #region Imports
-
-import type { ExecutorContext } from '@nx/devkit';
-import { getProjectPackageJson } from '../../utils/getProjectPackageJson';
-import { getProjectRoot } from '../../utils/getProjectRoot';
-import { getProjectTsConfigJson } from '../../utils/getProjectTsConfigJson';
-import { isVerbose } from '../../utils/isVerbose';
-import type { AliasReplaceExecutorOptions } from './executor.options';
-
-// #endregion
-
-/**
- * @public
- */
-export default async function runExecutor(options: AliasReplaceExecutorOptions, context: ExecutorContext): Promise<{ success: boolean }> {
-    try {
-        const task = (await import('./executor.task')).AliasReplaceTask;
-
-        await task.run({
-            cwd: getProjectRoot(context),
-            tsConfigJson: getProjectTsConfigJson(context),
-            packageJson: getProjectPackageJson(context),
-            verbose: isVerbose(context, options),
-            glob: options.glob,
-            replacer: options.replacer,
-            debug: options.debug,
-            dryRun: options.dryRun,
-            useMode: options.useMode
-        });
-        return { success: true };
-    } catch (error) {
-        console.error(error);
-        return { success: false };
-    }
-}

package/src/executors/alias-replace/schema.json

@@ -1 +0,0 @@
-{}

package/src/executors/clean/executor.options.ts

@@ -1,10 +0,0 @@
-// #region Imports
-
-import type { CleanTask } from './executor.task';
-
-// #endregion
-
-/**
- * @public
- */
-export type CleanExecutorOptions = Omit<CleanTask.ICleanTaskOptions, 'cwd' | 'tsConfigJson' | 'packageJson' | 'verbose'>;

package/src/executors/clean/executor.task.ts

@@ -1,49 +0,0 @@
-// #region Imports
-
-import { blue, bold, ConsoleLogger, logSeparator, Path, red } from '@breadstone-infrastructure/utilities';
-import { rimraf } from 'rimraf';
-
-// #endregion
-
-/**
- * @description Task to cleanup a project.
- * @public
- */
-export namespace CleanTask {
-
-    export interface ICleanTaskOptions {
-        cwd: string;
-        maxRetries: number;
-        folders: Array<string>;
-        dryRun?: boolean;
-    }
-
-    /**
-     * @public
-     */
-    export async function run(options: ICleanTaskOptions): Promise<void> {
-        const logger = new ConsoleLogger();
-
-        logSeparator(logger, 'Clean');
-
-        for (const x of options.folders) {
-            if (!options.dryRun) {
-                // eslint-disable-next-line no-await-in-loop
-                await rimraf(Path.combine(options.cwd, x), { maxRetries: options.maxRetries })
-                    .then((result) => {
-                        if (result) {
-                            logger.log(`${bold(blue('    [REMOVED]'))} ${x}`);
-                        } else {
-                            logger.error(red(`Failed to delete ${Path.combine(options.cwd, x)}`));
-                        }
-                    })
-                    .catch(() => {
-                        logger.error(red(`Failed to delete ${Path.combine(options.cwd, x)}`));
-                    });
-            }
-        }
-
-        logSeparator(logger);
-    }
-
-}

package/src/executors/clean/executor.ts

@@ -1,28 +0,0 @@
-
-// #region Imports
-
-import type { ExecutorContext } from '@nx/devkit';
-import { getProjectRoot } from '../../utils/getProjectRoot';
-import type { CleanExecutorOptions } from './executor.options';
-
-// #endregion
-
-/**
- * @public
- */
-export default async function runExecutor(options: CleanExecutorOptions, context: ExecutorContext): Promise<{ success: boolean }> {
-    try {
-        const task = (await import('./executor.task')).CleanTask;
-
-        await task.run({
-            cwd: getProjectRoot(context),
-            folders: options.folders,
-            maxRetries: options.maxRetries,
-            dryRun: options.dryRun
-        });
-        return { success: true };
-    } catch (error) {
-        console.error(error);
-        return { success: false };
-    }
-}

package/src/executors/clean/schema.json

@@ -1 +0,0 @@
-{}

package/src/executors/copy/executor.options.ts

@@ -1,10 +0,0 @@
-// #region Imports
-
-import type { CopyTask } from './executor.task';
-
-// #endregion
-
-/**
- * @public
- */
-export type CopyExecutorOptions = Omit<CopyTask.ICopyTaskOptions, 'cwd' | 'tsConfigJson' | 'packageJson'>;

package/src/executors/copy/executor.task.ts

@@ -1,96 +0,0 @@
-// #region Imports
-
-import { ArrayExtensions, ConsoleLogger, Directory, File, gray, logSeparator, logSummary, Path, StringExtensions } from '@breadstone-infrastructure/utilities';
-
-// #endregion
-
-/**
- * A task to make a simple copy of a file or directory.
- *
- * @public
- */
-export namespace CopyTask {
-    export interface ICopyTaskOptions {
-
-        /**
-         * The current working directory.
-         */
-        cwd: string;
-
-        /**
-         * A flag to indicate if the copy should be clean.
-         */
-        cleanCopy: boolean;
-
-        /**
-         * The source path to copy from.
-         * It is also possible to provide an array of paths or a glob pattern.
-         */
-        from: string | Array<string>;
-
-        /**
-         * The destination path.
-         */
-        to: string;
-
-        /**
-         * A flag to indicate if the copy should be dry.
-         */
-        dryRun?: boolean;
-
-        /**
-         * A flag to indicate if the copy should be verbose.
-         */
-        verbose?: boolean;
-    }
-
-    export async function run(options: ICopyTaskOptions): Promise<void> {
-        const logger = new ConsoleLogger();
-
-        logSeparator(logger, 'Copy');
-
-        return new Promise((resolve, _reject) => {
-            const to = Path.combine(options.cwd, options.to);
-            const from = ArrayExtensions.arrayify(options.from).map((path) => Path.combine(options.cwd, path));
-            const fromFiles = File.glob(from);
-
-            if (options.cleanCopy) {
-                if (Directory.exists(to)) {
-                    logger.log(`  > Deleting ${options.to}`);
-
-                    if (!options.dryRun) {
-                        Directory.delete(to);
-                    }
-                }
-
-                if (File.exists(to)) {
-                    logger.log(`  > Deleting ${options.to}`);
-
-                    if (!options.dryRun) {
-                        File.delete(to);
-                    }
-                }
-            }
-
-            fromFiles.forEach((path) => {
-                const toFile = Path.combine(to, Path.getFileName(path));
-
-                if (options.verbose) {
-                    logger.log(gray(`  Copying ${path}${StringExtensions.newLine}    to ${toFile}`));
-                }
-
-                if (!options.dryRun) {
-                    File.copy(path, toFile);
-                }
-            });
-
-            logSummary(logger, {
-                success: [`${fromFiles.length} files copied`, true]
-            });
-
-            logSeparator(logger);
-
-            resolve();
-        });
-    }
-}

package/src/executors/copy/executor.ts

@@ -1,30 +0,0 @@
-// #region Imports
-
-import type { ExecutorContext } from '@nx/devkit';
-import { getProjectRoot } from '../../utils/getProjectRoot';
-import { isVerbose } from '../../utils/isVerbose';
-import type { CopyExecutorOptions } from './executor.options';
-
-// #endregion
-
-/**
- * @public
- */
-export default async function runExecutor(options: CopyExecutorOptions, context: ExecutorContext): Promise<{ success: boolean }> {
-    try {
-        const task = (await import('./executor.task')).CopyTask;
-
-        await task.run({
-            cwd: getProjectRoot(context),
-            cleanCopy: options.cleanCopy,
-            from: options.from,
-            to: options.to,
-            dryRun: options.dryRun,
-            verbose: isVerbose(context, options),
-        });
-        return { success: true };
-    } catch (error) {
-        console.error(error);
-        return { success: false };
-    }
-}

package/src/executors/copy/schema.json

@@ -1 +0,0 @@
-{}

package/src/executors/copy2/executor.options.ts

@@ -1,10 +0,0 @@
-// #region Imports
-
-import type { Copy2Task } from './executor.task';
-
-// #endregion
-
-/**
- * @public
- */
-export type Copy2ExecutorOptions = Omit<Copy2Task.ICopy2TaskOptions, 'cwd' | 'tsConfigJson' | 'packageJson'>;