just-scripts 2.2.2 → 2.3.0

package/etc/just-scripts.api.md

@@ -1,538 +0,0 @@
-## API Report File for "just-scripts"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="node" />
-
-import type * as ApiExtractorTypes from '@microsoft/api-extractor';
-import type { BuildOptions } from 'esbuild';
-import { Configuration } from 'webpack';
-import { spawn } from 'just-scripts-utils';
-import { SpawnOptions } from 'child_process';
-import { TaskFunction } from 'just-task';
-import * as ts from 'typescript';
-import * as webpackMerge from 'webpack-merge';
-
-// @public
-export interface ApiExtractorOptions extends ApiExtractorTypes.IExtractorInvokeOptions {
-    configJsonFilePath?: string;
-    // @deprecated (undocumented)
-    fixNewlines?: boolean;
-    onConfigLoaded?: (config: ApiExtractorTypes.IConfigFile) => void;
-    onResult?: (result: any, extractorOptions: any) => void;
-    projectFolder?: string;
-}
-
-// @public
-export function apiExtractorUpdateTask(options: ApiExtractorOptions): TaskFunction;
-
-// Warning: (ae-forgotten-export) The symbol "Omit_2" needs to be exported by the entry point index.d.ts
-//
-// @public @deprecated (undocumented)
-export function apiExtractorUpdateTask(configJsonFilePath: string, extractorOptions: Omit_2<ApiExtractorOptions, 'configJsonFilePath'>): TaskFunction;
-
-// @public (undocumented)
-export function apiExtractorVerifyTask(options: ApiExtractorOptions): TaskFunction;
-
-// @public @deprecated (undocumented)
-export function apiExtractorVerifyTask(configJsonFilePath: string, extractorOptions: Omit_2<ApiExtractorOptions, 'configJsonFilePath'>): TaskFunction;
-
-// @public (undocumented)
-export const basicWebpackConfig: Configuration;
-
-// @public (undocumented)
-export const basicWebpackServeConfig: Configuration;
-
-// @public (undocumented)
-export function cleanTask(options?: CleanTaskOptions): TaskFunction;
-
-// @public @deprecated (undocumented)
-export function cleanTask(paths?: string[], limit?: number): TaskFunction;
-
-// @public (undocumented)
-export interface CleanTaskOptions {
-    limit?: number;
-    paths?: string[];
-}
-
-// @public (undocumented)
-export interface CopyConfig {
-    // (undocumented)
-    copyInstructions: CopyInstruction[];
-}
-
-// @public
-function copyFilesInDirectory(sourceDirectoryPath: string, outputDirectoryPath: string, filterFunction?: (file: string) => boolean, noSymlinks?: boolean): CopyInstruction[];
-
-// @public
-function copyFilesToDestinationDirectory(sourceFilePaths: string | string[], destinationDirectory: string, noSymlinks?: boolean): CopyInstruction[];
-
-// @public
-function copyFilesToDestinationDirectoryWithRename(instrs: {
-    sourceFilePath: string;
-    destinationName: string;
-}[], destinationDirectory: string, noSymlinks?: boolean): CopyInstruction[];
-
-// @public
-function copyFileToDestinationDirectoryWithRename(sourceFilePath: string, destinationName: string, destinationDirectory: string, noSymlink?: boolean): CopyInstruction[];
-
-// @public (undocumented)
-export interface CopyInstruction {
-    destinationFilePath: string;
-    noSymlink?: boolean;
-    sourceFilePath: string | string[];
-}
-
-declare namespace copyInstructions {
-    export {
-        copyFilesToDestinationDirectory,
-        copyFileToDestinationDirectoryWithRename,
-        copyFilesToDestinationDirectoryWithRename,
-        copyFilesInDirectory,
-        mergeFiles,
-        CopyInstruction,
-        CopyConfig
-    }
-}
-export { copyInstructions }
-
-// @public
-export function copyInstructionsTask(config?: CopyConfig): TaskFunction;
-
-// @public (undocumented)
-export function copyTask(options: CopyTaskOptions): TaskFunction;
-
-// @public @deprecated (undocumented)
-export function copyTask(paths: string[] | undefined, dest: string, limit?: number): TaskFunction;
-
-// @public (undocumented)
-export interface CopyTaskOptions {
-    dest: string;
-    limit?: number;
-    paths?: string[];
-}
-
-// @public (undocumented)
-export interface CreateOptions {
-    cwd?: string;
-    dereference?: boolean;
-    entries?: string[];
-    file: string;
-    filter?: (path: string, header: EntryHeader) => boolean;
-    gzip?: boolean | {
-        level?: number;
-        memLevel?: number;
-    };
-    map?: (header: EntryHeader) => EntryHeader;
-}
-
-// Warning: (ae-forgotten-export) The symbol "CssLoaderOptions" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export const createStylesOverlay: (options?: CssLoaderOptions) => Partial<Configuration>;
-
-// @public
-export function createTarTask(options?: CreateOptions): TaskFunction;
-
-// @public (undocumented)
-interface CssLoaderOptions {
-    // (undocumented)
-    localIdentName?: string;
-    // (undocumented)
-    modules?: boolean;
-}
-
-// @public (undocumented)
-export function defaultCleanPaths(): string[];
-
-// @public (undocumented)
-export const displayBailoutOverlay: () => Partial<Configuration>;
-
-// @public (undocumented)
-export interface EntryHeader {
-    // (undocumented)
-    devmajor: number;
-    // (undocumented)
-    devminor: number;
-    // (undocumented)
-    gid: number;
-    // (undocumented)
-    gname: string;
-    linkname: string;
-    mode: number;
-    mtime: Date;
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    size: number;
-    type: 'file' | 'link' | 'symlink' | 'directory' | 'block-device' | 'character-device' | 'fifo' | 'contiguous-file';
-    // (undocumented)
-    uid: number;
-    // (undocumented)
-    uname: string;
-}
-
-// @public (undocumented)
-export type EsbuildBuildOptions = BuildOptions;
-
-// @public
-export function esbuildTask(options?: EsbuildBuildOptions): TaskFunction;
-
-// @public (undocumented)
-export interface EsbuildTransformOptions {
-    // (undocumented)
-    esbuildOptions: BuildOptions;
-    // (undocumented)
-    include: string[] | string;
-}
-
-// @public (undocumented)
-export function eslintTask(options?: EsLintTaskOptions): TaskFunction;
-
-// @public
-export interface EsLintTaskOptions {
-    // (undocumented)
-    cache?: boolean;
-    // (undocumented)
-    cacheLocation?: string;
-    // (undocumented)
-    configPath?: string;
-    // (undocumented)
-    extensions?: string;
-    // (undocumented)
-    files?: string[];
-    // (undocumented)
-    fix?: boolean;
-    format?: string;
-    // (undocumented)
-    ignorePath?: string;
-    // (undocumented)
-    maxWarnings?: number;
-    // (undocumented)
-    noEslintRc?: boolean;
-    outputFile?: string;
-    quiet?: boolean;
-    // (undocumented)
-    resolvePluginsPath?: string;
-    timing?: boolean;
-}
-
-// @public (undocumented)
-export interface ExtractOptions {
-    cwd?: string;
-    dereference?: boolean;
-    dmode?: number;
-    file: string;
-    filter?: (path: string, header: EntryHeader) => boolean;
-    fmode?: number;
-    gzip?: boolean;
-    map?: (header: EntryHeader) => EntryHeader;
-    readable?: boolean;
-    writable?: boolean;
-}
-
-// @public
-export function extractTarTask(options?: ExtractOptions): TaskFunction;
-
-// @public (undocumented)
-export const fileOverlay: () => Partial<Configuration>;
-
-// @public
-export function fixApiFileNewlines(apiFilePath: string, newlineOptions: {
-    sampleFilePath?: string;
-    newline?: string;
-}): void;
-
-// @public (undocumented)
-export const htmlOverlay: (options: any) => Partial<Configuration>;
-
-// @public (undocumented)
-export function jestTask(options?: JestTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface JestTaskOptions {
-    // (undocumented)
-    _?: string[];
-    // (undocumented)
-    clearCache?: boolean;
-    // (undocumented)
-    colors?: boolean;
-    // (undocumented)
-    config?: string;
-    // (undocumented)
-    coverage?: boolean;
-    env?: NodeJS.ProcessEnv;
-    nodeArgs?: string[];
-    // (undocumented)
-    passWithNoTests?: boolean;
-    // (undocumented)
-    rootDir?: string;
-    // (undocumented)
-    runInBand?: boolean;
-    // (undocumented)
-    silent?: boolean;
-    // (undocumented)
-    testNamePattern?: string;
-    // (undocumented)
-    testPathPattern?: string;
-    // (undocumented)
-    u?: boolean;
-    // (undocumented)
-    updateSnapshot?: boolean;
-    // (undocumented)
-    watch?: boolean;
-}
-
-// @public (undocumented)
-function lib(): void;
-
-// @public
-function mergeFiles(sourceFilePaths: string[], destinationFilePath: string): CopyInstruction;
-
-// @public (undocumented)
-export function nodeExecTask(options: NodeExecTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface NodeExecTaskOptions {
-    args?: string[];
-    enableTypeScript?: boolean;
-    env?: NodeJS.ProcessEnv;
-    spawnOptions?: SpawnOptions;
-    transpileOnly?: boolean;
-    tsconfig?: string;
-}
-
-// @public (undocumented)
-type Omit_2<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
-
-// Warning: (ae-forgotten-export) The symbol "PrettierTaskOptions" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export function prettierCheckTask(options?: PrettierTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export function prettierTask(options?: PrettierTaskOptions): TaskFunction;
-
-// @public (undocumented)
-interface PrettierTaskOptions {
-    // (undocumented)
-    configPath?: string;
-    // (undocumented)
-    files?: string[] | string;
-    // (undocumented)
-    ignorePath?: string;
-}
-
-// @public (undocumented)
-export function sassTask(options: SassTaskOptions): TaskFunction;
-
-// @public @deprecated (undocumented)
-export function sassTask(createSourceModule: (fileName: string, css: string) => string, postcssPlugins?: any[]): TaskFunction;
-
-// @public (undocumented)
-export interface SassTaskOptions {
-    // (undocumented)
-    createSourceModule: (fileName: string, css: string) => string;
-    // (undocumented)
-    postcssPlugins?: any[];
-}
-
-export { spawn }
-
-// @public (undocumented)
-export const stylesOverlay: () => Partial<Configuration>;
-
-declare namespace taskPresets {
-    export {
-        lib,
-        webapp
-    }
-}
-export { taskPresets }
-
-// @public (undocumented)
-export interface TsCheckerOptions {
-    // (undocumented)
-    async: boolean;
-    // (undocumented)
-    checkSyntacticErrors: boolean;
-    // (undocumented)
-    colors: boolean;
-    // (undocumented)
-    compilerOptions: object;
-    // (undocumented)
-    eslint: true | undefined;
-    eslintOptions: object;
-    // (undocumented)
-    ignoreDiagnostics: number[];
-    // (undocumented)
-    ignoreLints: string[];
-    // (undocumented)
-    ignoreLintWarnings: boolean;
-    // (undocumented)
-    measureCompilationTime: boolean;
-    // (undocumented)
-    memoryLimit: number;
-    // (undocumented)
-    reportFiles: string[];
-    // (undocumented)
-    resolveModuleNameModule: string;
-    // (undocumented)
-    resolveTypeReferenceDirectiveModule: string;
-    // (undocumented)
-    silent: boolean;
-    // (undocumented)
-    tsconfig: string;
-    // (undocumented)
-    tslint: string | true | undefined;
-    // (undocumented)
-    tslintAutoFix: boolean;
-    // (undocumented)
-    typescript: string;
-    // (undocumented)
-    useTypescriptIncrementalApi: boolean;
-    // (undocumented)
-    vue: boolean;
-    // (undocumented)
-    watch: string | string[];
-    // (undocumented)
-    workers: number;
-}
-
-// @public
-export function tscTask(options?: TscTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export type TscTaskOptions = {
-    [key in keyof ts.CompilerOptions]?: string | boolean | string[];
-} & {
-    nodeArgs?: string[];
-};
-
-// @public
-export function tscWatchTask(options?: TscTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export function tslintTask(options?: TsLintTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface TsLintTaskOptions {
-    // (undocumented)
-    config?: string;
-    // (undocumented)
-    fix?: boolean;
-    // (undocumented)
-    project?: string;
-}
-
-// @public (undocumented)
-export interface TsLoaderOptions {
-    // (undocumented)
-    allowTsInNodeModules: boolean;
-    // (undocumented)
-    colors: boolean;
-    // (undocumented)
-    compilerOptions: ts.CompilerOptions;
-    // (undocumented)
-    configFile: string;
-    // (undocumented)
-    experimentalFileCaching: boolean;
-    // (undocumented)
-    experimentalWatchApi: boolean;
-    // (undocumented)
-    getCustomTransformers: string | ((program: ts.Program) => ts.CustomTransformers | undefined);
-    // (undocumented)
-    happyPackMode: boolean;
-    // (undocumented)
-    onlyCompileBundledFiles: boolean;
-    // (undocumented)
-    projectReferences: boolean;
-    // (undocumented)
-    transpileOnly: boolean;
-}
-
-// Warning: (ae-forgotten-export) The symbol "TsOverlayOptions" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export const tsOverlay: (overlayOptions?: TsOverlayOptions | undefined) => Partial<Configuration>;
-
-// @public (undocumented)
-interface TsOverlayOptions {
-    // (undocumented)
-    checkerOptions?: Partial<TsCheckerOptions>;
-    // (undocumented)
-    loaderOptions?: Partial<TsLoaderOptions>;
-}
-
-// @public (undocumented)
-function webapp(): void;
-
-// @public
-export function webpackCliInitTask(customScaffold?: string, auto?: boolean): TaskFunction;
-
-// @public
-export function webpackCliTask(options?: WebpackCliTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface WebpackCliTaskOptions {
-    env?: NodeJS.ProcessEnv;
-    nodeArgs?: string[];
-    transpileOnly?: boolean;
-    tsconfig?: string;
-    webpackCliArgs?: string[];
-}
-
-// @public (undocumented)
-export const webpackConfig: (config: Partial<Configuration>) => Configuration;
-
-// @public (undocumented)
-export function webpackDevServerTask(options?: WebpackDevServerTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface WebpackDevServerTaskOptions extends WebpackCliTaskOptions, Configuration {
-    config?: string;
-    env?: {
-        [key: string]: string | undefined;
-    };
-    mode?: 'production' | 'development';
-    nodeArgs?: string[];
-    open?: boolean;
-    transpileOnly?: boolean;
-    tsconfig?: string;
-}
-
-export { webpackMerge }
-
-// @public (undocumented)
-export const webpackOverlays: {
-    typescript: (overlayOptions?: TsOverlayOptions | undefined) => Partial<Configuration>;
-    html: (options: any) => Partial<Configuration>;
-    styles: () => Partial<Configuration>;
-    file: () => Partial<Configuration>;
-    displayBailout: () => Partial<Configuration>;
-};
-
-// @public (undocumented)
-export const webpackServeConfig: (config: Partial<Configuration>) => Configuration;
-
-// @public (undocumented)
-export function webpackTask(options?: WebpackTaskOptions): TaskFunction;
-
-// @public (undocumented)
-export interface WebpackTaskOptions extends Configuration {
-    // (undocumented)
-    config?: string;
-    env?: NodeJS.ProcessEnv;
-    onCompile?: (err: Error, stats: any) => void | Promise<void>;
-    outputStats?: boolean | string;
-    transpileOnly?: boolean;
-}
-
-
-export * from "just-task";
-
-// (No @packageDocumentation comment for this package)
-
-```

package/src/copy/__tests__/CopyInstruction.spec.ts

@@ -1,14 +0,0 @@
-import { copyFilesToDestinationDirectory } from '../CopyInstruction';
-import { normalize } from 'path';
-
-describe('CopyInstruction tests', () => {
-  it('copies files with the same name to the target directory', () => {
-    const result = copyFilesToDestinationDirectory(['files/foo.js', 'my/path/bar.js'], 'dist/lib/');
-
-    expect(result.length).toEqual(2);
-    expect(result[0].sourceFilePath).toEqual(normalize('files/foo.js'));
-    expect(result[0].destinationFilePath).toEqual(normalize('dist/lib/foo.js'));
-    expect(result[1].sourceFilePath).toEqual(normalize('my/path/bar.js'));
-    expect(result[1].destinationFilePath).toEqual(normalize('dist/lib/bar.js'));
-  });
-});