@xylabs/ts-scripts-yarn3 7.0.0 → 7.0.2

package/dist/index.d.ts

@@ -71,12 +71,104 @@ declare const cycleAll: ({ verbose }: {
 
 declare const dead: () => number;
 
-declare const deplint: ({ pkg, deps, devDeps, peerDeps, }: {
-    deps: boolean;
-    devDeps: boolean;
-    peerDeps: boolean;
-    pkg: string;
-}) => number;
+declare const checkResult: (name: string, result: number, level?: "error" | "warn", exitOnFail?: boolean) => void;
+
+declare const createBuildConfig: (location: string, module: "ESNext" | "CommonJS", target: "ESNext" | "ES6", outDirSuffix: string) => Record<string, unknown> | undefined;
+
+declare const defaultBuildConfig: {
+    compilerOptions: {
+        rootDir: string;
+        rootDirs: string[];
+    };
+    exclude: string[];
+    include: string[];
+};
+
+declare const deleteGlob: (globPath: string) => void;
+
+declare const detectDuplicateDependencies: (depsFromPackageJSON?: string[], DefaultDependencies?: string[]) => number;
+
+declare class DuplicateDetector {
+    private dependency;
+    private dependencyEntries;
+    constructor(output: string, dependency: string);
+    detect(): 1 | 0;
+    private detectReducer;
+    private resultsFactory;
+}
+
+declare const WINDOWS_NEWLINE_REGEX: RegExp;
+declare const CROSS_PLATFORM_NEWLINE = "\n";
+
+type ReadFileSyncOptions = BufferEncoding | {
+    encoding: BufferEncoding;
+    flags?: string;
+};
+declare const defaultReadFileSyncOptions: ReadFileSyncOptions;
+
+declare const readLines: (uri: PathLike, options?: ReadFileSyncOptions) => string[];
+declare const readNonEmptyLines: (uri: PathLike, options?: ReadFileSyncOptions) => string[];
+declare const writeLines: (uri: PathLike, lines: string[], options?: WriteFileOptions) => void;
+
+declare const tryReadFileSync: (uri: PathLike, options?: ReadFileSyncOptions) => string | undefined;
+
+declare const generateIgnoreFiles: (filename: string, pkg?: string) => 1 | 0;
+
+declare const multiLineToJSONArray: (output: string) => any;
+
+declare const loadConfig: <T extends object>(params?: T) => Promise<T>;
+
+declare const parsedPackageJSON: (path?: string) => any;
+
+declare const processEx: (ex: unknown) => never;
+
+type ScriptStep = [/* command */ /* command */ 'yarn' | 'node' | 'ts-node-script' | 'tsc' | 'jest', /* arg */ /* arg */ string | string[]] | [/* command */ string, /* arg */ /* arg */ string | string[], /* config */ SpawnSyncOptionsWithBufferEncoding];
+declare const runSteps: (name: string, steps: ScriptStep[], exitOnFail?: boolean, messages?: string[]) => number;
+
+declare const runStepAsync: (name: string, step: ScriptStep, exitOnFail?: boolean, message?: string) => Promise<number>;
+declare const runStepsAsync: (name: string, steps: ScriptStep[], exitOnFail?: boolean, messages?: string[]) => Promise<number>;
+
+declare const runXy: (command: string) => number;
+
+declare const runXyWithWarning: (command: string) => number;
+
+/** Catch child process a crash and returns the code */
+declare const safeExit: (func: () => number, exitOnFail?: boolean) => number;
+declare const safeExitAsync: (func: () => Promise<number>, exitOnFail?: boolean) => Promise<number>;
+
+declare const empty: (value?: string | undefined) => boolean;
+declare const notEmpty: (value?: string | undefined) => boolean;
+
+declare const union: (a: string[], b: string[]) => Set<string>;
+
+declare const withErrnoException: <T extends NodeJS.ErrnoException = NodeJS.ErrnoException>(ex: unknown, closure: (error: T) => number) => number | undefined;
+
+declare const withError: <T extends Error = Error>(ex: any, closure: (error: T) => number, predicate?: (ex: T) => boolean) => number | undefined;
+
+declare const isYarnVersionOrGreater: (major: number, minor?: number, patch?: number) => [boolean, string];
+
+interface Workspace {
+    location: string;
+    name: string;
+}
+
+declare const yarnWorkspace: (pkg: string) => Workspace;
+
+declare const yarnWorkspaces: () => Workspace[];
+
+declare const INIT_CWD: () => string | undefined;
+
+interface CheckPackageOptions {
+    deps?: boolean;
+    devDeps?: boolean;
+    peerDeps?: boolean;
+    verbose?: boolean;
+}
+
+interface DepLintOptions extends CheckPackageOptions {
+    pkg?: string;
+}
+declare const deplint: ({ pkg, deps, devDeps, peerDeps, verbose, }: DepLintOptions) => number;
 
 declare const deploy: () => number;
 
@@ -162,6 +254,7 @@ interface CompileConfig {
     bundleTypes?: boolean;
     /** @param entryMode all, single, custom, platform, or auto */
     entryMode?: EntryMode;
+    /** @param when building types with tsc, should it use the outDir to write to? */
     outDirAsBuildDir?: boolean;
 }
 type PackageCompileTsupConfig = CompileConfig & {
@@ -171,6 +264,7 @@ type PackageCompileTsupConfig = CompileConfig & {
     tsup?: {
         options?: Options;
     };
+    verbose?: boolean;
 };
 type PackageCompileTscConfig = CompileConfig & {
     mode: 'tsc';
@@ -179,6 +273,7 @@ interface XyConfigBase {
     compile?: CompileConfig;
     dynamicShare?: DynamicShareConfig;
     liveShare?: LiveShareConfig;
+    /** @deprecated */
     publint?: boolean;
     verbose?: boolean;
 }
@@ -188,7 +283,27 @@ interface XyTsupConfig extends XyConfigBase {
 interface XyTscConfig extends XyConfigBase {
     compile?: PackageCompileTscConfig;
 }
-type XyConfig = XyTsupConfig | XyTscConfig;
+type XyConfigLegacy = XyTsupConfig | XyTscConfig;
+type XyConfig = XyConfigLegacy & {
+    dev?: {
+        build?: {
+            clean?: boolean;
+            compile?: boolean;
+            deplint?: boolean;
+            gendocs?: boolean;
+            gitlint?: boolean;
+            knip?: boolean;
+            license?: boolean;
+            lint?: boolean;
+            publint?: boolean;
+            statics?: boolean;
+            verbose?: boolean;
+        };
+        compile?: PackageCompileTsupConfig;
+        verbose?: boolean;
+    };
+    verbose?: boolean;
+};
 
 declare const packageCompile: (inConfig?: XyConfig) => Promise<number>;
 
@@ -212,9 +327,10 @@ declare const packageGenDocs: () => Promise<number | undefined>;
 declare const packageLint: (fix?: boolean, verbose?: boolean, cache?: boolean) => Promise<number>;
 
 interface PackagePublintParams {
+    strict?: boolean;
     verbose?: boolean;
 }
-declare const packagePublint: (params?: PackagePublintParams) => Promise<number>;
+declare const packagePublint: ({ strict, verbose }?: PackagePublintParams) => Promise<number>;
 
 declare const packageRecompile: () => Promise<number>;
 
@@ -285,93 +401,6 @@ declare const updateYarnVersion: () => number;
 
 declare const yarn3Only: () => number;
 
-declare const checkResult: (name: string, result: number, level?: "error" | "warn", exitOnFail?: boolean) => void;
-
-declare const createBuildConfig: (location: string, module: "ESNext" | "CommonJS", target: "ESNext" | "ES6", outDirSuffix: string) => Record<string, unknown> | undefined;
-
-declare const defaultBuildConfig: {
-    compilerOptions: {
-        rootDir: string;
-        rootDirs: string[];
-    };
-    exclude: string[];
-    include: string[];
-};
-
-declare const deleteGlob: (globPath: string) => void;
-
-declare const detectDuplicateDependencies: (depsFromPackageJSON?: string[], DefaultDependencies?: string[]) => number;
-
-declare class DuplicateDetector {
-    private dependency;
-    private dependencyEntries;
-    constructor(output: string, dependency: string);
-    detect(): 1 | 0;
-    private detectReducer;
-    private resultsFactory;
-}
-
-declare const WINDOWS_NEWLINE_REGEX: RegExp;
-declare const CROSS_PLATFORM_NEWLINE = "\n";
-
-type ReadFileSyncOptions = BufferEncoding | {
-    encoding: BufferEncoding;
-    flags?: string;
-};
-declare const defaultReadFileSyncOptions: ReadFileSyncOptions;
-
-declare const readLines: (uri: PathLike, options?: ReadFileSyncOptions) => string[];
-declare const readNonEmptyLines: (uri: PathLike, options?: ReadFileSyncOptions) => string[];
-declare const writeLines: (uri: PathLike, lines: string[], options?: WriteFileOptions) => void;
-
-declare const tryReadFileSync: (uri: PathLike, options?: ReadFileSyncOptions) => string | undefined;
-
-declare const generateIgnoreFiles: (filename: string, pkg?: string) => 1 | 0;
-
-declare const multiLineToJSONArray: (output: string) => any;
-
-declare const loadConfig: <T extends object>(params?: T) => Promise<T>;
-
-declare const parsedPackageJSON: (path?: string) => any;
-
-declare const processEx: (ex: unknown) => never;
-
-type ScriptStep = [/* command */ /* command */ 'yarn' | 'node' | 'ts-node-script' | 'tsc' | 'jest', /* arg */ /* arg */ string | string[]] | [/* command */ string, /* arg */ /* arg */ string | string[], /* config */ SpawnSyncOptionsWithBufferEncoding];
-declare const runSteps: (name: string, steps: ScriptStep[], exitOnFail?: boolean, messages?: string[]) => number;
-
-declare const runStepAsync: (name: string, step: ScriptStep, exitOnFail?: boolean, message?: string) => Promise<number>;
-declare const runStepsAsync: (name: string, steps: ScriptStep[], exitOnFail?: boolean, messages?: string[]) => Promise<number>;
-
-declare const runXy: (command: string) => number;
-
-declare const runXyWithWarning: (command: string) => number;
-
-/** Catch child process a crash and returns the code */
-declare const safeExit: (func: () => number, exitOnFail?: boolean) => number;
-declare const safeExitAsync: (func: () => Promise<number>, exitOnFail?: boolean) => Promise<number>;
-
-declare const empty: (value?: string | undefined) => boolean;
-declare const notEmpty: (value?: string | undefined) => boolean;
-
-declare const union: (a: string[], b: string[]) => Set<string>;
-
-declare const withErrnoException: <T extends NodeJS.ErrnoException = NodeJS.ErrnoException>(ex: unknown, closure: (error: T) => number) => number | undefined;
-
-declare const withError: <T extends Error = Error>(ex: any, closure: (error: T) => number, predicate?: (ex: T) => boolean) => number | undefined;
-
-declare const isYarnVersionOrGreater: (major: number, minor?: number, patch?: number) => [boolean, string];
-
-interface Workspace {
-    location: string;
-    name: string;
-}
-
-declare const yarnWorkspace: (pkg: string) => Workspace;
-
-declare const yarnWorkspaces: () => Workspace[];
-
-declare const INIT_CWD: () => string | undefined;
-
 type PackageJsonEx = PackageJson & {
     type: 'module' | 'commonjs';
 };
@@ -399,4 +428,4 @@ declare const xyLintCommands: (args: Argv) => Argv<{}>;
 
 declare const xyParseOptions: () => Argv;
 
-export { type BuildParams, CROSS_PLATFORM_NEWLINE, type CleanPackageParams, type CleanParams, type CompileConfig, type CompileParams, type CopyAssetsParams, type CycleParams, DuplicateDetector, type DynamicShareConfig, type EntryMode, type GenDocsPackageParams, type GenDocsParams, INIT_CWD, type LintPackageParams, type LintParams, type LiveShareConfig, type PackageCompileTscConfig, type PackageCompileTsupConfig, type PackageCopyAssetsParams, type PackageJsonEx, type PackagePublintParams, type PathConfig, type PublintPackageParams, type PublintParams, type ReadFileSyncOptions, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, type XyConfig, type XyConfigBase, type XyTscConfig, type XyTsupConfig, build, bundleDts, checkResult, clean, cleanAll, cleanDocs, cleanPackage, compile, compileAll, compilePackage, copyAssets, createBuildConfig, cycle, cycleAll, cyclePackage, dead, defaultBuildConfig, defaultReadFileSyncOptions, deleteGlob, deplint, deploy, deployMajor, deployMinor, deployNext, detectDuplicateDependencies, dupdeps, empty, fix, genDocs, genDocsAll, genDocsPackage, generateIgnoreFiles, gitignoreGen, gitlint, gitlintFix, isYarnVersionOrGreater, knip, license, lint, lintAllPackages, lintPackage, loadConfig, loadPackageConfig, multiLineToJSONArray, notEmpty, npmignoreGen, packageClean, packageCleanOutputs, packageCleanTypescript, packageCompile, packageCompileTsc, packageCompileTscTypes, packageCompileTsup, packageCopyAssets, packageCycle, packageGenDocs, packageLint, packagePublint, packageRecompile, parsedPackageJSON, processEx, publint, publintAll, publintPackage, readLines, readNonEmptyLines, rebuild, recompile, recompileAll, recompilePackage, reinstall, relint, relintAllPackages, relintPackage, retest, runStepAsync, runSteps, runStepsAsync, runXy, runXyWithWarning, safeExit, safeExitAsync, sonar, statics, test, tryReadFileSync, tsupOptions, union, up, updateYarnPlugins, updateYarnVersion, updo, withErrnoException, withError, writeLines, xy, xyBuildCommands, xyCommonCommands, xyDeployCommands, xyInstallCommands, xyLintCommands, xyParseOptions, yarn3Only, yarnWorkspace, yarnWorkspaces };
+export { type BuildParams, CROSS_PLATFORM_NEWLINE, type CleanPackageParams, type CleanParams, type CompileConfig, type CompileParams, type CopyAssetsParams, type CycleParams, type DepLintOptions, DuplicateDetector, type DynamicShareConfig, type EntryMode, type GenDocsPackageParams, type GenDocsParams, INIT_CWD, type LintPackageParams, type LintParams, type LiveShareConfig, type PackageCompileTscConfig, type PackageCompileTsupConfig, type PackageCopyAssetsParams, type PackageJsonEx, type PackagePublintParams, type PathConfig, type PublintPackageParams, type PublintParams, type ReadFileSyncOptions, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, build, bundleDts, checkResult, clean, cleanAll, cleanDocs, cleanPackage, compile, compileAll, compilePackage, copyAssets, createBuildConfig, cycle, cycleAll, cyclePackage, dead, defaultBuildConfig, defaultReadFileSyncOptions, deleteGlob, deplint, deploy, deployMajor, deployMinor, deployNext, detectDuplicateDependencies, dupdeps, empty, fix, genDocs, genDocsAll, genDocsPackage, generateIgnoreFiles, gitignoreGen, gitlint, gitlintFix, isYarnVersionOrGreater, knip, license, lint, lintAllPackages, lintPackage, loadConfig, loadPackageConfig, multiLineToJSONArray, notEmpty, npmignoreGen, packageClean, packageCleanOutputs, packageCleanTypescript, packageCompile, packageCompileTsc, packageCompileTscTypes, packageCompileTsup, packageCopyAssets, packageCycle, packageGenDocs, packageLint, packagePublint, packageRecompile, parsedPackageJSON, processEx, publint, publintAll, publintPackage, readLines, readNonEmptyLines, rebuild, recompile, recompileAll, recompilePackage, reinstall, relint, relintAllPackages, relintPackage, retest, runStepAsync, runSteps, runStepsAsync, runXy, runXyWithWarning, safeExit, safeExitAsync, sonar, statics, test, tryReadFileSync, tsupOptions, union, up, updateYarnPlugins, updateYarnVersion, updo, withErrnoException, withError, writeLines, xy, xyBuildCommands, xyCommonCommands, xyDeployCommands, xyInstallCommands, xyLintCommands, xyParseOptions, yarn3Only, yarnWorkspace, yarnWorkspaces };