feat(cz-git): add breaklineChar option to make new line for body and …

…BreakingChanges

BREAKING CHANGE :
add option `breaklineChar`

link #1

.commitlintrc.js

@@ -37,6 +37,7 @@ module.exports = {
     scopes: [{ value: "cz-git", name: "cz-git:   core control" }, { name: "guide" } , 'config'],
     allowCustomScopes: true,
     allowBreakingChanges: ['feat', 'fix'],
+    breaklineChar: "|",
     skipQuestions: ['body'],
     issuePrefixs: [
       { value: "link", name: "link:     processing to ISSUES" },

src/loader.ts

@@ -2,9 +2,7 @@
  * @description: generate commitizen config option(generateOptions) | generate commitizen questions(generateQuestions)
  * @author: @Zhengqbbb (zhengqbbb@gmail.com)
  * @license: MIT
- * TODO: fix getMaxSubjectLength add header max length
  * TODO: add custom skip option to higher custom
- * TODO: add breaklineChar option
  * TODO: add end prompt color option
  */
 
@@ -51,6 +49,7 @@ export const generateOptions = (clConfig: any): CommitizenGitOptions => {
     allowCustomScopes: pkgConfig.allowCustomScopes ?? clPromptConfig.allowCustomScopes ?? defaultConfig.allowCustomScopes,
     upperCaseSubject: pkgConfig.upperCaseSubject ?? clPromptConfig.upperCaseSubject ?? defaultConfig.upperCaseSubject,
     allowBreakingChanges: pkgConfig.allowBreakingChanges ?? clPromptConfig.allowBreakingChanges ?? defaultConfig.allowBreakingChanges,
+    breaklineChar: pkgConfig.breaklineChar ?? clPromptConfig.breaklineChar ?? defaultConfig.breaklineChar,
     skipQuestions: pkgConfig.skipQuestions ?? clPromptConfig.skipQuestions ?? defaultConfig.skipQuestions,
     issuePrefixs: pkgConfig.issuePrefixs ?? clPromptConfig.issuePrefixs ?? defaultConfig.issuePrefixs,
     confirmNoColor: pkgConfig.confirmNoColor ?? clPromptConfig.confirmNoColor ?? defaultConfig.confirmNoColor,
@@ -186,7 +185,7 @@ export const generateQuestions = (options: CommitizenGitOptions, cz: any) => {
     },
     {
       type: "autocomplete",
-      name: "footerPrefixsSelect",
+      name: "footerPrefix",
       message: options.messages?.footerPrefixsSelect,
       source: (_: Answers, input: string) => {
         let issues: Array<{ name: string; value: string }> = [
@@ -202,18 +201,18 @@ export const generateQuestions = (options: CommitizenGitOptions, cz: any) => {
     },
     {
       type: "input",
-      name: "footerPrefixsSelect",
+      name: "footerPrefixs",
       message: options.messages?.customFooterPrefixs,
       default: options.defaultIssues || undefined,
       when(answers: Answers) {
-        return answers.footerPrefixsSelect === "custom";
+        return answers.footerPrefix === "custom";
       }
     },
     {
       type: "input",
       name: "footer",
       when(answers: Answers) {
-        return (answers.footerPrefixsSelect as string | boolean) !== false;
+        return (answers.footerPrefix as string | boolean) !== false;
       },
       message: options.messages?.footer
     },

src/share.ts

@@ -53,6 +53,7 @@ export type Answers = {
    * @default: Select the ISSUES type of changeList by this change (optional):
    */
   footerPrefixsSelect?: string;
+  footerPrefix?: string;
   /**
    * @default: Input ISSUES Prefix:
    */
@@ -140,6 +141,12 @@ export interface CommitizenGitOptions {
    */
   allowBreakingChanges?: string[];
 
+  /**
+   * @description: body and BREAKINGCHANGES new line char
+   * @default: "|"
+   */
+  breaklineChar?: string;
+
   /**
    * @description: List of questions you want to skip
    * @example: ['body']
@@ -236,6 +243,7 @@ export const defaultConfig = Object.freeze({
   allowCustomScopes: true,
   allowBreakingChanges: ['feat', 'fix'],
   upperCaseSubject: false,
+  breaklineChar: "|",
   skipQuestions: [],
   issuePrefixs: [{ value: "closed", name: "closed:   ISSUES has been processed" }],
   confirmNoColor: false,

src/until.ts

@@ -211,13 +211,13 @@ const addSubject = (subject?: string, color?: boolean) => {
 const addBreaklinesIfNeeded = (value: string, breaklineChar = "|") =>
   value.split(breaklineChar).join("\n").valueOf();
 
-const addFooter = (footer: string, footerPrefixsSelect = "", color?: boolean) => {
-  if (footerPrefixsSelect === "") {
+const addFooter = (footer: string, footerPrefix = "", color?: boolean) => {
+  if (footerPrefix === "") {
     return color ? `\n\n\u001B[32m${footer}\u001B[0m` : `\n\n${footer}`;
   }
   return color
-    ? `\n\n\u001B[32m${footerPrefixsSelect} ${footer}\u001B[0m`
-    : `\n\n${footerPrefixsSelect} ${footer}`;
+    ? `\n\n\u001B[32m${footerPrefix} ${footer}\u001B[0m`
+    : `\n\n${footerPrefix} ${footer}`;
 };
 
 export const buildCommit = (answers: Answers, options: CommitizenGitOptions, color = false) => {
@@ -238,14 +238,13 @@ export const buildCommit = (answers: Answers, options: CommitizenGitOptions, col
 
   let result = head;
   if (body) {
-    // TODO: options.breaklineChar => prams
-    result += `\n\n${addBreaklinesIfNeeded(body)}`;
+    result += `\n\n${addBreaklinesIfNeeded(body, options.breaklineChar)}`;
   }
   if (breaking) {
-    result += `\n\nBREAKING CHANGE :\n${addBreaklinesIfNeeded(breaking)}`;
+    result += `\n\nBREAKING CHANGE :\n${addBreaklinesIfNeeded(breaking, options.breaklineChar)}`;
   }
   if (footer) {
-    result += addFooter(footer, answers.footerPrefixsSelect, color);
+    result += addFooter(footer, answers.footerPrefix, color);
   }
   return result;
 };