feat(cz-customizable): added footer ticket number suffix (#237)

Co-authored-by: Prateek <hypernovadev@gmail.com>

.cz-config.js

@@ -31,6 +31,7 @@ module.exports = {
  allowTicketNumber: false,
  isTicketNumberRequired: false,
  ticketNumberPrefix: 'TICKET-',
+ ticketNumberSuffix:'',
  ticketNumberRegExp: '\\d{1,5}',
 
  // it needs to match the value for field type. Eg.: 'fix'

README.md

@@ -152,6 +152,7 @@ Here are the options you can set in your `.cz-config.js`:
 * **skipEmptyScopes**: {boolean, default false}: If a chosen type has no scopes declared, skip the scope question
 * **appendBranchNameToCommitMessage**: If you use `cz-customizable` with `cz-customizable-ghooks`, you can get the branch name automatically appended to the commit message. This is done by a commit hook on `cz-customizable-ghooks`. This option has been added on `cz-customizable-ghooks`, v1.3.0. Default value is `true`.
 * **ticketNumberPrefix**: {string, default 'ISSUES CLOSED:'}: Set custom prefix for footer ticker number.
+* **ticketNumberSuffix**: {string, default ''}: Set custom suffix for footer ticker number.
 * **breakingPrefix**: {string, default 'BREAKING CHANGE:'}: Set a custom prefix for the breaking change block in commit messages.
 * **footerPrefix**: {string, default 'ISSUES CLOSED:'}: Set a custom prefix for the footer block in commit messages. Set to empty string to remove prefix.
 * **breaklineChar**: {string, default '|'}: It gets replaced with \n to create the breakline in your commit message. This is supported for fields `body` and `footer` at the moment.

__tests__/cz-customizable.test.js

@@ -374,4 +374,31 @@ describe('cz-customizable', () => {
  czModule.prompter(mockCz, commit);
  expect(commit).toHaveBeenCalledWith('feat: create a new cool feature');
  });
+
+ it('should call commit() function with ticket number and prefix and suffix', () => {
+ readConfigFile.mockReturnValue({
+ types: [{ value: 'feat', name: 'feat: my feat' }],
+ scopes: [{ name: 'myScope' }],
+ scopeOverrides: {
+ fix: [{ name: 'fixOverride' }],
+ },
+ allowCustomScopes: true,
+ allowBreakingChanges: ['feat'],
+ breakingPrefix: 'WARNING:',
+ ticketNumberPrefix: '[TICKET-',
+ ticketNumberSuffix: ']',
+ });
+
+ const answers = {
+ confirmCommit: 'yes',
+ type: 'feat',
+ scope: 'myScope',
+ subject: 'create a new cool feature',
+ ticketNumber: '1234',
+ };
+
+ const mockCz = getMockedCz(answers);
+ czModule.prompter(mockCz, commit);
+ expect(commit).toHaveBeenCalledWith('feat(myScope): [TICKET-1234] create a new cool feature');
+ });
 });

index.d.ts

@@ -22,6 +22,7 @@ declare module "cz-customizable" {
  skipQuestions?: string[];
  appendBranchNameToCommitMessage?: boolean;
  ticketNumberPrefix?: string;
+ ticketNumberSuffix?:string;
  breakingPrefix?: string;
  footerPrefix?: string;
  subjectLimit?: number;

lib/build-commit.js

@@ -10,11 +10,17 @@ const addTicketNumber = (ticketNumber, config) => {
  return '';
  }
 
+ let trimmedTicketNumber = ticketNumber.trim();
+
  if (config.ticketNumberPrefix) {
- return `${config.ticketNumberPrefix + ticketNumber.trim()} `;
+ trimmedTicketNumber = `${config.ticketNumberPrefix}${trimmedTicketNumber}`;
+ }
+
+ if (config.ticketNumberSuffix) {
+ trimmedTicketNumber = `${trimmedTicketNumber}${config.ticketNumberSuffix}`;
  }
 
- return `${ticketNumber.trim()} `;
+ return `${trimmedTicketNumber} `;
 };
 
 const addScope = (scope, config) => {