Favor 'scope' & 'sub-scope' vs 'area' & 'sub-area'

The convention of commitlint upstream documentation is to refer
to the text that goes before the ':' in the title as the
**type(scope)**, but we called it **area(sub-area)** (also
allowed to be written with a slash: **area/sub-area**).

There was no point to really use a different word for it so,
from now on, we will refer to it as scope as well. But we
still don't use type, just scope and sub-scope.

Author: knocte

WorkflowGuidelines.md

@@ -41,7 +41,7 @@ script, or this technique manually: https://stackoverflow.com/a/3230241/544947
 * Git commit messages should follow this style:
 
 ```
-Area/Sub-area: short title of what is changed (50 chars max)
+Scope/sub-scope: short title of what is changed (50 chars max)
 
 Explanation of **why** (and maybe **how** as well, in case there's a part of
 the change that is not self-explanatory). Don't hesitate to be very verbose
@@ -58,11 +58,11 @@ has a title at the top which is normally a short sentence (but not ended with a
 dot, like most titles), and a body that starts in the 3rd line and which contains
 one or many paragraphs (each ending with a dot, as it's text in prose). In
 particular, the example above would be for a commit message that fixes the
-issue #45. **Area** usually refers to the project name, but without the need
+issue #45. **Scope** usually refers to the project name, but without the need
 to include the name of the project (e.g. in geewallet, all project names start
 with the `GWallet.` prefix, then there's no need to specify it; so use `Backend`
-as area instead of `GWallet.Backend`). The **Sub-area** may refer to a folder
-or module inside the area, but it's not a strict mapping.
+as scope instead of `GWallet.Backend`). The **Sub-scope** may refer to a folder
+or module inside what's represented as the scope, but it's not a strict mapping.
 
 When referencing a bug/issue, as you can see above you can add a sentence at the
 end of the commit message which starts with `Fixes `, followed by the **full URL**

commitlint.config.ts

@@ -53,7 +53,7 @@ module.exports = {
         // * Title should not have dot at the end.
         // * Workflow: detect if wip commit in a branch not named "wip/*" or whose name contains "squashed".
         // * Detect if commit hash mention in commit msg actually exists in repo.
-        // * Detect area(sub-area) in the title that doesn't include area part (e.g., writing (bar) instead of foo(bar))
+        // * Detect scope(sub-scope) in the title that doesn't include scope part (e.g., writing (bar) instead of foo(bar))
 
         {
             rules: {

commitlint/plugins.test.ts

@@ -613,7 +613,7 @@ test("header-max-length-with-suggestions10", () => {
 
 test("header-max-length-with-suggestions11", () => {
     let commitMsgThatExceedsHeaderMaxLength =
-        "area: 20 characters more because blah blah very very very very long title";
+        "scope: 20 characters more because blah blah very very very very long title";
     let headerMaxLength11 = runCommitLintOnMsg(
         commitMsgThatExceedsHeaderMaxLength
     );
@@ -690,20 +690,20 @@ test("subject-lowercase4", () => {
 });
 
 test("subject-lowercase5", () => {
-    let commitMsgWithRareCharInArea1 = "foo.bar: Baz";
-    let subjectLowerCase5 = runCommitLintOnMsg(commitMsgWithRareCharInArea1);
+    let commitMsgWithRareCharInScope1 = "foo.bar: Baz";
+    let subjectLowerCase5 = runCommitLintOnMsg(commitMsgWithRareCharInScope1);
     expect(subjectLowerCase5.status).not.toBe(0);
 });
 
 test("subject-lowercase6", () => {
-    let commitMsgWithRareCharInArea2 = "foo-bar: Baz";
-    let subjectLowerCase6 = runCommitLintOnMsg(commitMsgWithRareCharInArea2);
+    let commitMsgWithRareCharInScope2 = "foo-bar: Baz";
+    let subjectLowerCase6 = runCommitLintOnMsg(commitMsgWithRareCharInScope2);
     expect(subjectLowerCase6.status).not.toBe(0);
 });
 
 test("subject-lowercase7", () => {
-    let commitMsgWithRareCharInArea3 = "foo,bar: Baz";
-    let subjectLowerCase7 = runCommitLintOnMsg(commitMsgWithRareCharInArea3);
+    let commitMsgWithRareCharInScope3 = "foo,bar: Baz";
+    let subjectLowerCase7 = runCommitLintOnMsg(commitMsgWithRareCharInScope3);
     expect(subjectLowerCase7.status).not.toBe(0);
 });
 
@@ -731,26 +731,26 @@ test("subject-lowercase10", () => {
 });
 
 test("title-uppercase1", () => {
-    let commitMsgWithoutArea = "remove logs";
-    let titleUpperCase1 = runCommitLintOnMsg(commitMsgWithoutArea);
+    let commitMsgWithoutScope = "remove logs";
+    let titleUpperCase1 = runCommitLintOnMsg(commitMsgWithoutScope);
     expect(titleUpperCase1.status).not.toBe(0);
 });
 
 test("title-uppercase2", () => {
-    let commitMsgWithoutArea = "Remove logs";
-    let titleUpperCase2 = runCommitLintOnMsg(commitMsgWithoutArea);
+    let commitMsgWithoutScope = "Remove logs";
+    let titleUpperCase2 = runCommitLintOnMsg(commitMsgWithoutScope);
     expect(titleUpperCase2.status).toBe(0);
 });
 
 test("title-uppercase3", () => {
-    let commitMsgWithoutArea = "testFixtureSetup refactor";
-    let titleUpperCase3 = runCommitLintOnMsg(commitMsgWithoutArea);
+    let commitMsgWithoutScope = "testFixtureSetup refactor";
+    let titleUpperCase3 = runCommitLintOnMsg(commitMsgWithoutScope);
     expect(titleUpperCase3.status).toBe(0);
 });
 
 test("title-uppercase4", () => {
-    let commitMsgWithLowerCaseArea = "lowercase: area is lowercase";
-    let titleUpperCase4 = runCommitLintOnMsg(commitMsgWithLowerCaseArea);
+    let commitMsgWithLowerCaseScope = "lowercase: scope is lowercase";
+    let titleUpperCase4 = runCommitLintOnMsg(commitMsgWithLowerCaseScope);
     expect(titleUpperCase4.status).toBe(0);
 });
 

commitlint/plugins.ts

@@ -128,16 +128,16 @@ export abstract class Plugins {
 
             let colonIndex = headerStr.indexOf(":");
 
-            let titleWithoutArea = headerStr;
+            let titleWithoutScope = headerStr;
             if (colonIndex > 0) {
-                titleWithoutArea = headerStr.substring(colonIndex);
+                titleWithoutScope = headerStr.substring(colonIndex);
             }
 
             let numRecomendations = 0;
-            let lowerCaseTitleWithoutArea = titleWithoutArea.toLowerCase();
+            let lowerCaseTitleWithoutScope = titleWithoutScope.toLowerCase();
             Object.entries(abbr).forEach(([key, value]) => {
                 let pattern = new RegExp("\\b(" + key.toString() + ")\\b");
-                if (pattern.test(lowerCaseTitleWithoutArea)) {
+                if (pattern.test(lowerCaseTitleWithoutScope)) {
                     if (numRecomendations === 0) {
                         message =
                             message +
@@ -239,15 +239,15 @@ export abstract class Plugins {
 
         let colonIndex = headerStr.indexOf(":");
         if (colonIndex >= 0) {
-            let areaOrScope = headerStr.substring(0, colonIndex);
-            if (areaOrScope.includes("\\")) {
+            let scope = headerStr.substring(0, colonIndex);
+            if (scope.includes("\\")) {
                 offence = true;
             }
         }
 
         return [
             !offence,
-            `Please use slash instead of backslash in the area/scope/sub-area section of the title.` +
+            `Please use slash instead of backslash in the scope/sub-scope section of the title.` +
                 Helpers.errMessageSuffix,
         ];
     }
@@ -280,7 +280,7 @@ export abstract class Plugins {
             !Helpers.isProperNoun(firstWord);
         return [
             !offence,
-            `Please start the title with an uppercase letter if you haven't specified any area/scope.` +
+            `Please start the title with an uppercase letter if you haven't specified any scope.` +
                 Helpers.errMessageSuffix,
         ];
     }
