@lenne.tech/cli-plugin-helper/dist/extensions/npm.extension.d.ts

Helper plugin for Gluegun CLI Projects

import { IHelperExtendedGluegunToolbox } from '../interfaces/extended-gluegun-toolbox.interface';
/**
 * npm functions
 */
export declare class Npm {
    protected toolbox: IHelperExtendedGluegunToolbox;
    /**
     * Constructor for integration of toolbox
     */
    constructor(toolbox: IHelperExtendedGluegunToolbox);
    /**
     * Get package.json
     */
    getPackageJson(options?: {
        cwd?: string;
        errorMessage?: string;
        showError?: boolean;
    }): Promise<{
        data: any;
        path: string;
    }>;
    /**
     * Set data for package.json
     */
    setPackageJson(data: string | {
        [key: string]: any;
    }, options?: {
        cwd?: string;
        errorMessage?: string;
        showError?: boolean;
    }): Promise<string>;
    /**
     * Detect which package manager is used in the project
     */
    detectPackageManager(projectPath: string): 'npm' | 'pnpm' | 'yarn';
    /**
     * Install npm packages
     */
    install(options?: {
        cwd?: string;
        detectPackageManager?: boolean;
        errorMessage?: string;
        showError?: boolean;
    }): Promise<boolean>;
    /**
     * Update package.json
     */
    update(options?: {
        cwd?: string;
        errorMessage?: string;
        install?: boolean;
        showError?: boolean;
    }): Promise<boolean>;
}
/**
 * Extend toolbox
 */
declare const _default: (toolbox: IHelperExtendedGluegunToolbox) => void;
export default _default;