interface NagareConfig

Main configuration interface for Nagare

Properties

project: { name: string; description?: string; repository: string; homepage?: string; license?: string; author?: string; }

Project metadata

Version file configuration

optional
releaseNotes: ReleaseNotesConfig

Release notes configuration

GitHub integration settings

Files to update during release

Custom commit type mappings

optional
templates: TemplateConfig

Template configuration

optional
docs: DocsConfig

Documentation generation

optional
options: ReleaseOptions

Advanced options

optional
security: SecurityConfig

Security settings for template processing and file operations. Controls sandboxing levels and validation strictness.

optional
release: ReleaseConfig

Advanced release workflow settings including JSR verification, auto-fix capabilities, and progress visualization.

optional
hooks: { preRelease?: Array<() => Promise<void>>; postRelease?: Array<() => Promise<void>>; }

Hooks allow running custom functions at specific points in the release process. Useful for tasks like formatting, validation, or custom notifications.

optional
locale: string

Set the language for all CLI output, error messages, and prompts. If not specified, auto-detects from NAGARE_LOCALE or system locale.