feat: scope helpers to support chore(deps)

tomasbjerre · tomasbjerre · commit ef0c63e65beb · 2024-10-16T21:29:20.000+02:00
diff --git a/README.md b/README.md
@@ -244,6 +244,26 @@ Conditional, renders a block if given `List<Commits>` contains given `type`.
 {{/ifContainsType}}
 ```
 
+### `ifContainsScope <List<Commit>>`
+
+Conditional, renders a block if given `List<Commits>` contains given `scope`.
+
+```hbs
+{{#ifContainsScope commits scope="deps"}}
+  commits contains deps
+{{/ifContainsScope}}
+```
+
+### `ifContainsTypeAndScope <List<Commit>>`
+
+Conditional, renders a block if given `List<Commits>` contains given `type` and `scope`.
+
+```hbs
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+  commits contains chore with deps
+{{/ifContainsScope}}
+```
+
 ### `ifContainsTypeOtherThan <List<Commit>>`
 
 Conditional, renders a block if given `List<Commits>` contains commits that don't match the given `type`.
diff --git a/build.gradle b/build.gradle
@@ -16,7 +16,7 @@ dependencies {
 	implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2'
 	implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.2'
 
-	testImplementation 'org.slf4j:slf4j-simple:1.8.0-beta2'
+	testImplementation 'org.slf4j:slf4j-simple:2.0.13'
 	testImplementation 'junit:junit:4.13.2'
 	testImplementation 'org.assertj:assertj-core:3.26.3'
 	testImplementation 'com.approvaltests:approvaltests:24.5.0'
diff --git a/src/main/java/se/bjurr/gitchangelog/api/helpers/Helpers.java b/src/main/java/se/bjurr/gitchangelog/api/helpers/Helpers.java
@@ -12,7 +12,9 @@
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsIssueLabelOtherThan;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsIssueType;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsIssueTypeOtherThan;
+import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsScope;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsType;
+import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsTypeAndScope;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.containsTypeOtherThan;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.getDate;
 import static se.bjurr.gitchangelog.internal.semantic.ConventionalCommitParser.getMessageParts;
@@ -87,6 +89,16 @@ public static Map<String, Helper<?>> getAll() {
         (final List<Commit> commits, final Options options) -> {
           return conditional(options, containsType(commits, options));
         });
+    helpers.put(
+        "ifContainsScope",
+        (final List<Commit> commits, final Options options) -> {
+          return conditional(options, containsScope(commits, options));
+        });
+    helpers.put(
+        "ifContainsTypeAndScope",
+        (final List<Commit> commits, final Options options) -> {
+          return conditional(options, containsTypeAndScope(commits, options));
+        });
     helpers.put(
         "ifContainsTypeOtherThan",
         (final List<Commit> commits, final Options options) -> {
diff --git a/src/main/java/se/bjurr/gitchangelog/internal/semantic/ConventionalCommitParser.java b/src/main/java/se/bjurr/gitchangelog/internal/semantic/ConventionalCommitParser.java
@@ -133,6 +133,24 @@ public static boolean containsType(final List<Commit> commits, final Options opt
     return false;
   }
 
+  public static boolean containsScope(final List<Commit> commits, final Options options) {
+    for (final Commit commit : commits) {
+      if (commitScope(commit.getMessage(), options)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  public static boolean containsTypeAndScope(final List<Commit> commits, final Options options) {
+    for (final Commit commit : commits) {
+      if (commitType(commit.getMessage(), options) && commitScope(commit.getMessage(), options)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   public static boolean containsTypeOtherThan(final List<Commit> commits, final Options options) {
     for (final Commit commit : commits) {
       if (!commitType(commit.getMessage(), options)) {
@@ -209,6 +227,11 @@ public static boolean commitType(final String commitMessage, final Options optio
     return getType(commitMessage).matches(type);
   }
 
+  public static boolean commitScope(final String commitMessage, final Options options) {
+    final String scope = options.hash("scope");
+    return commitScopes(commitMessage).contains(scope);
+  }
+
   private static String getType(final String commitMessage) {
     final Matcher matcher = CONVENTIONAL_PATTERN.matcher(commitMessage);
     if (!matcher.find()) {
diff --git a/src/main/resources/changelog-prepend.mustache b/src/main/resources/changelog-prepend.mustache
@@ -31,7 +31,18 @@
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/main/resources/changelog.mustache b/src/main/resources/changelog.mustache
@@ -36,7 +36,18 @@ Changelog of {{repoName}}.
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatFirstVersionCanBeGenerated.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatFirstVersionCanBeGenerated.approved.txt
@@ -38,7 +38,18 @@ Changelog of {{repoName}}.
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatOnlyGithubIssuesCanBeParsed.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatOnlyGithubIssuesCanBeParsed.approved.txt
@@ -38,7 +38,18 @@ Changelog of {{repoName}}.
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatOnlyJiraIssuesCanBeParsed.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatOnlyJiraIssuesCanBeParsed.approved.txt
@@ -38,7 +38,18 @@ Changelog of {{repoName}}.
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatSecondVersionCanBeGenerated.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/GitChangelogApiTest.testThatSecondVersionCanBeGenerated.approved.txt
@@ -38,7 +38,18 @@ Changelog of {{repoName}}.
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/TemplatesTest.testOnlyLastTag.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/TemplatesTest.testOnlyLastTag.approved.txt
@@ -33,7 +33,18 @@ template:
 {{/commits}}
 
 {{/ifContainsType}}
-{{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}}
+{{#ifContainsTypeAndScope commits type="chore" scope="deps"}}
+### Dependency updates
+
+{{#commits}}
+{{#ifCommitType . type="feat"}}
+{{#ifCommitScope . scope="utils"}}
+- {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}}
+{{/ifCommitScope}}
+{{/ifCommitType}}
+{{/commits}}
+{{/ifContainsTypeAndScope}}
+{{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}}
 ### Other changes
 
 {{#commits}}
diff --git a/src/test/java/se/bjurr/gitchangelog/api/helpers/HandlebarsHelperTest.testThatBuiltInHelperMethodsCanBeUsed.approved.txt b/src/test/java/se/bjurr/gitchangelog/api/helpers/HandlebarsHelperTest.testThatBuiltInHelperMethodsCanBeUsed.approved.txt
@@ -43,6 +43,19 @@ ifMatches and subString:
  {{/ifContainsBreaking}}
 
 
+## feat utils:
+ {{#ifContainsTypeAndScope commits type="feat" scope="utils"}}
+  feat and utils exist!
+  {{#commits}}
+   {{#ifCommitType . type="feat"}}
+	{{#ifCommitScope . scope="utils"}}
+	 is feat and utils: {{hash}}
+	{{/ifCommitScope}}
+   {{/ifCommitType}}
+  {{/commits}}
+ {{/ifContainsTypeAndScope}}
+
+
 ## Footers
 {{#commits}}
 {{#ifCommitHasFooters}}
@@ -241,6 +254,11 @@ ifMatches and subString:
     is breaking: 2abbccdf2039e7c 
 
 
+## feat utils:
+  feat and utils exist!
+	 is feat and utils: 5fb068c6ccad741
+
+
 ## Footers
 Has footers: 65cfb90e2922ae5 
  - "first-token-here"
diff --git a/src/test/resources/templatetest/helpers/testThatBuiltInHelperMethodsCanBeUsed.mustache b/src/test/resources/templatetest/helpers/testThatBuiltInHelperMethodsCanBeUsed.mustache
@@ -41,6 +41,19 @@ ifMatches and subString:
  {{/ifContainsBreaking}}
 
 
+## feat utils:
+ {{#ifContainsTypeAndScope commits type="feat" scope="utils"}}
+  feat and utils exist!
+  {{#commits}}
+   {{#ifCommitType . type="feat"}}
+	{{#ifCommitScope . scope="utils"}}
+	 is feat and utils: {{hash}}
+	{{/ifCommitScope}}
+   {{/ifCommitType}}
+  {{/commits}}
+ {{/ifContainsTypeAndScope}}
+
+
 ## Footers
 {{#commits}}
 {{#ifCommitHasFooters}}
