Synchronous Parser

/**
 * Commit message parser with configurable options
 */
class CommitParser {
  /**
   * Create a new parser with optional configuration
   * @param options - Parser configuration options
   */
  constructor(options?: ParserOptions);
  
  /**
   * Parse commit message string into structured object
   * @param input - Raw commit message string
   * @returns Parsed commit object with structured data
   * @throws TypeError if input is empty or whitespace only
   */
  parse(input: string): Commit;
}

import { CommitParser } from "conventional-commits-parser";

// Basic parsing with default options
const parser = new CommitParser();
const commit = parser.parse("feat: add new feature");

console.log(commit.type);     // "feat"
console.log(commit.subject);  // "add new feature"

// Parsing with custom options
const customParser = new CommitParser({
  headerPattern: /^(\w*)(?:\(([\w$.\-* ]*)\))?: (.*)$/,
  headerCorrespondence: ['type', 'scope', 'subject'],
  noteKeywords: ['BREAKING CHANGE', 'DEPRECATED'],
  issuePrefixes: ['#', 'gh-'],
  referenceActions: ['closes', 'fixes', 'resolves']
});

const complexCommit = `feat(parser): add custom regex support

Added support for custom regex patterns to handle
different commit message formats.

BREAKING CHANGE: Parser constructor now requires options parameter

Closes #123
Fixes gh-456`;

const result = customParser.parse(complexCommit);
console.log(result.type);        // "feat"
console.log(result.scope);       // "parser" 
console.log(result.body);        // Multi-line body text
console.log(result.notes.length); // 1 (breaking change note)
console.log(result.references.length); // 2 (issue references)

/**
 * Helper to create commit object with default empty structure
 * @param initialData - Optional initial commit data to merge
 * @returns Commit object with empty/default values
 */
function createCommitObject(initialData?: Partial<Commit>): Commit;

import { createCommitObject } from "conventional-commits-parser";

// Create empty commit object
const emptyCommit = createCommitObject();
console.log(emptyCommit.header);     // null
console.log(emptyCommit.notes);      // []
console.log(emptyCommit.references); // []

// Create commit with initial data
const partialCommit = createCommitObject({
  header: "feat: initial commit",
  type: "feat",
  subject: "initial commit"
});
console.log(partialCommit.header);  // "feat: initial commit"
console.log(partialCommit.type);    // "feat"
console.log(partialCommit.body);    // null (default)

import { CommitParser } from "conventional-commits-parser";

const parser = new CommitParser();

try {
  parser.parse("");  // Empty string
} catch (error) {
  console.log(error.message); // "Expected a raw commit"
}

try {
  parser.parse("   ");  // Whitespace only
} catch (error) {
  console.log(error.message); // "Expected a raw commit"
}