@types/git-semver-tags

Installation

npm install --save @types/git-semver-tags

Summary

This package contains type definitions for git-semver-tags (https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-semver-tags#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/git-semver-tags.

index.d.ts

/**
 * Get all git semver tags of your repository in reverse chronological order
 */
declare function gitSemverTags(options?: gitSemverTags.Options): Promise<string[]>;

declare namespace gitSemverTags {
    interface Options {
        /**
         * Extract lerna style tags (`foo-package@2.0.0`) from the git history, rather
         * than `v1.0.0` format.
         */
        lernaTags?: boolean | undefined;

        /**
         * What package should lerna style tags be listed for, e.g., `foo-package`.
         */
        package?: string | undefined;

        /**
         * Specify a prefix for the git tag to be ignored from the semver checks.
         */
        tagPrefix?: string | undefined;

        /**
         * If given, unstable tags (e.g. `x.x.x-alpha.1`, `x.x.x-rc.2`) will be skipped.
         */
        skipUnstable?: boolean | undefined;
    }
}

export = gitSemverTags;

Additional Details

• Last updated: Tue, 05 Dec 2023 20:07:49 GMT
• Dependencies: none

Credits

These definitions were written by Jason Kwok, and Piotr Błażejewicz.