@sfdx-falcon/builder-library/lib/questions/filesystem.d.ts

Collection of functions for building pre-defined SFDX-Falcon Tasks, Questions, and Task Bundles. Allows developers to quickly build common Task and Interview-driven workflows in their CLI plugins. Part of the SFDX-Falcon Library.

import { InterviewQuestionsBuilder } from '@sfdx-falcon/builder';
import { SfdxFalconPrompt } from '@sfdx-falcon/prompt';
import { InterviewQuestionsBuilderOptions } from '@sfdx-falcon/builder';
import { JsonMap } from '@sfdx-falcon/types';
import { InquirerValidateFunction } from '@sfdx-falcon/types';
import { Questions } from '@sfdx-falcon/types';
/**
 *  Interface. Specifies options for the `ProvideBaseDirectory` constructor.
 */
export interface ProvideBaseDirectoryOptions extends InterviewQuestionsBuilderOptions {
    fileOrDirName: string;
    validateFunction?: InquirerValidateFunction;
    msgStrings: {
        promptProvidePath?: string;
        errorNotFound?: string;
    };
}
/**
 * @class       ProvideBaseDirectory
 * @extends     InterviewQuestionsBuilder
 * @summary     Interview Questions Builder for providing a "base directory" (ie. a directory that
 *              is expected to contain a specific file or directory).
 * @description Interview Questions Builder for providing a "base directory" (ie. a directory that
 *              is expected to contain a specific file or directory).
 */
export declare class ProvideBaseDirectory extends InterviewQuestionsBuilder {
    promptProvidePath: string;
    errorNotFound: string;
    fileOrDirName: string;
    validateFunction: InquirerValidateFunction;
    /**
     * @constructs  ProvideBaseDirectory
     * @param       {ProvideBaseDirectoryOptions} opts  Required.
     */
    constructor(opts: ProvideBaseDirectoryOptions);
    /**
     * @method      build
     * @returns     {Questions}
     * @description Builds the Interview Questions.
     */
    build(buildCtx: SfdxFalconPrompt<JsonMap>): Questions;
}
/**
 *  Interface. Specifies options for the `ProvideTargetDirectory` constructor.
 */
export interface ProvideTargetDirectoryOptions extends InterviewQuestionsBuilderOptions {
    fileOrDirName: string;
    validateFunction?: InquirerValidateFunction;
    msgStrings: {
        promptProvidePath?: string;
        errorNotFound?: string;
    };
}
/**
 * @class       ProvideTargetDirectory
 * @extends     InterviewQuestionsBuilder
 * @summary     Interview Questions Builder for providing a "target directory".
 * @description Interview Questions Builder for providing a "target directory".
 */
export declare class ProvideTargetDirectory extends InterviewQuestionsBuilder {
    promptProvidePath: string;
    /**
     * @constructs  ProvideTargetDirectory
     * @param       {ProvideTargetDirectoryOptions} opts  Required.
     */
    constructor(opts: ProvideTargetDirectoryOptions);
    /**
     * @method      build
     * @returns     {Questions}
     * @description Builds the Interview Questions.
     */
    build(buildCtx: SfdxFalconPrompt<JsonMap>): Questions;
}
/**
 * @function    filterLocalPath
 * @param       {string}  localPath Required.
 * @returns     {string}  A resolved version of the path string provided by `localPath`.
 * @description Filter function which takes a local Path value and resolves it by using
 *              path.resolve(), and then returns that value.
 */
export declare function filterLocalPath(localPath: string): string;