@hyperfrontend/versioning/repository

repository/

Repository detection and compare URL generation for changelog entries.

Overview

This module handles repository configuration for generating compare URLs in changelog entries. It supports automatic detection from package.json or git remotes, with built-in formatters for GitHub, GitLab, Bitbucket, and Azure DevOps.

Supported Platforms

Platform	Compare URL Format
GitHub	`{baseUrl}/compare/{fromCommit}...{toCommit}`
GitLab	`{baseUrl}/-/compare/{fromCommit}...{toCommit}`
Bitbucket	`{baseUrl}/compare/{toCommit}..{fromCommit}` (reversed)
Azure DevOps	`{baseUrl}?version=GT{toCommit}&compareVersion=GT{from}`

Usage Examples

Parse Repository URL

import { parseRepositoryUrl } from '@hyperfrontend/versioning/repository/parse'

// HTTPS URLs
parseRepositoryUrl('https://github.com/owner/repo')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// SSH URLs
parseRepositoryUrl('git@github.com:owner/repo.git')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// GitLab with subgroups
parseRepositoryUrl('https://gitlab.com/group/subgroup/project')
// → { platform: 'gitlab', baseUrl: 'https://gitlab.com/group/subgroup/project' }

Generate Compare URL

import { createRepositoryConfig } from '@hyperfrontend/versioning/repository'
import { createCompareUrl } from '@hyperfrontend/versioning/repository/url'

const repo = createRepositoryConfig({
  platform: 'github',
  baseUrl: 'https://github.com/owner/repo',
})

createCompareUrl({
  repository: repo,
  fromCommit: 'abc1234',
  toCommit: 'def5678',
})
// → 'https://github.com/owner/repo/compare/abc1234...def5678'

Custom Platform Formatter

import { createRepositoryConfig } from '@hyperfrontend/versioning/repository'

const repo = createRepositoryConfig({
  platform: 'custom',
  baseUrl: 'https://my-git.internal/repo',
  formatCompareUrl: (from, to) => `https://my-git.internal/diff/${from}/${to}`,
})

Flow Integration

The repository module integrates with the versioning flow via the repository config option:

import { createVersionFlow } from '@hyperfrontend/versioning/flow'

// Auto-detect from package.json or git remote
const flow = createVersionFlow('conventional', {
  repository: 'inferred',
})

// Explicit configuration
const flow2 = createVersionFlow('conventional', {
  repository: {
    mode: 'explicit',
    repository: {
      platform: 'github',
      baseUrl: 'https://github.com/owner/repo',
    },
  },
})

// Disable compare URLs
const flow3 = createVersionFlow('conventional', {
  repository: 'disabled',
})

Constants

Export	Value	Description
`PLATFORM_HOSTNAMES`	Map of hostnames to platforms	Known platform hostname mapping
`DEFAULT_INFERENCE_ORDER`	`['package-json', 'git-remote']`	Default inference source order

API Reference§

ƒ Functions

§function

createCompareUrl(options: CreateCompareUrlOptions): string

Creates a platform-specific compare URL for viewing changes between two commits.
Each platform has a different URL format:

GitHub: {baseUrl}/compare/{fromCommit}...{toCommit} (three dots)
GitLab: {baseUrl}/-/compare/{fromCommit}...{toCommit} (three dots, /-/ prefix)
Bitbucket: {baseUrl}/compare/{toCommit}..{fromCommit} (two dots, reversed order)
Azure DevOps: {baseUrl}/compare?version=GT{toCommit}&compareVersion=GT{fromCommit} (query params)

For custom platforms, a formatCompareUrl function must be provided in the repository config. For unknown platforms, returns null.

Parameters

Name	Type	Description
§options	`CreateCompareUrlOptions`	Compare URL options including repository, fromCommit, and toCommit

Returns

string

The compare URL string, or null if URL cannot be generated

Example

Creating platform-specific compare URLs

// GitHub
createCompareUrl({
  repository: { platform: 'github', baseUrl: 'https://github.com/owner/repo' },
  fromCommit: 'abc1234',
  toCommit: 'def5678'
})
// → 'https://github.com/owner/repo/compare/abc1234...def5678'

// GitLab
createCompareUrl({
  repository: { platform: 'gitlab', baseUrl: 'https://gitlab.com/group/project' },
  fromCommit: 'abc1234',
  toCommit: 'def5678'
})
// → 'https://gitlab.com/group/project/-/compare/abc1234...def5678'

// Bitbucket (reversed order)
createCompareUrl({
  repository: { platform: 'bitbucket', baseUrl: 'https://bitbucket.org/owner/repo' },
  fromCommit: 'abc1234',
  toCommit: 'def5678'
})
// → 'https://bitbucket.org/owner/repo/compare/def5678..abc1234'

