@xylabs/ts-scripts-yarn3 7.4.10 → 7.4.12

package/dist/index.d.ts

@@ -126,6 +126,14 @@ declare const tryReadFileSync: (uri: PathLike, options?: ReadFileSyncOptions) =>
 
 declare const generateIgnoreFiles: (filename: string, pkg?: string) => 1 | 0;
 
+interface GenerateReadmeFilesParams {
+    pkg?: string;
+    templatePath?: string;
+    typedoc?: boolean;
+    verbose?: boolean;
+}
+declare function generateReadmeFiles({ pkg, templatePath, typedoc, verbose, }: GenerateReadmeFilesParams): Promise<number>;
+
 declare const multiLineToJSONArray: (output: string) => any;
 
 declare const loadConfig: <T extends object>(params?: T) => Promise<T>;
@@ -173,14 +181,21 @@ declare const INIT_CWD: () => string | undefined;
 interface CheckPackageOptions {
     deps?: boolean;
     devDeps?: boolean;
+    /**
+     * Set of package names to exclude from unused-dependency checks.
+     * Loaded from xy.config's deplint.exclude field.
+     */
+    exclude?: Set<string>;
     peerDeps?: boolean;
     verbose?: boolean;
 }
 
 interface DepLintOptions extends CheckPackageOptions {
+    /** Package names to exclude, passed via --exclude on the command line */
+    cliExclude?: string[];
     pkg?: string;
 }
-declare const deplint: ({ pkg, deps, devDeps, peerDeps, verbose, }: DepLintOptions) => number;
+declare const deplint: ({ pkg, deps, devDeps, peerDeps, verbose, cliExclude, }: DepLintOptions) => Promise<number>;
 
 declare const deploy: () => number;
 
@@ -281,8 +296,22 @@ type PackageCompileTsupConfig = CompileConfig & {
 type PackageCompileTscConfig = CompileConfig & {
     mode: 'tsc';
 };
+/**
+ * Configuration for deplint (dependency linting).
+ */
+interface DeplintConfig {
+    /**
+     * Package names to exclude from unused-dependency checks.
+     * Packages listed here will never be reported as "unused" by deplint,
+     * even if no import for them is detected in source or dist files.
+     * Useful for packages that are used implicitly (e.g. runtime plugins,
+     * CSS-in-JS themes, or polyfills that have side effects on import).
+     */
+    exclude?: string[];
+}
 interface XyConfigBase {
     compile?: CompileConfig;
+    deplint?: DeplintConfig;
     dynamicShare?: DynamicShareConfig;
     liveShare?: LiveShareConfig;
     /** @deprecated */
@@ -360,6 +389,14 @@ declare const publintAll: ({ verbose }: PublintParams) => number;
 
 declare const publish: () => number;
 
+interface ReadmeGenParams {
+    pkg?: string;
+    templatePath?: string;
+    typedoc?: boolean;
+    verbose?: boolean;
+}
+declare function readmeGen({ pkg, templatePath, typedoc, verbose, }: ReadmeGenParams): Promise<number>;
+
 interface RebuildParams {
     pkg?: string;
     target?: 'esm' | 'cjs';
@@ -444,4 +481,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, 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, XYLABS_COMMANDS_PREFIX, XYLABS_RULES_PREFIX, type XyConfig, type XyConfigBase, type XyConfigLegacy, type XyTscConfig, type XyTsupConfig, build, bundleDts, checkResult, claudeCommandTemplates, claudeCommands, claudeMdProjectTemplate, claudeMdRuleTemplates, claudeRules, 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, publish, 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, 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, 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 };