├── .gitignore
├── .idea
    ├── encodings.xml
    ├── modules.xml
    └── vcs.xml
├── CommitMessageChecker.iml
├── README.md
├── resources
    └── META-INF
    │   ├── plugin.xml
    │   └── pluginIcon.svg
└── src
    └── org
        └── turbanov
            └── commits
                ├── CommitMessageCheckinHandlerFactory.java
                └── IssueReferenceChecker.java


/.gitignore:
--------------------------------------------------------------------------------
1 | *.jar
2 | .idea/workspace.xml
3 | out/
4 | 


--------------------------------------------------------------------------------
/.idea/encodings.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="Encoding">
4 |     <file url="PROJECT" charset="UTF-8" />
5 |   </component>
6 | </project>


--------------------------------------------------------------------------------
/.idea/modules.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="ProjectModuleManager">
4 |     <modules>
5 |       <module fileurl="file://$PROJECT_DIR$/CommitMessageChecker.iml" filepath="$PROJECT_DIR$/CommitMessageChecker.iml" />
6 |     </modules>
7 |   </component>
8 | </project>


--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="VcsDirectoryMappings">
4 |     <mapping directory="$PROJECT_DIR$" vcs="Git" />
5 |   </component>
6 | </project>


--------------------------------------------------------------------------------
/CommitMessageChecker.iml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <module type="PLUGIN_MODULE" version="4">
 3 |   <component name="DevKit.ModuleBuildProperties" url="file://$MODULE_DIR$/resources/META-INF/plugin.xml" />
 4 |   <component name="NewModuleRootManager" inherit-compiler-output="true">
 5 |     <exclude-output />
 6 |     <content url="file://$MODULE_DIR$">
 7 |       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
 8 |       <sourceFolder url="file://$MODULE_DIR$/resources" type="java-resource" />
 9 |     </content>
