@halospv3/hce.shared-config/src/semantic-release__commit-analyzer.d.ts

Automate commit message quality, changelogs, and CI/CD releases. Exports a semantic-release shareable configuration deserialized from this package's '.releaserc.yml'. Shared resources for .NET projects are also distributed with this package.

declare module '@semantic-release/commit-analyzer' {

    interface RuleObject {
        type?: string,
        scope?: string,
        release: string
    }

    type AnyRecord = Record<keyof unknown, unknown>;

    export interface CommitAnalyzerConfig {
        preset?: string,
        config?: string,
        parserOpts?: AnyRecord,
        releaseRules?: string | RuleObject[],
        presetConfig?: AnyRecord
    }

    /**
     * Determine the type of release to create based on a list of commits.
     *
     * @param {Object} pluginConfig The plugin configuration.
     * @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
     * @param {String} pluginConfig.config Requireable npm package with a custom conventional-changelog preset
     * @param {String|Array} pluginConfig.releaseRules A `String` to load an external module or an `Array` of rules.
     * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
     * @param {Object} context The semantic-release context.
     * @param {Array<Object>} context.commits The commits to analyze.
     * @param {String} context.cwd The current working directory.
     *
     * @returns {Promise<String|null>} the type of release to create based on the list of commits or `null` if no release has to be done.
     * 
     * @see 'file://./../node_modules/@semantic-release/commit-analyzer/index.js'
     */
    export function analyzeCommits(pluginConfig: {
        preset: string;
        config: string;
        releaseRules: string | AnyRecord[];
        parserOpts: unknown;
    }, context: {
        commits: unknown[];
        cwd: string;
    }): Promise<string | null>;
}