igniteui-angular-sovn/schematics/utils/dependency-handler.ts

Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps

import { workspaces } from '@angular-devkit/core';
import { SchematicContext, Rule, Tree } from '@angular-devkit/schematics';
import { Options } from '../interfaces/options';
import { createHost, ProjectType } from './util';

export enum PackageTarget {
    DEV = 'devDependencies',
    REGULAR = 'dependencies',
    NONE = 'none'
}
export interface PackageEntry {
    name: string;
    target: PackageTarget;
}

const schematicsPackage = '@igniteui/angular-schematics';
/**
 * Dependencies are explicitly defined here, so we avoid adding
 * unnecessary packages to the consuming project's deps
 */
export const DEPENDENCIES_MAP: PackageEntry[] = [
    // dependencies
    { name: 'hammerjs', target: PackageTarget.REGULAR },
    { name: 'fflate', target: PackageTarget.REGULAR },
    { name: 'tslib', target: PackageTarget.NONE },
    { name: '@types/hammerjs', target: PackageTarget.DEV },
    { name: 'igniteui-trial-watermark', target: PackageTarget.NONE },
    { name: 'lodash-es', target: PackageTarget.NONE },
    { name: 'uuid', target: PackageTarget.NONE },
    { name: '@igniteui/material-icons-extended', target: PackageTarget.REGULAR },
    // peerDependencies
    { name: '@angular/forms', target: PackageTarget.NONE },
    { name: '@angular/common', target: PackageTarget.NONE },
    { name: '@angular/core', target: PackageTarget.NONE },
    { name: '@angular/animations', target: PackageTarget.NONE },
    { name: 'igniteui-theming', target: PackageTarget.NONE },
    // igxDevDependencies
    { name: '@igniteui/angular-schematics', target: PackageTarget.DEV }
];

export const getWorkspacePath = (host: Tree): string => {
    const targetFiles = ['/angular.json', '/.angular.json'];
    return targetFiles.filter(p => host.exists(p))[0];
};

const logIncludingDependency = (context: SchematicContext, pkg: string, version: string): void =>
    context.logger.info(`Including ${pkg} - Version: ${version}`);

const getTargetedProjectOptions = (project: workspaces.ProjectDefinition, target: string, context: SchematicContext) => {
    if (project.targets &&
        project.targets[target] &&
        project.targets[target].options) {
        return project.targets[target].options;
    }

    const projectTarget = project.targets?.get(target);
    if (projectTarget) {
        return projectTarget.options;
    }

    context.logger.warn(`Could not find matching ${target} options ` +
        `in Angular workspace ${project.sourceRoot}. ` +
        `It could require you to manually add and update the ${target} section.`);
};

export const getConfigFile =
    (project: workspaces.ProjectDefinition, option: string, context: SchematicContext, configSection = 'build'): string => {
        const options = getTargetedProjectOptions(project, configSection, context);
        if (!options) {
            context.logger.warn(`Could not find matching ${configSection} options in Angular workspace. ` +
                `It could require you to manually add and update the ${configSection} options.`);

        }
        if (options) {
            if (!options[option]) {
                context.logger.warn(`Could not find a matching ${option} property under ${configSection} options in Angular workspace. ` +
                    `Some updates may not execute correctly.`);
            } else {
                return options[option];
            }
        }
    };
export const overwriteJsonFile = (tree: Tree, targetFile: string, data: any) =>
    tree.overwrite(targetFile, JSON.stringify(data, null, 2) + '\n');

// eslint-disable-next-line @typescript-eslint/no-unused-vars
export const logSuccess = (options: Options): Rule => (tree: Tree, context: SchematicContext) => {
    context.logger.info('');
    context.logger.warn('Ignite UI for Angular installed');
    context.logger.info('Learn more: https://www.infragistics.com/products/ignite-ui-angular');
    context.logger.info('');
};

// eslint-disable-next-line @typescript-eslint/no-unused-vars
export const addDependencies = (options: Options) => async (tree: Tree, context: SchematicContext): Promise<void> => {
    const pkgJson = require('../../package.json');
    const workspaceHost = createHost(tree);
    const { workspace } = await workspaces.readWorkspace(tree.root.path, workspaceHost);

    await includeDependencies(workspaceHost, workspace, pkgJson, context, tree);

    await includeStylePreprocessorOptions(workspaceHost, workspace, context, tree);

    addPackageToPkgJson(tree, schematicsPackage, pkgJson.igxDevDependencies[schematicsPackage], PackageTarget.DEV);
};

/** Checks whether a property exists in the angular workspace. */
export const propertyExistsInWorkspace = (targetProp: string, workspace: workspaces.WorkspaceDefinition): boolean => {
    const foundProp = getPropertyFromWorkspace(targetProp, workspace);
    return foundProp !== null && foundProp.key === targetProp;
};