// Azure DevOps
createCompareUrl({
  repository: { platform: 'azure-devops', baseUrl: 'https://dev.azure.com/org/proj/_git/repo' },
  fromCommit: 'abc1234',
  toCommit: 'def5678'
})
// → 'https://dev.azure.com/org/proj/_git/repo/compare?version=GTdef5678&compareVersion=GTabc1234'

// Custom formatter
createCompareUrl({
  repository: {
    platform: 'custom',
    baseUrl: 'https://my-git.internal/repo',
    formatCompareUrl: (from, to) => `https://my-git.internal/diff/${from}/${to}`
  },
  fromCommit: 'abc1234',
  toCommit: 'def5678'
})
// → 'https://my-git.internal/diff/abc1234/def5678'

View source →

§function

createDisabledResolution(): RepositoryResolution

Creates a disabled repository resolution configuration.
No compare URLs will be generated.

Returns

RepositoryResolution

A RepositoryResolution with mode 'disabled'

Example

Disabling repository resolution

const config = createDisabledResolution()
// { mode: 'disabled' }

View source →

§function

createExplicitResolution(repository: RepositoryConfig): RepositoryResolution

Creates an explicit repository resolution configuration.

Parameters

Name	Type	Description
§repository	`RepositoryConfig`	The repository config to use

Returns

RepositoryResolution

A RepositoryResolution with mode 'explicit'

Example

Using an explicit repository configuration

const config = createExplicitResolution({
  platform: 'github',
  baseUrl: 'https://github.com/owner/repo'
})

View source →

§function

createInferredResolution(inferenceOrder: unknown): RepositoryResolution

Creates an inferred repository resolution configuration.

Parameters

Name	Type	Description
§inferenceOrder	`unknown`	Order to try inference sources (default: package-json first)(default: `...`)

Returns

RepositoryResolution

A RepositoryResolution with mode 'inferred'

Example

Configuring inference order

// Default order: package.json → git remote
const config = createInferredResolution()

// Custom order: git remote → package.json
const customOrder = createInferredResolution(['git-remote', 'package-json'])

View source →

§function

createRepositoryConfig(options: CreateRepositoryConfigOptions): RepositoryConfig

Creates a new RepositoryConfig.
Normalizes the base URL by stripping trailing slashes and validating that custom platforms have a formatter function.

Parameters

Name	Type	Description
§options	`CreateRepositoryConfigOptions`	Repository configuration options

Returns

RepositoryConfig

A new RepositoryConfig object

Example

Creating repository configurations

// GitHub repository
const config = createRepositoryConfig({
  platform: 'github',
  baseUrl: 'https://github.com/owner/repo'
})

// Custom platform
const customConfig = createRepositoryConfig({
  platform: 'custom',
  baseUrl: 'https://my-git.internal/repo',
  formatCompareUrl: (from, to) => `https://my-git.internal/diff/${from}/${to}`
})

View source →

§function

createRepositoryConfigFromUrl(gitUrl: string): RepositoryConfig

Creates a RepositoryConfig from a git URL.
This is a convenience function that combines parseRepositoryUrl with createRepositoryConfig to produce a ready-to-use configuration.

Parameters

Name	Type	Description
§gitUrl	`string`	Git repository URL in any supported format

Returns

RepositoryConfig

RepositoryConfig or null if URL cannot be parsed

Example

Creating config from git URLs

const config = createRepositoryConfigFromUrl('https://github.com/owner/repo'))
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

const config = createRepositoryConfigFromUrl('git@gitlab.com:group/project.git')
// → { platform: 'gitlab', baseUrl: 'https://gitlab.com/group/project' }

View source →

§function

detectPlatformFromHostname(hostname: string): RepositoryPlatform

Detects platform from a hostname.
First checks for exact match in known platforms, then applies heuristics for self-hosted instances (e.g., github.company.com → github).

Parameters

Name	Type	Description
§hostname	`string`	Hostname to detect platform from (e.g., "github.com")

Returns

RepositoryPlatform

Detected platform or 'unknown' if not recognized

Example

Detecting platform from hostname

detectPlatformFromHostname('github.com')           // 'github'
detectPlatformFromHostname('gitlab.mycompany.com') // 'gitlab'
detectPlatformFromHostname('custom-git.internal')  // 'unknown'

View source →

§function

extractRepositoryUrl(packageJsonContent: string): string

Extracts the repository URL from package.json content.
Unlike inferRepositoryFromPackageJson, this returns just the URL string without creating a RepositoryConfig. Useful when you need the raw URL.

Parameters

Name	Type	Description
§packageJsonContent	`string`	Raw JSON string content of package.json

Returns

string

Repository URL string or null if not found

Example

Extracting raw repository URL

