Changelog Date Formatter

A utility for generating changelogs from commit data with configurable timezone formatting.

Capabilities

Generate changelog with UTC dates

• Given commit data with committerDate "2024-01-15T14:30:00Z", generates a changelog with dates formatted in UTC timezone @test

Generate changelog with specific timezone

• Given commit data with committerDate "2024-01-15T14:30:00Z" and timezone set to "America/New_York", generates a changelog with dates formatted in America/New_York timezone @test

Generate changelog with different timezone

• Given commit data with committerDate "2024-06-20T09:00:00Z" and timezone set to "Asia/Tokyo", generates a changelog with dates formatted in Asia/Tokyo timezone @test

Default timezone behavior

• Given commit data without specifying timezone option, generates a changelog with dates formatted in UTC timezone by default @test

Implementation

@generates

API

/**
 * Generates a changelog string from commit data with configurable timezone formatting.
 *
 * @param {Array} commits - Array of commit objects with committerDate fields
 * @param {Object} options - Configuration options
 * @param {string} options.timezone - The timezone to use for date formatting (e.g., "UTC", "America/New_York", "Asia/Tokyo")
 * @returns {Promise<string>} The formatted changelog string
 */
async function generateChangelog(commits, options) {
  // IMPLEMENTATION HERE
}

module.exports = { generateChangelog };

Dependencies { .dependencies }

conventional-changelog-writer { .dependency }

Provides changelog generation with timezone configuration support.

@satisfied-by