githublogen 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -1,144 +0,0 @@
-type SemverBumpType = 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease';
-type RepoProvider = 'github' | 'gitlab' | 'bitbucket';
-type RepoConfig = {
-    domain?: string;
-    repo?: string;
-    provider?: RepoProvider;
-    token?: string;
-};
-interface ChangelogConfig {
-    cwd: string;
-    types: Record<string, {
-        title: string;
-        semver?: SemverBumpType;
-    }>;
-    scopeMap: Record<string, string>;
-    repo: RepoConfig;
-    tokens: Partial<Record<RepoProvider, string>>;
-    from: string;
-    to: string;
-    newVersion?: string;
-    output: string | boolean;
-    gitMainBranch: string;
-}
-interface GitCommitAuthor {
-    name: string;
-    email: string;
-}
-interface RawGitCommit {
-    message: string;
-    body: string;
-    shortHash: string;
-    author: GitCommitAuthor;
-}
-interface Reference {
-    type: 'hash' | 'issue' | 'pull-request';
-    value: string;
-}
-interface GithubOptions {
-    repo: string;
-    token: string;
-}
-interface GithubRelease {
-    id?: string;
-    tag_name: string;
-    name?: string;
-    body?: string;
-    draft?: boolean;
-    prerelease?: boolean;
-}
-interface GitCommit extends RawGitCommit {
-    description: string;
-    type: string;
-    scope: string;
-    references: Reference[];
-    authors: GitCommitAuthor[];
-    isBreaking: boolean;
-}
-interface AuthorInfo {
-    commits: string[];
-    login?: string;
-    email: string;
-    name: string;
-}
-interface Commit extends GitCommit {
-    resolvedAuthors?: AuthorInfo[];
-}
-interface ChangelogOptions extends ChangelogConfig {
-    /**
-     * Dry run. Skip releasing to GitHub.
-     */
-    dry?: boolean;
-    /**
-     * Whether to include contributors in release notes.
-     *
-     * @default true
-     */
-    contributors?: boolean;
-    /**
-     * Name of the release
-     */
-    name?: string;
-    /**
-     * Mark the release as a draft
-     */
-    draft?: boolean;
-    /**
-     * Mark the release as prerelease
-     */
-    prerelease?: boolean;
-    /**
-     * Custom titles
-     */
-    titles?: {
-        breakingChanges?: string;
-    };
-    /**
-     * Capitalize commit messages
-     * @default true
-     */
-    capitalize?: boolean;
-    /**
-     * Nest commit messages under their scopes
-     * @default true
-     */
-    group?: boolean | 'multiple';
-    /**
-     * Use emojis in section titles
-     * @default true
-     */
-    emoji?: boolean;
-}
-type ResolvedChangelogOptions = Required<ChangelogOptions>;
-
-declare function sendRelease(options: ChangelogOptions, content: string): Promise<void>;
-declare function resolveAuthorInfo(options: ChangelogOptions, info: AuthorInfo): Promise<AuthorInfo>;
-declare function resolveAuthors(commits: Commit[], options: ChangelogOptions): Promise<AuthorInfo[]>;
-declare function hasTagOnGitHub(tag: string, options: ChangelogOptions): Promise<boolean>;
-
-declare function getGitHubRepo(): Promise<string>;
-declare function getGitMainBranchName(): Promise<string>;
-declare function getCurrentGitBranch(): Promise<string>;
-declare function isRepoShallow(): Promise<boolean>;
-declare function getLastGitTag(delta?: number): Promise<string>;
-declare function isRefGitTag(to: string): Promise<boolean>;
-declare function getFirstGitCommit(): Promise<string>;
-declare function isPrerelease(version: string): boolean;
-declare function getGitDiff(from: string | undefined, to?: string): Promise<RawGitCommit[]>;
-declare function getGitRemoteURL(cwd: string, remote?: string): Promise<string>;
-declare function getGitPushUrl(config: RepoConfig, token?: string): string | null;
-
-declare function generateMarkdown(commits: Commit[], options: ResolvedChangelogOptions): string;
-
-declare function generate(cwd: string, options: ChangelogOptions): Promise<{
-    config: Required<ChangelogOptions>;
-    md: string;
-    commits: GitCommit[];
-}>;
-
-declare function resolveConfig(cwd: string, options: ChangelogOptions): Promise<Required<ChangelogOptions>>;
-
-declare function parseGitCommit(commit: RawGitCommit, config: ChangelogConfig): GitCommit | null;
-declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
-
-export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, ResolvedChangelogOptions, SemverBumpType, generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitMainBranchName, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };