@rushstack/package-extractor 0.11.15 → 0.12.0

package/lib/PackageExtractor.d.ts

@@ -1,280 +0,0 @@
-import { type IPackageJson } from '@rushstack/node-core-library';
-import { type ITerminal } from '@rushstack/terminal';
-import { type ILinkInfo } from './SymlinkAnalyzer';
-declare module 'npm-packlist' {
-    class Walker {
-        readonly result: string[];
-        constructor(opts: {
-            path: string;
-        });
-        on(event: 'done', callback: (result: string[]) => void): Walker;
-        on(event: 'error', callback: (error: Error) => void): Walker;
-        start(): void;
-    }
-}
-export declare const TARGET_ROOT_SCRIPT_RELATIVE_PATH_TEMPLATE_STRING: '{TARGET_ROOT_SCRIPT_RELATIVE_PATH}';
-/**
- * Part of the extractor-matadata.json file format. Represents an extracted project.
- *
- * @public
- */
-export interface IProjectInfoJson {
-    /**
-     * The name of the project as specified in its package.json file.
-     */
-    projectName: string;
-    /**
-     * This path is relative to the root of the extractor output folder
-     */
-    path: string;
-}
-/**
- * The extractor-metadata.json file format.
- *
- * @public
- */
-export interface IExtractorMetadataJson {
-    /**
-     * The name of the main project the extraction was performed for.
-     */
-    mainProjectName: string;
-    /**
-     * A list of all projects that were extracted.
-     */
-    projects: IProjectInfoJson[];
-    /**
-     * A list of all links that are part of the extracted project.
-     */
-    links: ILinkInfo[];
-    /**
-     * A list of all files that are part of the extracted project.
-     */
-    files: string[];
-}
-/**
- * The extractor subspace configurations
- *
- * @public
- */
-export interface IExtractorSubspace {
-    /**
-     * The subspace name
-     */
-    subspaceName: string;
-    /**
-     * The folder where the PNPM "node_modules" folder is located. This is used to resolve packages linked
-     * to the PNPM virtual store.
-     */
-    pnpmInstallFolder?: string;
-    /**
-     * The pnpmfile configuration if using PNPM, otherwise undefined. The configuration will be used to
-     * transform the package.json prior to extraction.
-     */
-    transformPackageJson?: (packageJson: IPackageJson) => IPackageJson;
-}
-/**
- * The extractor configuration for individual projects.
- *
- * @public
- */
-export interface IExtractorProjectConfiguration {
-    /**
-     * The name of the project.
-     */
-    projectName: string;
-    /**
-     * The absolute path to the project.
-     */
-    projectFolder: string;
-    /**
-     * A list of glob patterns to include when extracting this project. If a path is
-     * matched by both "patternsToInclude" and "patternsToExclude", the path will be
-     * excluded. If undefined, all paths will be included.
-     */
-    patternsToInclude?: string[];
-    /**
-     * A list of glob patterns to exclude when extracting this project. If a path is
-     * matched by both "patternsToInclude" and "patternsToExclude", the path will be
-     * excluded. If undefined, no paths will be excluded.
-     */
-    patternsToExclude?: string[];
-    /**
-     * The names of additional projects to include when extracting this project.
-     */
-    additionalProjectsToInclude?: string[];
-    /**
-     * The names of additional dependencies to include when extracting this project.
-     */
-    additionalDependenciesToInclude?: string[];
-    /**
-     * The names of additional dependencies to exclude when extracting this project.
-     */
-    dependenciesToExclude?: string[];
-}
-/**
- * The extractor configuration for individual dependencies.
- *
- * @public
- */
-export interface IExtractorDependencyConfiguration {
-    /**
-     * The name of dependency
-     */
-    dependencyName: string;
-    /**
-     * The semver version range of dependency
-     */
-    dependencyVersionRange: string;
-    /**
-     * A list of glob patterns to exclude when extracting this dependency. If a path is
-     * matched by both "patternsToInclude" and "patternsToExclude", the path will be
-     * excluded. If undefined, no paths will be excluded.
-     */
-    patternsToExclude?: string[];
-    /**
-     * A list of glob patterns to include when extracting this dependency. If a path is
-     * matched by both "patternsToInclude" and "patternsToExclude", the path will be
-     * excluded. If undefined, all paths will be included.
-     */
-    patternsToInclude?: string[];
-}
-/**
- * The mode to use for link creation.
- *
- * @public
- */
-export type LinkCreationMode = 'default' | 'script' | 'none';
-/**
- * Options that can be provided to the extractor.
- *
- * @public
- */
-export interface IExtractorOptions {
-    /**
-     * A terminal to log extraction progress.
-     */
-    terminal: ITerminal;
-    /**
-     * The main project to include in the extraction operation.
-     */
-    mainProjectName: string;
-    /**
-     * The source folder that copying originates from.  Generally it is the repo root folder.
-     */
-    sourceRootFolder: string;
-    /**
-     * The target folder for the extraction.
-     */
-    targetRootFolder: string;
-    /**
-     * Whether to overwrite the target folder if it already exists.
-     */
-    overwriteExisting: boolean;
-    /**
-     * The desired path to be used when archiving the target folder. Supported file extensions: .zip.
-     */
-    createArchiveFilePath?: string;
-    /**
-     * Whether to skip copying files to the extraction target directory, and only create an extraction
-     * archive. This is only supported when {@link IExtractorOptions.linkCreation} is 'script' or 'none'.
-     */
-    createArchiveOnly?: boolean;
-    /**
-     * The pnpmfile configuration if using PNPM, otherwise `undefined`. The configuration will be used to
-     * transform the package.json prior to extraction.
-     *
-     * @remarks
-     * When Rush subspaces are enabled, this setting applies to `default` subspace only.  To configure
-     * each subspace, use the {@link IExtractorOptions.subspaces} array instead.  The two approaches
-     * cannot be combined.
-     */
-    transformPackageJson?: (packageJson: IPackageJson) => IPackageJson;
-    /**
-     * If dependencies from the "devDependencies" package.json field should be included in the extraction.
-     */
-    includeDevDependencies?: boolean;
-    /**
-     * If files ignored by the .npmignore file should be included in the extraction.
-     */
-    includeNpmIgnoreFiles?: boolean;
-    /**
-     * The folder where the PNPM "node_modules" folder is located. This is used to resolve packages linked
-     * to the PNPM virtual store.
-     *
-     * @remarks
-     * When Rush subspaces are enabled, this setting applies to `default` subspace only.  To configure
-     * each subspace, use the {@link IExtractorOptions.subspaces} array instead.  The two approaches
-     * cannot be combined.
-     */
-    pnpmInstallFolder?: string;
-    /**
-     * The link creation mode to use.
-     * "default": Create the links while copying the files; this is the default behavior. Use this setting
-     * if your file copy tool can handle links correctly.
-     * "script": A Node.js script called create-links.js will be written to the target folder. Use this setting
-     * to create links on the server machine, after the files have been uploaded.
-     * "none": Do nothing; some other tool may create the links later, based on the extractor-metadata.json file.
-     */
-    linkCreation?: LinkCreationMode;
-    /**
-     * The path to the generated link creation script. This is only used when {@link IExtractorOptions.linkCreation}
-     * is 'script'.
-     */
-    linkCreationScriptPath?: string;
-    /**
-     * An additional folder containing files which will be copied into the root of the extraction.
-     */
-    folderToCopy?: string;
-    /**
-     * Configurations for individual projects, keyed by the project path relative to the sourceRootFolder.
-     */
-    projectConfigurations: IExtractorProjectConfiguration[];
-    /**
-     * Configurations for individual dependencies.
-     */
-    dependencyConfigurations?: IExtractorDependencyConfiguration[];
-    /**
-     * When using Rush subspaces, this setting can be used to provide configuration information for each
-     * individual subspace.
-     *
-     * @remarks
-     * To avoid confusion, if this setting is used, then the {@link IExtractorOptions.transformPackageJson} and
-     * {@link IExtractorOptions.pnpmInstallFolder} settings must not be used.
-     */
-    subspaces?: IExtractorSubspace[];
-}
-/**
- * Manages the business logic for the "rush deploy" command.
- *
- * @public
- */
-export declare class PackageExtractor {
-    /**
-     * Get a list of files that would be included in a package created from the provided package root path.
-     *
-     * @beta
-     */
-    static getPackageIncludedFilesAsync(packageRootPath: string): Promise<string[]>;
-    /**
-     * Extract a package using the provided options
-     */
-    extractAsync(options: IExtractorOptions): Promise<void>;
-    private static _normalizeOptions;
-    private _performExtractionAsync;
-    /**
-     * Recursively crawl the node_modules dependencies and collect the result in IExtractorState.foldersToCopy.
-     */
-    private _collectFoldersAsync;
-    private _applyDependencyFilters;
-    /**
-     * Copy one package folder to the extractor target folder.
-     */
-    private _extractFolderAsync;
-    /**
-     * Write the common/deploy/deploy-metadata.json file.
-     */
-    private _writeExtractorMetadataAsync;
-    private _makeBinLinksAsync;
-    private _writeCreateLinksScriptAsync;
-}
-//# sourceMappingURL=PackageExtractor.d.ts.map

