@better-builds/lets-version
Version:
A package that reads your conventional commits and git history and recommends (or applies) a SemVer version bump for you
29 lines (28 loc) • 1.17 kB
TypeScript
import type { PackageJson } from 'type-fest';
import type { ChangeLogEntryFormatter, ChangeLogLineFormatter, ChangeLogRollupFormatter } from './types.js';
export interface ChangelogConfig {
changeLogEntryFormatter?: ChangeLogEntryFormatter;
changelogLineFormatter?: ChangeLogLineFormatter;
changeLogRollupFormatter?: ChangeLogRollupFormatter;
}
export interface LetsVersionConfig {
changelog?: ChangelogConfig;
}
/**
* Utility function that returns an array of all paths
* in the CWD up to the root
*/
declare function getAllFoldersUpToRoot(cwd: string): string[];
/**
* Attempts to read the nearest turboTools.config.js file (if it exists)
* and returns its contents
*/
export declare function readLetsVersionConfig(cwd: string): Promise<LetsVersionConfig | null>;
/**
* Simple pass-through utility for providing TypeScript typings
* in non-TS environments when defining a config override
*/
export declare function defineLetsVersionConfig(config: LetsVersionConfig): LetsVersionConfig;
export type { PackageJson };
export type { ChangeLogEntryFormatter, ChangeLogLineFormatter, ChangeLogRollupFormatter };
export { getAllFoldersUpToRoot };