commit message parsing using magic-regexp https://regexp.dev

index.mjs

import assert from 'node:assert';
import {
  createRegExp,
  exactly,
  oneOrMore,
  char,
  wordChar,
  whitespace,
  maybe,
} from 'magic-regexp';


// type(scope): [ticket] desc
const a = createRegExp(
  oneOrMore(wordChar)
    .groupedAs('type')
    .and(
      exactly('(')
        .and(maybe(oneOrMore(char)).groupedAs('scope'))
        .and(exactly(')'))
        .optionally()
    )
    .and(oneOrMore(whitespace).optionally())
    .and(exactly(':'))
    .and(oneOrMore(whitespace).optionally())
    .and(
      exactly('[')
        .and(oneOrMore(char).groupedAs('ticket'))
        .and(exactly(']'))
        .optionally()
    )
    .and(maybe(oneOrMore(char)).groupedAs('desc'))
);

const tests = [
  'invalid',
  'test',
  'chore: update',
  'fix(careX): tmp',
  'fix: [SD-1234] ok',
  'fix: [aa]',
  'fix(all): [sxxx] aa',
  'fix(all): [1234] (with paren)',
];
for (const entry of tests) {
  console.log(entry, entry.match(a)?.groups);
}