10 |     <orderEntry type="inheritedJdk" />
11 |     <orderEntry type="sourceFolder" forTests="false" />
12 |   </component>
13 | </module>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Commit message checker
 2 | 
 3 | Plugins for Jetbrains IDEs.
 4 | Checks that commit message contains reference to the same issue as branch name.
 5 | 
 6 | ![warning_example](https://user-images.githubusercontent.com/741251/72476919-7e195900-37ff-11ea-8973-3618760c56d5.png)
 7 | 
 8 | ## Setup
 9 | Make sure you have configured VCS issue regexp
10 | `File | Settings | Version Control | Issue Navigation`
11 | 
12 | [See](https://www.jetbrains.com/help/idea/settings-version-control-issue-navigation.html)  for details
13 | 
14 | ![vcs_issue_navigation](https://user-images.githubusercontent.com/741251/189093654-7b5e724f-0638-48b3-9be6-67d9f2e63144.png)
15 | 


--------------------------------------------------------------------------------
/resources/META-INF/plugin.xml:
--------------------------------------------------------------------------------
 1 | <idea-plugin>
 2 |   <id>org.turbanov.commits.message.checker</id>
 3 |   <name>Commit Message Checker</name>
 4 |   <version>1.2</version>
 5 |   <vendor email="turbanoff@gmail.com" url="https://github.com/turbanoff/CommitMessageChecker">Turbanov Andrey</vendor>
 6 | 
 7 |   <description><![CDATA[
 8 | Checks that commit message contains reference to the same issue as branch.
 9 | Useful with one-branch-per-issue policy.
10 |     ]]></description>
11 | 
12 |   <change-notes><![CDATA[
13 |         <html>
14 |         <h3>1.2</h3>
15 |         <ul>
16 |             <li>Fix CSS styles in warning message</li>
17 |         </ul>
18 |         <h3>1.1</h3>
19 |         <ul>
20 |             <li>Show branch name in warning message</li>
21 |         </ul>
22 |         </html>
23 |         ]]>
24 |   </change-notes>
25 | 
26 |   <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html for description -->
27 |   <idea-version since-build="143.0"/>
28 | 
29 |   <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
30 |        on how to target different products -->
31 |   <depends>com.intellij.modules.platform</depends>
32 |   <depends>com.intellij.modules.vcs</depends>
33 | 
34 |   <extensions defaultExtensionNs="com.intellij">
35 |     <checkinHandlerFactory implementation="org.turbanov.commits.CommitMessageCheckinHandlerFactory"/>
36 |   </extensions>
37 | 
38 | </idea-plugin>


--------------------------------------------------------------------------------
/resources/META-INF/pluginIcon.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40" width="40px" height="40px"><path fill="#bae0bd" d="M1.707 22.199L4.486 19.42 13.362 28.297 35.514 6.145 38.293 8.924 13.362 33.855z"/><path fill="#5e9c76" d="M35.514,6.852l2.072,2.072L13.363,33.148L2.414,22.199l2.072-2.072l8.169,8.169l0.707,0.707 l0.707-0.707L35.514,6.852 M35.514,5.438L13.363,27.59l-8.876-8.876L1,22.199l12.363,12.363L39,8.924L35.514,5.438L35.514,5.438z"/></svg>


--------------------------------------------------------------------------------
/src/org/turbanov/commits/CommitMessageCheckinHandlerFactory.java:
--------------------------------------------------------------------------------
 1 | package org.turbanov.commits;
 2 | 
 3 | import com.intellij.openapi.vcs.CheckinProjectPanel;
 4 | import com.intellij.openapi.vcs.changes.CommitContext;
 5 | import com.intellij.openapi.vcs.checkin.CheckinHandler;
 6 | import com.intellij.openapi.vcs.checkin.CheckinHandlerFactory;
 7 | import org.jetbrains.annotations.NotNull;
 8 | 
 9 | /**
10 |  * @author Andrey Turbanov
11 |  * @since 11.02.2017
12 |  */
13 | public class CommitMessageCheckinHandlerFactory extends CheckinHandlerFactory {
14 |     @NotNull
15 |     @Override
16 |     public CheckinHandler createHandler(@NotNull CheckinProjectPanel panel, @NotNull CommitContext commitContext) {
17 |         return new IssueReferenceChecker(panel);
18 |     }
19 | }
20 | 


--------------------------------------------------------------------------------
/src/org/turbanov/commits/IssueReferenceChecker.java:
--------------------------------------------------------------------------------
  1 | package org.turbanov.commits;
  2 | 
  3 | import javax.swing.JCheckBox;
  4 | import javax.swing.JComponent;
  5 | import javax.swing.JPanel;
  6 | import java.awt.BorderLayout;
  7 | import java.util.Objects;
  8 | import java.util.Optional;
  9 | import java.util.regex.Matcher;
 10 | import java.util.regex.Pattern;
 11 | import java.util.stream.Stream;
 12 | 
 13 | import com.intellij.dvcs.repo.Repository;
 14 | import com.intellij.dvcs.repo.VcsRepositoryManager;
 15 | import com.intellij.ide.util.PropertiesComponent;
 16 | import com.intellij.openapi.project.Project;
 17 | import com.intellij.openapi.ui.Messages;
 18 | import com.intellij.openapi.util.Trinity;
 19 | import com.intellij.openapi.vcs.CheckinProjectPanel;
 20 | import com.intellij.openapi.vcs.IssueNavigationConfiguration;
 21 | import com.intellij.openapi.vcs.checkin.CheckinHandler;
 22 | import com.intellij.openapi.vcs.ui.RefreshableOnComponent;
 23 | import com.intellij.util.ui.UIUtil;
 24 | import com.intellij.xml.util.XmlStringUtil;
 25 | import static com.intellij.openapi.vcs.changes.issueLinks.IssueLinkHtmlRenderer.formatTextWithLinks;
 26 | 
 27 | /**
 28 |  * @author Andrey Turbanov
 29 |  * @since 12.02.2017
 30 |  */
 31 | class IssueReferenceChecker extends CheckinHandler {
 32 |     private static final String CHECKER_STATE_KEY = "COMMIT_MESSAGE_ISSUE_CHECKER_STATE_KEY";
 33 |     private final CheckinProjectPanel panel;
 34 | 
 35 |     public IssueReferenceChecker(CheckinProjectPanel panel) {
 36 |         this.panel = panel;
 37 |     }
 38 | 
 39 |     @Override
 40 |     public RefreshableOnComponent getBeforeCheckinConfigurationPanel() {
 41 |         final JCheckBox checkBox = new JCheckBox("Check reference to issue in message");
 42 | 
 43 |         return new RefreshableOnComponent() {
 44 |             @Override
 45 |             public JComponent getComponent() {
 46 |                 JPanel root = new JPanel(new BorderLayout());
 47 |                 root.add(checkBox, "West");
 48 |                 return root;
 49 |             }
 50 | 
 51 |             @Override
 52 |             public void refresh() {
 53 |             }
 54 | 
 55 |             @Override
 56 |             public void saveState() {
 57 |                 PropertiesComponent.getInstance().setValue(CHECKER_STATE_KEY, checkBox.isSelected());
 58 |             }
 59 | 
 60 |             @Override
 61 |             public void restoreState() {
 62 |                 checkBox.setSelected(isCheckMessageEnabled());
 63 |             }
 64 |         };
 65 |     }
 66 | 
 67 |     public static boolean isCheckMessageEnabled() {
 68 |         return PropertiesComponent.getInstance().getBoolean(CHECKER_STATE_KEY, true);
 69 |     }
 70 | 
 71 |     @Override
 72 |     public ReturnResult beforeCheckin() {
 73 |         if (!isCheckMessageEnabled()) return super.beforeCheckin();
 74 | 
 75 |         Project project = panel.getProject();
 76 |         IssueNavigationConfiguration configuration = IssueNavigationConfiguration.getInstance(project);
 77 |         VcsRepositoryManager repoManager = VcsRepositoryManager.getInstance(project);
 78 |         Optional<Boolean> shouldCommit = repoManager.getRepositories().stream()
 79 |                 .map(Repository::getCurrentBranchName)
 80 |                 .filter(Objects::nonNull)
 81 |                 .flatMap(branchName -> match(configuration, branchName))
 82 |                 .filter(trinity -> trinity.first.find())
 83 |                 .map(trinity -> Trinity.create(trinity.first.group(), trinity.second, trinity.third))
 84 |                 .findFirst()
 85 |                 .map(branchMatch -> findReferenceInMessage(branchMatch, project));
 86 |         return shouldCommit.orElse(true) ? ReturnResult.COMMIT : ReturnResult.CANCEL;
 87 |     }
 88 | 
 89 |     private Stream<Trinity<Matcher, Pattern, String>> match(IssueNavigationConfiguration configuration, String branch) {
 90 |         return configuration.getLinks().stream()
 91 |                 .map(link -> {
 92 |                     Pattern pattern = link.getIssuePattern();
 93 |                     Matcher matcher = pattern.matcher(branch);
 94 |                     return Trinity.create(matcher, pattern, branch);
 95 |                 });
 96 |     }
 97 | 
 98 |     private boolean findReferenceInMessage(Trinity<String, Pattern, String> branchMatch, Project project) {
 99 |         String commitMessage = panel.getCommitMessage();
100 |         Pattern pattern = branchMatch.second;
101 |         Matcher matcher = pattern.matcher(commitMessage);
102 |         String issueReferenceFromBranchName = branchMatch.first;
103 |         while (matcher.find()) {
104 |             if (matcher.group().equals(issueReferenceFromBranchName)) return true;
105 |         }
106 | 
107 |         String branchName = branchMatch.third;
108 |         String html = "<html><body>" +
109 |                 "Commit message doesn't contain reference to the issue " + formatTextWithLinks(project, issueReferenceFromBranchName) + "<br>" +
110 |                 "Current branch name: <code>" + XmlStringUtil.escapeString(branchName) + "</code><br>" +
111 |                 "<br>" +
112 |                 "Are you sure to commit as is?" +
113 |                 "</body></html>";
114 |         int yesNo = Messages.showYesNoDialog(html,
115 |                 "Missing Issue Reference",
116 |                 UIUtil.getWarningIcon());
117 |         return yesNo == Messages.YES;
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------