0
0
mirror of https://github.com/renovatebot/renovate.git synced 2024-12-22 13:38:32 +00:00
renovatebot_renovate/lib/workers/repository/model/semantic-commit-message.ts
2023-09-06 11:26:22 +00:00

73 lines
1.6 KiB
TypeScript

import type { CommitMessageJSON } from '../../../types';
import { CommitMessage } from './commit-message';
export interface SemanticCommitMessageJSON extends CommitMessageJSON {
scope?: string;
type?: string;
}
/**
* @see https://www.conventionalcommits.org/en/v1.0.0/#summary
*
* <type>[optional scope]: <description>
* [optional body]
* [optional footer]
*/
export class SemanticCommitMessage extends CommitMessage {
private static readonly REGEXP =
/^(?<type>[\w]+)(\((?<scope>[\w-]+)\))?(?<breaking>!)?: ((?<issue>([A-Z]+-|#)[\d]+) )?(?<description>.*)/;
private _scope = '';
private _type = '';
static is(value: unknown): value is SemanticCommitMessage {
return value instanceof SemanticCommitMessage;
}
static fromString(value: string): SemanticCommitMessage | undefined {
const match = value.match(SemanticCommitMessage.REGEXP);
if (!match?.groups) {
return undefined;
}
const { groups } = match;
const message = new SemanticCommitMessage();
message.type = groups.type;
message.scope = groups.scope;
message.subject = groups.description;
return message;
}
override toJSON(): SemanticCommitMessageJSON {
const json = super.toJSON();
return {
...json,
scope: this._scope,
type: this._type,
};
}
set scope(value: string) {
this._scope = this.normalizeInput(value);
}
set type(value: string) {
this._type = this.normalizeInput(value);
}
protected get prefix(): string {
if (this._type && !this._scope) {
return this._type;
}
if (this._scope) {
return `${this._type}(${this._scope})`;
}
return '';
}
}