extractRepositoryUrl('{"repository": {"url": "https://github.com/owner/repo"}}')
// → 'https://github.com/owner/repo'

extractRepositoryUrl('{"repository": "github:owner/repo"}')
// → null (shorthand is not a URL)

View source →

§function

inferRepositoryFromPackageJson(packageJsonContent: string): RepositoryConfig

Infers repository configuration from package.json content.
Handles multiple formats:

Shorthand: "github:owner/repo", "gitlab:group/project", "bitbucket:team/repo"
Bare shorthand: "owner/repo" (defaults to GitHub)
URL string: "https://github.com/owner/repo"
Object with URL: { "type": "git", "url": "https://..." }

Parameters

Name	Type	Description
§packageJsonContent	`string`	Raw JSON string content of package.json

Returns

RepositoryConfig

RepositoryConfig or null if repository cannot be inferred

Example

Inferring repository from package.json content

// Shorthand format
inferRepositoryFromPackageJson('{"repository": "github:owner/repo"}')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// URL string
inferRepositoryFromPackageJson('{"repository": "https://github.com/owner/repo"}')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// Object format
inferRepositoryFromPackageJson('{"repository": {"type": "git", "url": "https://github.com/owner/repo"}}')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// Bare shorthand (defaults to GitHub)
inferRepositoryFromPackageJson('{"repository": "owner/repo"}')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

View source →

§function

inferRepositoryFromPackageJsonObject(packageJson: PackageJsonForRepository): RepositoryConfig

Infers repository configuration from a parsed package.json object.
This is useful when you already have the parsed object.

Parameters

Name	Type	Description
§packageJson	`PackageJsonForRepository`	Parsed package.json object

Returns

RepositoryConfig

RepositoryConfig or null if repository cannot be inferred

Example

Inferring repository from parsed object

const pkg = { repository: 'github:owner/repo' }
inferRepositoryFromPackageJsonObject(pkg)
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

View source →

§function

isKnownPlatform(platform: RepositoryPlatform): unknown

Checks if a platform identifier is a known platform with built-in support.

Parameters

Name	Type	Description
§platform	`RepositoryPlatform`	Platform identifier to check

Returns

unknown

True if the platform is a known platform

Example

Checking if platform has built-in support

isKnownPlatform('github')     // true
isKnownPlatform('gitlab')     // true
isKnownPlatform('custom')     // false
isKnownPlatform('unknown')    // false

View source →

§function

isRepositoryConfig(value: unknown): unknown

Checks if a value is a RepositoryConfig object.

Parameters

Name	Type	Description
§value	`unknown`	Value to check

Returns

unknown

True if the value is a RepositoryConfig

Example

Type-checking repository config values

const config = { platform: 'github', baseUrl: 'https://...' }
if (isRepositoryConfig(config)) {
  // config is typed as RepositoryConfig
}

View source →

§function

isRepositoryResolution(value: unknown): unknown

Checks if a value is a RepositoryResolution object.

Parameters

Name	Type	Description
§value	`unknown`	Value to check

Returns

unknown

True if the value is a RepositoryResolution

Example

Type-checking resolution configurations

import { isRepositoryResolution } from '@hyperfrontend/versioning'

const config = loadConfig()
if (isRepositoryResolution(config.repository)) {
  console.log('Repository mode:', config.repository.mode)
}

View source →

§function

parseRepositoryUrl(gitUrl: string): ParsedRepository

Parses a git URL and extracts platform and base URL.
Supports multiple URL formats:

https://github.com/owner/repo
https://github.com/owner/repo.git
git+https://github.com/owner/repo.git
git://github.com/owner/repo.git
git@github.com:owner/repo.git (SSH format)

Handles self-hosted instances by detecting platform from hostname:

github.mycompany.com → github
gitlab.internal.com → gitlab

Handles Azure DevOps URL formats:

https://dev.azure.com/org/project/_git/repo
https://org.visualstudio.com/project/_git/repo

Parameters

Name	Type	Description
§gitUrl	`string`	Git repository URL in any supported format

Returns

ParsedRepository

Parsed repository info with platform and base URL, or null if parsing fails

Example

Parsing various git URL formats

// GitHub HTTPS
parseRepositoryUrl('https://github.com/owner/repo')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// SSH format
parseRepositoryUrl('git@github.com:owner/repo.git')
// → { platform: 'github', baseUrl: 'https://github.com/owner/repo' }

// Azure DevOps
parseRepositoryUrl('https://dev.azure.com/org/proj/_git/repo')
// → { platform: 'azure-devops', baseUrl: 'https://dev.azure.com/org/proj/_git/repo' }

// Self-hosted GitLab
parseRepositoryUrl('https://gitlab.mycompany.com/team/project')
// → { platform: 'gitlab', baseUrl: 'https://gitlab.mycompany.com/team/project' }

View source →

