@xylabs/ts-scripts-yarn3 7.4.17 → 7.4.19

package/dist/index.d.ts

@@ -129,12 +129,19 @@ declare const tryReadFileSync: (uri: PathLike, options?: ReadFileSyncOptions) =>
 declare const generateIgnoreFiles: (filename: string, pkg?: string) => 1 | 0;
 
 interface GenerateReadmeFilesParams {
+    logoLinkUrl?: string;
+    logoUrl?: string;
     pkg?: string;
     templatePath?: string;
     typedoc?: boolean;
     verbose?: boolean;
 }
-declare function generateReadmeFiles({ pkg, templatePath, typedoc, verbose, }: GenerateReadmeFilesParams): Promise<number>;
+declare const DEFAULT_README_TEMPLATE: string;
+declare const DEFAULT_README_BODY: string;
+declare function applyLogoConfig(template: string, logoUrl?: string, logoLinkUrl?: string): string;
+declare function resolveTemplatePath(templatePath: string | undefined): string;
+declare function scaffoldTemplate(resolvedTemplatePath: string, template: string): Promise<void>;
+declare function generateReadmeFiles({ logoLinkUrl, logoUrl, pkg, templatePath, typedoc, verbose, }: GenerateReadmeFilesParams): Promise<number>;
 
 declare const multiLineToJSONArray: (output: string) => any;
 
@@ -144,7 +151,7 @@ declare const parsedPackageJSON: (path?: string) => any;
 
 declare const processEx: (ex: unknown) => never;
 
-type ScriptStep = [/* command */ /* command */ 'yarn' | 'node' | 'ts-node-script' | 'tsc' | 'jest' | 'npm', /* arg */ /* arg */ string | string[]] | [/* command */ string, /* arg */ /* arg */ string | string[], /* config */ SpawnSyncOptionsWithBufferEncoding];
+type ScriptStep = [/* command */ /* command */ 'yarn' | 'node' | 'ts-node-script' | 'tsc' | 'npm' | 'vitest', /* 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>;
@@ -311,6 +318,21 @@ interface DeplintConfig {
      */
     exclude?: string[];
 }
+/**
+ * Configuration for readme generation.
+ */
+interface ReadmeConfig {
+    /**
+     * URL that the logo links to when clicked.
+     * Replaces the placeholder in the template's [![logo][]](url) link.
+     */
+    logoLinkUrl?: string;
+    /**
+     * Public URL for the logo image displayed at the top of generated READMEs.
+     * Replaces the placeholder in the template's [logo] reference link.
+     */
+    logoUrl?: string;
+}
 interface XyConfigBase {
     compile?: CompileConfig;
     deplint?: DeplintConfig;
@@ -318,6 +340,7 @@ interface XyConfigBase {
     liveShare?: LiveShareConfig;
     /** @deprecated */
     publint?: boolean;
+    readme?: ReadmeConfig;
     verbose?: boolean;
 }
 interface XyTsupConfig extends XyConfigBase {
@@ -399,6 +422,12 @@ interface ReadmeGenParams {
 }
 declare function readmeGen({ pkg, templatePath, typedoc, verbose, }: ReadmeGenParams): Promise<number>;
 
+interface ReadmeInitParams {
+    templatePath?: string;
+    verbose?: boolean;
+}
+declare function readmeInit({ templatePath }: ReadmeInitParams): Promise<number>;
+
 interface RebuildParams {
     pkg?: string;
     target?: 'esm' | 'cjs';
@@ -461,16 +490,6 @@ type PackageJsonEx = PackageJson & {
 };
 declare const loadPackageConfig: () => Promise<PackageJsonEx>;
 
-declare const xy: () => Promise<{
-    [x: string]: unknown;
-    _: (string | number)[];
-    $0: string;
-} | {
-    [x: string]: unknown;
-    _: (string | number)[];
-    $0: string;
-}>;
-
 declare const xyBuildCommands: (args: Argv) => Argv<{}>;
 
 declare const xyCommonCommands: (args: Argv) => Argv<{}>;
@@ -481,6 +500,16 @@ declare const xyInstallCommands: (args: Argv) => Argv<{}>;
 
 declare const xyLintCommands: (args: Argv) => Argv<{}>;
 
+declare const xy: () => Promise<{
+    [x: string]: unknown;
+    _: (string | number)[];
+    $0: string;
+} | {
+    [x: string]: unknown;
+    _: (string | number)[];
+    $0: string;
+}>;
+
 declare const xyParseOptions: () => Argv;
 
-export { type BuildParams, CROSS_PLATFORM_NEWLINE, type CleanPackageParams, type CleanParams, type CompileConfig, type CompileParams, type CopyAssetsParams, type CycleParams, type DepLintOptions, type DeplintConfig, 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 ReadmeGenParams, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, XYLABS_COMMANDS_PREFIX, XYLABS_RULES_PREFIX, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, build, bundleDts, checkResult, claudeCommandTemplates, claudeCommands, claudeMdProjectTemplate, claudeMdRuleTemplates, claudeRules, claudeSettings, 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, generateReadmeFiles, 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, publish, readLines, readNonEmptyLines, readmeGen, 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, DEFAULT_README_BODY, DEFAULT_README_TEMPLATE, type DepLintOptions, type DeplintConfig, 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 ReadmeConfig, type ReadmeGenParams, type ReadmeInitParams, type RebuildParams, type RecompilePackageParams, type RecompileParams, type RelintPackageParams, type RelintParams, type ScriptStep, WINDOWS_NEWLINE_REGEX, type Workspace, XYLABS_COMMANDS_PREFIX, XYLABS_RULES_PREFIX, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, applyLogoConfig, build, bundleDts, checkResult, claudeCommandTemplates, claudeCommands, claudeMdProjectTemplate, claudeMdRuleTemplates, claudeRules, claudeSettings, 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, generateReadmeFiles, 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, publish, readLines, readNonEmptyLines, readmeGen, readmeInit, rebuild, recompile, recompileAll, recompilePackage, reinstall, relint, relintAllPackages, relintPackage, resolveTemplatePath, retest, runStepAsync, runSteps, runStepsAsync, runXy, runXyWithWarning, safeExit, safeExitAsync, scaffoldTemplate, sonar, statics, test, tryReadFileSync, tsupOptions, union, up, updateYarnPlugins, updateYarnVersion, updo, withErrnoException, withError, writeLines, xy, xyBuildCommands, xyCommonCommands, xyDeployCommands, xyInstallCommands, xyLintCommands, xyParseOptions, yarn3Only, yarnWorkspace, yarnWorkspaces };