@@ -318,7 +318,7 @@ export abstract class Plugins {
 
         return [
             !offence,
-            `Please use "area/scope: subject" or "area(scope): subject" style instead of wrapping area/scope under square brackets in your commit message title` +
+            `Please use "scope/sub-scope: subject" or "scope(scope): subject" style instead of wrapping the scope details under square brackets in your commit message title` +
                 Helpers.errMessageSuffix,
         ];
     }
@@ -339,7 +339,7 @@ export abstract class Plugins {
 
         return [
             !offence,
-            `Please use lowercase as the first letter for your subject, i.e. the text after your area/scope (note: there is a chance that this rule is yielding a false positive in case the word '${firstWord}' is a name and must be capitalized; in which case please just reword the subject to make this word not be the first, sorry).` +
+            `Please use lowercase as the first letter for your subject, i.e. the text after your scope (note: there is a chance that this rule is yielding a false positive in case the word '${firstWord}' is a name and must be capitalized; in which case please just reword the subject to make this word not be the first, sorry).` +
                 Helpers.errMessageSuffix,
         ];
     }
@@ -350,20 +350,20 @@ export abstract class Plugins {
         let colonIndex = headerStr.indexOf(":");
 
         if (colonIndex >= 0) {
-            let areaOrScope = headerStr.substring(0, colonIndex);
-            let commaIndex = areaOrScope.indexOf(",");
+            let scope = headerStr.substring(0, colonIndex);
+            let commaIndex = scope.indexOf(",");
             while (commaIndex >= 0) {
-                if (areaOrScope[commaIndex + 1] === " ") {
+                if (scope[commaIndex + 1] === " ") {
                     offence = true;
                 }
-                areaOrScope = areaOrScope.substring(commaIndex + 1);
-                commaIndex = areaOrScope.indexOf(",");
+                scope = scope.substring(commaIndex + 1);
+                commaIndex = scope.indexOf(",");
             }
         }
 
         return [
             !offence,
-            `No need to use space after comma in the area/scope (so that commit title can be shorter).` +
+            `No need to use space after comma in the scope (so that commit title can be shorter).` +
                 Helpers.errMessageSuffix,
         ];
     }
@@ -462,8 +462,8 @@ export abstract class Plugins {
 
         let colonIndex = headerStr.indexOf(":");
         if (colonIndex >= 0) {
-            let areaOrScope = headerStr.substring(0, colonIndex);
-            let parenIndex = areaOrScope.indexOf("(");
+            let scope = headerStr.substring(0, colonIndex);
+            let parenIndex = scope.indexOf("(");
             if (parenIndex >= 1) {
                 if (headerStr[parenIndex - 1] === " ") {
                     offence = true;
@@ -473,7 +473,7 @@ export abstract class Plugins {
 
         return [
             !offence,
-            `No need to use space before parentheses in the area/scope/sub-area section of the title.` +
+            `No need to use space before parentheses in the scope/sub-scope section of the title.` +
                 Helpers.errMessageSuffix,
         ];
     }