◈ Interfaces

§interface

CreateCompareUrlOptions

Options for creating a compare URL.

Properties

§readonly fromCommit:stringSource commit hash for comparison (older version). Must be a full or abbreviated commit hash.

§readonly repository:RepositoryConfigRepository configuration containing platform and base URL.

§readonly toCommit:stringTarget commit hash for comparison (newer version). Must be a full or abbreviated commit hash.

View source →

§interface

CreateRepositoryConfigOptions

Options for creating a repository config.

Properties

§readonly baseUrl:stringBase URL for the repository. Trailing slashes will be automatically stripped.

§readonly formatCompareUrl?:CompareUrlFormatterCustom compare URL formatter. Required when platform is 'custom'.

§readonly platform:RepositoryPlatformPlatform type - determines URL format for known platforms.

View source →

§interface

PackageJsonForRepository

Minimal package.json structure for repository inference.

Properties

§readonly repository?:string | PackageJsonRepositoryRepository field - can be a string or object.

View source →

§interface

PackageJsonRepository

Repository field formats from package.json.
Package.json supports multiple formats for the repository field:

Shorthand: "github:owner/repo"
URL string: "https://github.com/owner/repo"
Object: { "type": "git", "url": "..." }

Properties

§readonly directory?:stringDirectory within the repository (for monorepos).

§readonly type?:stringRepository type (typically "git").

§readonly url:stringRepository URL.

View source →

§interface

ParsedRepository

Parsed repository information extracted from a git URL.

Properties

§readonly baseUrl:stringBase URL for the repository (without trailing slashes or .git suffix).

§readonly platform:RepositoryPlatformDetected platform type.

View source →

§interface

RepositoryConfig

Repository configuration for compare URL generation.
Supports both standard platforms and self-hosted instances. When using a known platform, compare URLs are generated automatically. For custom or unknown platforms, provide a formatCompareUrl function.

Properties

§readonly baseUrl:stringBase URL for the repository.
This is the URL without any trailing slashes or paths like /compare.

§readonly formatCompareUrl?:CompareUrlFormatterCustom compare URL formatter.
Required when platform is 'custom'. Optional for known platforms (overrides built-in formatter).
Receives the from and to tags, returns the full compare URL.

§readonly platform:RepositoryPlatformPlatform type - determines URL format for known platforms.

View source →

§interface

RepositoryResolution

Full repository resolution configuration.
Provides fine-grained control over repository resolution behavior.

Properties

§readonly inferenceOrder?:unknownInference source order when mode is 'inferred'.
Sources are tried in order until one succeeds. Default: ['package-json', 'git-remote']

§readonly mode:RepositoryResolutionModeResolution mode.

§readonly repository?:RepositoryConfigExplicit repository config.
Required when mode is 'explicit'. Ignored when mode is 'inferred' or 'disabled'.

View source →

◆ Types

§type

CompareUrlFormatter

Custom compare URL formatter function.

type CompareUrlFormatter = (fromCommit: string, toCommit: string) => string

View source →

§type

KnownPlatform

Known git hosting platforms with built-in compare URL support.
Each platform has a specific URL format for compare links:

github: {baseUrl}/compare/{fromCommit}...{toCommit}
gitlab: {baseUrl}/-/compare/{fromCommit}...{toCommit}
bitbucket: {baseUrl}/compare/{toCommit}..{fromCommit} (reversed order)
azure-devops: {baseUrl}/compare?version=GT{toCommit}&compareVersion=GT{fromCommit}

type KnownPlatform = "github" | "gitlab" | "bitbucket" | "azure-devops"

View source →

§type

RepositoryInferenceSource

Sources for repository inference, in order of preference.

package-json: Read from repository field in package.json
git-remote: Read from git remote get-url origin

type RepositoryInferenceSource = "package-json" | "git-remote"

View source →

§type

RepositoryPlatform

Platform identifier.

Known platforms have built-in compare URL formatters
custom requires a custom formatCompareUrl function
unknown indicates platform could not be determined (no URL generation)

type RepositoryPlatform = KnownPlatform | "custom" | "unknown"

View source →

§type

RepositoryResolutionMode

How to resolve repository information for compare URLs.

explicit: Use only the provided RepositoryConfig; error if missing
inferred: Auto-detect from package.json repository field or git remote
disabled: Do not generate compare URLs (default for backward compatibility)

type RepositoryResolutionMode = "explicit" | "inferred" | "disabled"

View source →

● Variables

§type

DEFAULT_INFERENCE_ORDER

Default inference order when mode is 'inferred'.

View source →

§type

PLATFORM_HOSTNAMES

Known platform hostnames mapped to their platform type. Used for automatic platform detection from repository URLs.
Includes both standard SaaS domains and common patterns for self-hosted instances.

View source →