@eighty4/changelog/lib/task.check.ts

Changelog utilities for CICD

import { BadChangelogError, CliError } from './errors.ts'
import { inspectChangelog } from './inspect.ts'
import { readChangelogFile } from './readChangelog.ts'

export type CheckUnreleasedOpts = {
    changelogFile: string
}

export function parseArgs(args: Array<string>): CheckUnreleasedOpts {
    const opts: CheckUnreleasedOpts = {
        changelogFile: 'CHANGELOG.md',
    }
    let shifted
    while ((shifted = args.shift())) {
        switch (shifted) {
            case '--changelog-file':
                if (typeof (shifted = args.shift()) === 'undefined') {
                    throw new CliError('--changelog-file value is missing')
                }
                opts.changelogFile = shifted
                break
            default:
                throw new CliError(`bad arg \`${shifted}\``)
        }
    }
    return opts
}

export async function checkUnreleasedFromCliArgs(
    args: Array<string>,
): Promise<boolean> {
    return await checkUnreleased(parseArgs(args))
}

export async function checkUnreleased(
    opts: CheckUnreleasedOpts,
): Promise<boolean> {
    const changelogContent = await readChangelogFile(opts.changelogFile)
    const inspectResult = inspectChangelog(changelogContent)
    if (inspectResult.errors.length) {
        throw new BadChangelogError(opts.changelogFile, inspectResult.errors)
    }
    const notes = /## \[Unreleased\](?<notes>[\s\S]+?)(?=\s+(## |\[))/
        .exec(changelogContent)
        ?.groups?.notes?.trim()
    if (!notes?.length) {
        return false
    }
    return (
        notes.split(/\r?\n/).filter(l => {
            if (l.startsWith('### ')) {
                return false
            }
            l = l.trim()
            return l.length && !/^(\*|\-|\+)\s\?\?\?$/.test(l)
        }).length > 0
    )
}