Himenon / commit-mesage-parser

commit message parser

Home Page:https://www.npmjs.com/package/@himenon/commit-message-parser

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@himenon/commit-message-parser

commit message parser

Usage

Install

npm  install @himenon/commit-message-parser
yarn add     @himenon/commit-message-parser
pnpm install @himenon/commit-message-parser

API

import { parseCommitMessage } from "@himenon/commit-message-parser";

parseCommitMessage("feat: new features");
{
  type: "feat",
  shortSummary: "new features",
  firstLineFullMessage: "feat: new features",
  parsed: ["type", "short-summary", "first-line"],
}

const tooLengthCommitMessage = `feat: abcdefg

body text
next body text`

parseCommitMessage(tooLengthCommitMessage);
{
  type: "feat",
  shortSummary: "abcdefg",
  firstLineFullMessage: "feat: abcdefg",
  parsed: ["type", "short-summary", "first-line", "body"],
  body: `body text
next body text`,
}

Release

  • Automatic version updates are performed when merged into the main branch.

LICENCE

@Himenon/commit-message-parser・MIT

About

commit message parser

https://www.npmjs.com/package/@himenon/commit-message-parser

License:MIT License


Languages

Language:TypeScript 85.8%Language:JavaScript 14.2%