/** Recursively search for the first property that matches targetProp within a json file. */
export const getPropertyFromWorkspace = (targetProp: string, workspace: any, curKey = ''): { key: string; value: any } => {
    if (workspace.hasOwnProperty(targetProp)) {
        return { key: targetProp, value: workspace[targetProp] };
    }

    const workspaceKeys = Object.keys(workspace);
    for (const key of workspaceKeys) {
        // If the target property is an array, return its key and its contents.
        if (Array.isArray(workspace[key])) {
            return {
                key: curKey,
                value: workspace[key]
            };
        } else if (workspace[key] instanceof Object) {
            // If the target property is an object, go one level in.
            if (workspace.hasOwnProperty(key)) {
                const newValue = getPropertyFromWorkspace(targetProp, workspace[key], key);
                if (newValue) {
                    return newValue;
                }
            }
        }
    }

    return null;
};

const addHammerToConfig =
    async (project: workspaces.ProjectDefinition, tree: Tree, config: string, context: SchematicContext): Promise<void> => {
        const projectOptions = getTargetedProjectOptions(project, config, context);
        const tsPath = getConfigFile(project, 'main', context, config);
        const hammerImport = 'import \'hammerjs\';\n';
        const tsContent = tree.read(tsPath)?.toString();
        // if there are no elements in the architect[config]options.scripts array that contain hammerjs
        // and the "main" file does not contain an import with hammerjs
        if (!projectOptions?.scripts?.some(el => el.includes('hammerjs')) && !tsContent?.includes(hammerImport)) {
            const hammerjsFilePath = './node_modules/hammerjs/hammer.min.js';
            if (projectOptions?.scripts) {
                projectOptions.scripts.push(hammerjsFilePath);
                return;
            }
            context.logger.warn(`Could not find a matching scripts array property under ${config} options. ` +
                `It could require you to manually update it to 'scripts': [ ${hammerjsFilePath}] `);
        }
    };

export const includeStylePreprocessorOptions = async (workspaceHost: workspaces.WorkspaceHost, workspace: workspaces.WorkspaceDefinition, context: SchematicContext, tree: Tree): Promise<void> => {
    await Promise.all(Array.from(workspace.projects.values()).map(async (project: workspaces.ProjectDefinition) => {
        if (project.extensions['projectType'] === ProjectType.Library) return;
        await addStylePreprocessorOptions(project, tree, "build", context);
        await addStylePreprocessorOptions(project, tree, "server", context);
        await addStylePreprocessorOptions(project, tree, "test", context);
    }));

    await workspaces.writeWorkspace(workspace, workspaceHost);
};

const addStylePreprocessorOptions =
    async (project: workspaces.ProjectDefinition, tree: Tree, config: string, context: SchematicContext): Promise<void> => {
        const projectOptions = getTargetedProjectOptions(project, config, context);
        const warn = `Could not find a matching stylePreprocessorOptions includePaths array property under ${config} options. ` +
            `It could require you to manually update it to "stylePreprocessorOptions": { "includePaths": ["node_modules"] }`;

        if (!projectOptions) {
            context.logger.warn(warn);
            return;
        }

        // if there are no elements in the architect[config]options.stylePreprocessorOptions.includePaths that contain node_modules
        const stylePrepropPath = 'node_modules';
        if (!projectOptions?.stylePreprocessorOptions?.includePaths?.some(el => el.includes(stylePrepropPath))) {
            if (projectOptions?.stylePreprocessorOptions?.includePaths) {
                projectOptions?.stylePreprocessorOptions?.includePaths.push(stylePrepropPath);
            } else if (!projectOptions?.stylePreprocessorOptions) {
                projectOptions["stylePreprocessorOptions"] = { includePaths: [stylePrepropPath]};
            } else {
                context.logger.warn(warn);
            }
        }
    };

const includeDependencies = async (workspaceHost: workspaces.WorkspaceHost, workspace: workspaces.WorkspaceDefinition, pkgJson: any, context: SchematicContext, tree: Tree): Promise<void> => {
    for (const pkg of Object.keys(pkgJson.dependencies)) {
        const version = pkgJson.dependencies[pkg];
        const entry = DEPENDENCIES_MAP.find(e => e.name === pkg);
        if (!entry || entry.target === PackageTarget.NONE) {
            continue;
        }
        logIncludingDependency(context, pkg, version);
        addPackageToPkgJson(tree, pkg, version, entry.target);
        if (pkg === 'hammerjs') {
            await Promise.all(Array.from(workspace.projects.values()).map(async (project) => {
                await addHammerToConfig(project, tree, 'build', context);
                await addHammerToConfig(project, tree, 'test', context);
            }));
        }
    }
    await workspaces.writeWorkspace(workspace, workspaceHost);
};

export const addPackageToPkgJson = (tree: Tree, pkg: string, version: string, target: string): boolean => {
    const targetFile = 'package.json';
    if (tree.exists(targetFile)) {
        const sourceText = tree.read(targetFile).toString();
        const json = JSON.parse(sourceText);

        if (!json[target]) {
            json[target] = {};
        }

        if (!json.dependencies[pkg]) {
            json[target][pkg] = version;
            json[target] =
                Object.keys(json[target])
                    .sort()
                    .reduce((result, key) => (result[key] = json[target][key]) && result, {});
            tree.overwrite(targetFile, JSON.stringify(json, null, 2) + '\n');
        }

        return true;
    }

    return false;
};