package/lib/PackageExtractor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PackageExtractor.d.ts","sourceRoot":"","sources":["../src/PackageExtractor.ts"],"names":[],"mappings":"AAUA,OAAO,EAOL,KAAK,YAAY,EAClB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAY,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EAAmB,KAAK,SAAS,EAAiB,MAAM,mBAAmB,CAAC;AAgBnF,OAAO,QAAQ,cAAc,CAAC;IAC5B,MAAa,MAAM;QACjB,SAAgB,MAAM,EAAE,MAAM,EAAE,CAAC;oBACd,IAAI,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE;QAClC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,MAAM;QAC/D,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM;QAC5D,KAAK,IAAI,IAAI;KACrB;CACF;AAED,eAAO,MAAM,gDAAgD,EAAE,oCACzB,CAAC;AAEvC;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;OAEG;IACH,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,KAAK,YAAY,CAAC;CACpE;AAYD;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC;;OAEG;IACH,+BAA+B,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3C;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,KAAK,YAAY,CAAC;IAEnE;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,8BAA8B,EAAE,CAAC;IAExD;;OAEG;IACH,wBAAwB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE/D;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAClC;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B;;;;OAIG;WACiB,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAe5F;;OAEG;IACU,YAAY,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwEpE,OAAO,CAAC,MAAM,CAAC,iBAAiB;YA8BlB,uBAAuB;IAiErC;;OAEG;YACW,oBAAoB;IAkJlC,OAAO,CAAC,uBAAuB;IAwC/B;;OAEG;YACW,mBAAmB;IAyLjC;;OAEG;YACW,4BAA4B;YAoD5B,kBAAkB;YAsBlB,4BAA4B;CAuB3C"}