feat: commit conventions

lib/add-contributor.js

@@ -2,6 +2,7 @@ module.exports = addContributor;
 
 const getUserDetails = require("./get-user-details");
 const ContentFiles = require("./modules/content-files");
+const convertMessage = require("commit-conv");
 
 async function addContributor({
   context,
@@ -52,17 +53,25 @@ async function addContributor({
     originalSha: config.getOriginalSha(),
   };
 
+  const convention = config.get().commitConvention;
+  const prTitle = convertMessage({
+    tag: "docs",
+    msg: `add ${who} as a contributor`,
+    convention
+  });
+
   // create or update pull request
   const {
     pullRequestURL,
     pullCreated,
   } = await repository.createPullRequestFromFiles({
-    title: `docs: add ${who} as a contributor for ${contributions.join(", ")}`,
-    body: `Add @${who} as a contributor for ${contributions.join(
+    title: prTitle,
+    body: `Adds @${who} as a contributor for ${contributions.join(
       ", "
     )}.\n\nThis was requested by ${commentReply.replyingToWho()} [in this comment](${commentReply.replyingToWhere()})`,
     filesByPath: filesByPathToUpdate,
     branchName,
+    convention,
   });
 
   // let user know in comment

lib/modules/config.js

@@ -60,6 +60,7 @@ class Config {
       files: ["README.md"],
       imageSize: 100,
       commit: false,
+      commitConvention: "angular",
       contributors: [],
       contributorsPerLine: 7,
     };
@@ -75,6 +76,9 @@ class Config {
     if (!Number.isInteger(options.contributorsPerLine)) {
       options.contributorsPerLine = 7;
     }
+    if (!("commitConvention" in options)) {
+      options.commitConvention = "angular";
+    }
     return options;
   }
 

lib/modules/repository.js

@@ -3,6 +3,7 @@ const {
   BranchNotFoundError,
   ResourceNotFoundError,
 } = require("./errors");
+const convertMessage = require("commit-conv");
 
 class Repository {
   /**
@@ -117,48 +118,64 @@ class Repository {
     });
   }
 
-  async updateFile({ filePath, content, branchName, originalSha }) {
+  async updateFile({ filePath, content, branchName, originalSha, convention }) {
     const contentBinary = Buffer.from(content).toString("base64");
+
     //octokit.github.io/rest.js/#api-Repos-updateFile
     await this.octokit.repos.createOrUpdateFileContents({
       owner: this.owner,
       repo: this.repo,
       path: filePath,
-      message: `docs: update ${filePath} ${this.skipCiString}`.trim(),
+      message: convertMessage({
+        tag: "docs",
+        msg: `update ${filePath} ${this.skipCiString}`,
+        convention,
+      }).trim(),
       content: contentBinary,
       sha: originalSha,
       branch: branchName,
     });
   }
 
-  async createFile({ filePath, content, branchName }) {
+  async createFile({ filePath, content, branchName, convention }) {
     const contentBinary = Buffer.from(content).toString("base64");
 
     //octokit.github.io/rest.js/#api-Repos-createFile
     await this.octokit.repos.createOrUpdateFileContents({
       owner: this.owner,
       repo: this.repo,
       path: filePath,
-      message: `docs: create ${filePath} ${this.skipCiString}`.trim(),
+      message: convertMessage({
+        tag: "docs",
+        msg: `create ${filePath} ${this.skipCiString}`,
+        convention,
+      }).trim(),
       content: contentBinary,
       branch: branchName,
     });
   }
 
-  async createOrUpdateFile({ filePath, content, branchName, originalSha }) {
+  async createOrUpdateFile({
+    filePath,
+    content,
+    branchName,
+    originalSha,
+    convention,
+  }) {
     if (originalSha === undefined) {
-      await this.createFile({ filePath, content, branchName });
+      await this.createFile({ filePath, content, branchName, convention });
     } else {
       await this.updateFile({
         filePath,
         content,
         branchName,
         originalSha,
+        convention,
       });
     }
   }
 
-  async createOrUpdateFiles({ filesByPath, branchName }) {
+  async createOrUpdateFiles({ filesByPath, branchName, convention }) {
     const repository = this;
     const createOrUpdateFilesMultiple = Object.entries(filesByPath).map(
       ([filePath, { content, originalSha }]) => {
@@ -167,6 +184,7 @@ class Repository {
           content,
           branchName,
           originalSha,
+          convention,
         });
       }
     );
@@ -217,7 +235,13 @@ class Repository {
     }
   }
 
-  async createPullRequestFromFiles({ title, body, filesByPath, branchName }) {
+  async createPullRequestFromFiles({
+    title,
+    body,
+    filesByPath,
+    branchName,
+    convention,
+  }) {
     const branchNameExists = branchName === this.baseBranch;
     if (!branchNameExists) {
       await this.createBranch(branchName);
@@ -226,6 +250,7 @@ class Repository {
     await this.createOrUpdateFiles({
       filesByPath,
       branchName,
+      convention,
     });
 
     return this.createPullRequest({

package.json

@@ -19,6 +19,7 @@
   },
   "dependencies": {
     "all-contributors-cli": "^6.20.4",
+    "commit-conv": "^1.0.3",
     "compromise": "^11.14.3",
     "probot": "^12.1.1"
   },