interface FileUpdatePattern

Defines how additional files are updated during the release process. Can use either regex patterns for find/replace or a custom update function.

Examples

Using patterns:

{
  path: "./package.json",
  patterns: {
    version: /^(\s*)"version":\s*"([^"]+)"/m
  }
}

Using custom update function:

{
  path: "./README.md",
  updateFn: (content, data) => {
    return content.replace(/Version: \d+\.\d+\.\d+/, `Version: ${data.version}`);
  }
}

Properties

path: string

File path relative to project root

optional
patterns: { [key: string]: RegExp; }

Patterns to find and replace Required if updateFn is not provided

optional
updateFn: (
content: string,
) => string

Optional custom update function If provided, overrides patterns

Usage

import { type FileUpdatePattern } from ".";