Init
This commit is contained in:
commit
a0b277c4dd
17 changed files with 1005 additions and 0 deletions
42
.gitignore
vendored
Normal file
42
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
.gradle
|
||||
build/
|
||||
!gradle/wrapper/gradle-wrapper.jar
|
||||
!**/src/main/**/build/
|
||||
!**/src/test/**/build/
|
||||
|
||||
### IntelliJ IDEA ###
|
||||
.idea/modules.xml
|
||||
.idea/jarRepositories.xml
|
||||
.idea/compiler.xml
|
||||
.idea/libraries/
|
||||
*.iws
|
||||
*.iml
|
||||
*.ipr
|
||||
out/
|
||||
!**/src/main/**/out/
|
||||
!**/src/test/**/out/
|
||||
|
||||
### Eclipse ###
|
||||
.apt_generated
|
||||
.classpath
|
||||
.factorypath
|
||||
.project
|
||||
.settings
|
||||
.springBeans
|
||||
.sts4-cache
|
||||
bin/
|
||||
!**/src/main/**/bin/
|
||||
!**/src/test/**/bin/
|
||||
|
||||
### NetBeans ###
|
||||
/nbproject/private/
|
||||
/nbbuild/
|
||||
/dist/
|
||||
/nbdist/
|
||||
/.nb-gradle/
|
||||
|
||||
### VS Code ###
|
||||
.vscode/
|
||||
|
||||
### Mac OS ###
|
||||
.DS_Store
|
||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
4
.idea/vcs.xml
generated
Normal file
4
.idea/vcs.xml
generated
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings" defaultProject="true" />
|
||||
</project>
|
||||
61
README.md
Normal file
61
README.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# Hello World JetBrains Plugin Template
|
||||
|
||||
This is a simple Hello World template for a JetBrains plugin that will work with any of their IDEs. It demonstrates the basic structure and components needed for a JetBrains plugin.
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `build.gradle`: Gradle build configuration for the plugin
|
||||
- `settings.gradle`: Gradle settings for the project
|
||||
- `src/main/java/org/example/HelloWorldAction.java`: The action class that displays a "Hello World" message
|
||||
- `src/main/resources/META-INF/plugin.xml`: Plugin configuration file
|
||||
|
||||
## Features
|
||||
|
||||
- Adds a "Hello World" action to the Tools menu
|
||||
- Provides a keyboard shortcut (Ctrl+Alt+H) to trigger the action
|
||||
- Displays a simple message dialog when the action is triggered
|
||||
|
||||
## Building the Plugin
|
||||
|
||||
To build the plugin, run:
|
||||
|
||||
```bash
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
This will create a plugin ZIP file in the `build/distributions` directory.
|
||||
|
||||
## Installing the Plugin
|
||||
|
||||
1. Open any JetBrains IDE (IntelliJ IDEA, PyCharm, WebStorm, etc.)
|
||||
2. Go to Settings/Preferences > Plugins
|
||||
3. Click on the gear icon and select "Install Plugin from Disk..."
|
||||
4. Navigate to the `build/distributions` directory and select the ZIP file
|
||||
5. Restart the IDE when prompted
|
||||
|
||||
## Using the Plugin
|
||||
|
||||
After installing the plugin:
|
||||
|
||||
1. Go to the Tools menu and click on "Hello World", or
|
||||
2. Use the keyboard shortcut Ctrl+Alt+H
|
||||
|
||||
A message dialog will appear with the text "Hello, World!".
|
||||
|
||||
## Customizing the Plugin
|
||||
|
||||
To customize the plugin:
|
||||
|
||||
1. Update the plugin metadata in `plugin.xml`
|
||||
2. Modify the `HelloWorldAction` class to change the behavior
|
||||
3. Add more actions or extensions as needed
|
||||
|
||||
## Requirements
|
||||
|
||||
- Java 11 or later
|
||||
- Gradle 7.0 or later
|
||||
- Any JetBrains IDE for testing
|
||||
|
||||
## License
|
||||
|
||||
This template is available under the MIT License.
|
||||
51
build.gradle
Normal file
51
build.gradle
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
plugins {
|
||||
id 'java'
|
||||
id 'org.jetbrains.intellij' version '1.17.1'
|
||||
}
|
||||
|
||||
group = 'org.example'
|
||||
version = '1.0-SNAPSHOT'
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
// Configure Gradle IntelliJ Plugin
|
||||
intellij {
|
||||
version = '2023.1.5'
|
||||
type = 'IC' // Target IDE Platform - IC for IntelliJ IDEA Community Edition
|
||||
}
|
||||
|
||||
dependencies {
|
||||
testImplementation platform('org.junit:junit-bom:5.10.0')
|
||||
testImplementation 'org.junit.jupiter:junit-jupiter'
|
||||
}
|
||||
|
||||
// Configure plugin metadata
|
||||
patchPluginXml {
|
||||
sinceBuild = '231'
|
||||
untilBuild = '241.*'
|
||||
pluginDescription = '''
|
||||
A plugin for JetBrains IDEs that automatically prefixes commit messages with information extracted from branch names.
|
||||
|
||||
Features:
|
||||
<ul>
|
||||
<li>Extract information from branch names using configurable regex patterns</li>
|
||||
<li>Format commit messages using configurable format patterns</li>
|
||||
<li>Enable/disable the plugin from the commit dialog</li>
|
||||
<li>Configure the plugin from the IDE settings</li>
|
||||
</ul>
|
||||
|
||||
Example:
|
||||
<ul>
|
||||
<li>Branch name: feature/12345-add-new-feature</li>
|
||||
<li>Commit message: "Initial implementation"</li>
|
||||
<li>Result: "#12345 - Initial implementation"</li>
|
||||
</ul>
|
||||
'''
|
||||
changeNotes = 'Initial release of the Commit Message Prefixer plugin'
|
||||
}
|
||||
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
6
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
6
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
#Sat Mar 22 10:46:22 AEDT 2025
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
234
gradlew
vendored
Executable file
234
gradlew
vendored
Executable file
|
|
@ -0,0 +1,234 @@
|
|||
#!/bin/sh
|
||||
|
||||
#
|
||||
# Copyright © 2015-2021 the original authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
##############################################################################
|
||||
#
|
||||
# Gradle start up script for POSIX generated by Gradle.
|
||||
#
|
||||
# Important for running:
|
||||
#
|
||||
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||
# noncompliant, but you have some other compliant shell such as ksh or
|
||||
# bash, then to run this script, type that shell name before the whole
|
||||
# command line, like:
|
||||
#
|
||||
# ksh Gradle
|
||||
#
|
||||
# Busybox and similar reduced shells will NOT work, because this script
|
||||
# requires all of these POSIX shell features:
|
||||
# * functions;
|
||||
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||
# * compound commands having a testable exit status, especially «case»;
|
||||
# * various built-in commands including «command», «set», and «ulimit».
|
||||
#
|
||||
# Important for patching:
|
||||
#
|
||||
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||
#
|
||||
# The "traditional" practice of packing multiple parameters into a
|
||||
# space-separated string is a well documented source of bugs and security
|
||||
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||
# options in "$@", and eventually passing that to Java.
|
||||
#
|
||||
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||
# see the in-line comments for details.
|
||||
#
|
||||
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||
# Darwin, MinGW, and NonStop.
|
||||
#
|
||||
# (3) This script is generated from the Groovy template
|
||||
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||
# within the Gradle project.
|
||||
#
|
||||
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||
#
|
||||
##############################################################################
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
|
||||
# Resolve links: $0 may be a link
|
||||
app_path=$0
|
||||
|
||||
# Need this for daisy-chained symlinks.
|
||||
while
|
||||
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||
[ -h "$app_path" ]
|
||||
do
|
||||
ls=$( ls -ld "$app_path" )
|
||||
link=${ls#*' -> '}
|
||||
case $link in #(
|
||||
/*) app_path=$link ;; #(
|
||||
*) app_path=$APP_HOME$link ;;
|
||||
esac
|
||||
done
|
||||
|
||||
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=${0##*/}
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
|
||||
warn () {
|
||||
echo "$*"
|
||||
} >&2
|
||||
|
||||
die () {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
} >&2
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
nonstop=false
|
||||
case "$( uname )" in #(
|
||||
CYGWIN* ) cygwin=true ;; #(
|
||||
Darwin* ) darwin=true ;; #(
|
||||
MSYS* | MINGW* ) msys=true ;; #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
if [ -n "$JAVA_HOME" ] ; then
|
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||
# IBM's JDK on AIX uses strange locations for the executables
|
||||
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||
else
|
||||
JAVACMD=$JAVA_HOME/bin/java
|
||||
fi
|
||||
if [ ! -x "$JAVACMD" ] ; then
|
||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
else
|
||||
JAVACMD=java
|
||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
|
||||
# Increase the maximum file descriptors if we can.
|
||||
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||
case $MAX_FD in #(
|
||||
max*)
|
||||
MAX_FD=$( ulimit -H -n ) ||
|
||||
warn "Could not query maximum file descriptor limit"
|
||||
esac
|
||||
case $MAX_FD in #(
|
||||
'' | soft) :;; #(
|
||||
*)
|
||||
ulimit -n "$MAX_FD" ||
|
||||
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||
esac
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command, stacking in reverse order:
|
||||
# * args from the command line
|
||||
# * the main class name
|
||||
# * -classpath
|
||||
# * -D...appname settings
|
||||
# * --module-path (only if needed)
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if "$cygwin" || "$msys" ; then
|
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||
for arg do
|
||||
if
|
||||
case $arg in #(
|
||||
-*) false ;; # don't mess with options #(
|
||||
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||
[ -e "$t" ] ;; #(
|
||||
*) false ;;
|
||||
esac
|
||||
then
|
||||
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||
fi
|
||||
# Roll the args list around exactly as many times as the number of
|
||||
# args, so each arg winds up back in the position where it started, but
|
||||
# possibly modified.
|
||||
#
|
||||
# NB: a `for` loop captures its iteration list before it begins, so
|
||||
# changing the positional parameters here affects neither the number of
|
||||
# iterations, nor the values presented in `arg`.
|
||||
shift # remove old arg
|
||||
set -- "$@" "$arg" # push replacement arg
|
||||
done
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command;
|
||||
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
|
||||
# shell script including quotes and variable substitutions, so put them in
|
||||
# double quotes to make sure that they get re-expanded; and
|
||||
# * put everything else in single quotes, so that it's not re-expanded.
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
"$@"
|
||||
|
||||
# Use "xargs" to parse quoted args.
|
||||
#
|
||||
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||
#
|
||||
# In Bash we could simply go:
|
||||
#
|
||||
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||
# set -- "${ARGS[@]}" "$@"
|
||||
#
|
||||
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||
# character that might be a shell metacharacter, then use eval to reverse
|
||||
# that process (while maintaining the separation between arguments), and wrap
|
||||
# the whole thing up as a single "set" statement.
|
||||
#
|
||||
# This will of course break if any of these variables contains a newline or
|
||||
# an unmatched quote.
|
||||
#
|
||||
|
||||
eval "set -- $(
|
||||
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||
xargs -n1 |
|
||||
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||
tr '\n' ' '
|
||||
)" '"$@"'
|
||||
|
||||
exec "$JAVACMD" "$@"
|
||||
89
gradlew.bat
vendored
Normal file
89
gradlew.bat
vendored
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
@rem
|
||||
@rem Copyright 2015 the original author or authors.
|
||||
@rem
|
||||
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||
@rem you may not use this file except in compliance with the License.
|
||||
@rem You may obtain a copy of the License at
|
||||
@rem
|
||||
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||
@rem
|
||||
@rem Unless required by applicable law or agreed to in writing, software
|
||||
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@rem See the License for the specific language governing permissions and
|
||||
@rem limitations under the License.
|
||||
@rem
|
||||
|
||||
@if "%DEBUG%" == "" @echo off
|
||||
@rem ##########################################################################
|
||||
@rem
|
||||
@rem Gradle startup script for Windows
|
||||
@rem
|
||||
@rem ##########################################################################
|
||||
|
||||
@rem Set local scope for the variables with windows NT shell
|
||||
if "%OS%"=="Windows_NT" setlocal
|
||||
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%" == "" set DIRNAME=.
|
||||
set APP_BASE_NAME=%~n0
|
||||
set APP_HOME=%DIRNAME%
|
||||
|
||||
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
set JAVA_EXE=java.exe
|
||||
%JAVA_EXE% -version >NUL 2>&1
|
||||
if "%ERRORLEVEL%" == "0" goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:findJavaFromJavaHome
|
||||
set JAVA_HOME=%JAVA_HOME:"=%
|
||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||
|
||||
if exist "%JAVA_EXE%" goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||
|
||||
:fail
|
||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||
rem the _cmd.exe /c_ return code!
|
||||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||
exit /b 1
|
||||
|
||||
:mainEnd
|
||||
if "%OS%"=="Windows_NT" endlocal
|
||||
|
||||
:omega
|
||||
1
settings.gradle
Normal file
1
settings.gradle
Normal file
|
|
@ -0,0 +1 @@
|
|||
rootProject.name = 'hello-world-plugin'
|
||||
2
settings.gradle.kts
Normal file
2
settings.gradle.kts
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
rootProject.name = "untitled"
|
||||
|
||||
|
|
@ -0,0 +1,194 @@
|
|||
package org.example;
|
||||
|
||||
import com.intellij.openapi.diagnostic.Logger;
|
||||
import com.intellij.openapi.project.Project;
|
||||
import com.intellij.openapi.ui.Messages;
|
||||
import com.intellij.openapi.vcs.CheckinProjectPanel;
|
||||
import com.intellij.openapi.vcs.changes.CommitContext;
|
||||
import com.intellij.openapi.vcs.checkin.CheckinHandler;
|
||||
import com.intellij.openapi.vcs.checkin.CheckinHandlerFactory;
|
||||
import com.intellij.openapi.vcs.ui.RefreshableOnComponent;
|
||||
import com.intellij.ui.components.JBCheckBox;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import javax.swing.*;
|
||||
import java.awt.*;
|
||||
import java.io.BufferedReader;
|
||||
import java.io.File;
|
||||
import java.io.InputStreamReader;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.regex.PatternSyntaxException;
|
||||
|
||||
/**
|
||||
* Factory for creating commit handlers that prefix commit messages with information from branch names.
|
||||
*/
|
||||
public class CommitPrefixerCheckinHandlerFactory extends CheckinHandlerFactory {
|
||||
private static final Logger LOG = Logger.getInstance(CommitPrefixerCheckinHandlerFactory.class);
|
||||
|
||||
@NotNull
|
||||
@Override
|
||||
public CheckinHandler createHandler(@NotNull CheckinProjectPanel panel, @NotNull CommitContext commitContext) {
|
||||
return new CommitPrefixerCheckinHandler(panel);
|
||||
}
|
||||
|
||||
private static class CommitPrefixerCheckinHandler extends CheckinHandler {
|
||||
private final CheckinProjectPanel panel;
|
||||
private final Project project;
|
||||
|
||||
public CommitPrefixerCheckinHandler(@NotNull CheckinProjectPanel panel) {
|
||||
this.panel = panel;
|
||||
this.project = panel.getProject();
|
||||
|
||||
// Pre-fill the commit message if the PRE_FILL mode is selected
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
if (settings.isEnabled() && settings.getPrefixingMode() == CommitPrefixerSettings.PrefixingMode.PRE_FILL) {
|
||||
try {
|
||||
// Get the current branch name
|
||||
String branchName = getCurrentBranchName();
|
||||
if (branchName != null && !branchName.isEmpty()) {
|
||||
// Get the current commit message
|
||||
String commitMessage = panel.getCommitMessage();
|
||||
|
||||
// Apply the prefix to the commit message
|
||||
String prefixedMessage = prefixCommitMessage(branchName, commitMessage, settings);
|
||||
|
||||
// Set the prefixed commit message
|
||||
panel.setCommitMessage(prefixedMessage);
|
||||
}
|
||||
} catch (Exception e) {
|
||||
LOG.error("Error pre-filling commit message", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Nullable
|
||||
@Override
|
||||
public RefreshableOnComponent getBeforeCheckinConfigurationPanel() {
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
|
||||
// Create a checkbox to enable/disable the prefixer for this commit
|
||||
JBCheckBox checkBox = new JBCheckBox("Prefix commit message with branch information");
|
||||
checkBox.setSelected(settings.isEnabled());
|
||||
checkBox.addActionListener(e -> settings.setEnabled(checkBox.isSelected()));
|
||||
|
||||
return new RefreshableOnComponent() {
|
||||
@Override
|
||||
public JComponent getComponent() {
|
||||
JPanel panel = new JPanel(new BorderLayout());
|
||||
panel.add(checkBox, BorderLayout.WEST);
|
||||
return panel;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void refresh() {
|
||||
checkBox.setSelected(settings.isEnabled());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void saveState() {
|
||||
settings.setEnabled(checkBox.isSelected());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void restoreState() {
|
||||
checkBox.setSelected(settings.isEnabled());
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
@Override
|
||||
public ReturnResult beforeCheckin() {
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
|
||||
// Skip if the plugin is disabled or if the mode is PRE_FILL
|
||||
if (!settings.isEnabled() || settings.getPrefixingMode() == CommitPrefixerSettings.PrefixingMode.PRE_FILL) {
|
||||
return ReturnResult.COMMIT;
|
||||
}
|
||||
|
||||
try {
|
||||
// Get the current branch name
|
||||
String branchName = getCurrentBranchName();
|
||||
if (branchName == null || branchName.isEmpty()) {
|
||||
LOG.warn("Could not determine current branch name");
|
||||
return ReturnResult.COMMIT;
|
||||
}
|
||||
|
||||
// Get the current commit message
|
||||
String commitMessage = panel.getCommitMessage();
|
||||
|
||||
// Apply the prefix to the commit message
|
||||
String prefixedMessage = prefixCommitMessage(branchName, commitMessage, settings);
|
||||
|
||||
// Set the prefixed commit message
|
||||
panel.setCommitMessage(prefixedMessage);
|
||||
|
||||
} catch (Exception e) {
|
||||
LOG.error("Error prefixing commit message", e);
|
||||
}
|
||||
|
||||
return ReturnResult.COMMIT;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the current branch name using Git command line.
|
||||
*/
|
||||
@Nullable
|
||||
private String getCurrentBranchName() {
|
||||
try {
|
||||
// Get the project base directory
|
||||
String basePath = project.getBasePath();
|
||||
if (basePath == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Run 'git branch --show-current' command
|
||||
ProcessBuilder processBuilder = new ProcessBuilder("git", "branch", "--show-current");
|
||||
processBuilder.directory(new File(basePath));
|
||||
Process process = processBuilder.start();
|
||||
|
||||
// Read the output
|
||||
try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
|
||||
String branch = reader.readLine();
|
||||
process.waitFor();
|
||||
return branch;
|
||||
}
|
||||
} catch (Exception e) {
|
||||
LOG.error("Error getting current branch name", e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Prefixes the commit message with information extracted from the branch name.
|
||||
*/
|
||||
private String prefixCommitMessage(String branchName, String commitMessage, CommitPrefixerSettings settings) {
|
||||
try {
|
||||
// Compile the regex pattern
|
||||
Pattern pattern = Pattern.compile(settings.getBranchExtractionPattern());
|
||||
Matcher matcher = pattern.matcher(branchName);
|
||||
|
||||
// If the pattern matches, extract the information and format the commit message
|
||||
if (matcher.matches()) {
|
||||
String format = settings.getCommitMessageFormat();
|
||||
|
||||
// Replace $1, $2, etc. with the corresponding capture groups
|
||||
for (int i = 1; i <= matcher.groupCount(); i++) {
|
||||
format = format.replace("$" + i, matcher.group(i));
|
||||
}
|
||||
|
||||
// Replace $MESSAGE with the original commit message
|
||||
format = format.replace("$MESSAGE", commitMessage);
|
||||
|
||||
return format;
|
||||
}
|
||||
} catch (PatternSyntaxException e) {
|
||||
LOG.error("Invalid regex pattern: " + settings.getBranchExtractionPattern(), e);
|
||||
}
|
||||
|
||||
// If the pattern doesn't match or there's an error, return the original commit message
|
||||
return commitMessage;
|
||||
}
|
||||
}
|
||||
}
|
||||
118
src/main/java/org/example/CommitPrefixerConfigurable.java
Normal file
118
src/main/java/org/example/CommitPrefixerConfigurable.java
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
package org.example;
|
||||
|
||||
import com.intellij.openapi.options.Configurable;
|
||||
import com.intellij.openapi.options.ConfigurationException;
|
||||
import com.intellij.openapi.project.Project;
|
||||
import com.intellij.ui.components.JBCheckBox;
|
||||
import com.intellij.ui.components.JBLabel;
|
||||
import com.intellij.ui.components.JBTextField;
|
||||
import com.intellij.util.ui.FormBuilder;
|
||||
import org.jetbrains.annotations.Nls;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
import javax.swing.*;
|
||||
import java.awt.*;
|
||||
|
||||
/**
|
||||
* Provides a settings UI for the Commit Prefixer plugin.
|
||||
*/
|
||||
public class CommitPrefixerConfigurable implements Configurable {
|
||||
private final Project project;
|
||||
private JBTextField branchExtractionPatternField;
|
||||
private JBTextField commitMessageFormatField;
|
||||
private JBCheckBox enabledCheckBox;
|
||||
private JComboBox<CommitPrefixerSettings.PrefixingMode> prefixingModeComboBox;
|
||||
|
||||
public CommitPrefixerConfigurable(Project project) {
|
||||
this.project = project;
|
||||
}
|
||||
|
||||
@Nls(capitalization = Nls.Capitalization.Title)
|
||||
@Override
|
||||
public String getDisplayName() {
|
||||
return "Commit Prefixer";
|
||||
}
|
||||
|
||||
@Nullable
|
||||
@Override
|
||||
public JComponent createComponent() {
|
||||
branchExtractionPatternField = new JBTextField();
|
||||
commitMessageFormatField = new JBTextField();
|
||||
enabledCheckBox = new JBCheckBox("Enable commit message prefixing");
|
||||
|
||||
// Create a combo box for the prefixing mode
|
||||
prefixingModeComboBox = new JComboBox<>(CommitPrefixerSettings.PrefixingMode.values());
|
||||
prefixingModeComboBox.setRenderer(new DefaultListCellRenderer() {
|
||||
@Override
|
||||
public Component getListCellRendererComponent(JList<?> list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
|
||||
super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
|
||||
if (value instanceof CommitPrefixerSettings.PrefixingMode) {
|
||||
setText(((CommitPrefixerSettings.PrefixingMode) value).getDisplayName());
|
||||
}
|
||||
return this;
|
||||
}
|
||||
});
|
||||
|
||||
// Add help text
|
||||
JBLabel branchPatternHelp = new JBLabel("<html>Pattern to extract information from branch names.<br>" +
|
||||
"Example: (bug|feature)/(\\d+)-(.+)<br>" +
|
||||
"This matches 'bug/12345-description' or 'feature/12345-description'</html>");
|
||||
branchPatternHelp.setForeground(Color.GRAY);
|
||||
|
||||
JBLabel formatHelp = new JBLabel("<html>Format for the commit message prefix.<br>" +
|
||||
"Use $1, $2, etc. to reference capture groups from the regex pattern.<br>" +
|
||||
"Use $MESSAGE to reference the original commit message.<br>" +
|
||||
"Example: #$2 - $MESSAGE</html>");
|
||||
formatHelp.setForeground(Color.GRAY);
|
||||
|
||||
JBLabel prefixingModeHelp = new JBLabel("<html>When to add the prefix to the commit message:<br>" +
|
||||
"<b>Before commit</b>: Add the prefix right before the commit is made<br>" +
|
||||
"<b>Pre-fill in commit dialog</b>: Add the prefix when the commit dialog opens</html>");
|
||||
prefixingModeHelp.setForeground(Color.GRAY);
|
||||
|
||||
// Build the form
|
||||
FormBuilder builder = FormBuilder.createFormBuilder()
|
||||
.addComponent(enabledCheckBox)
|
||||
.addLabeledComponent("Prefixing Mode:", prefixingModeComboBox)
|
||||
.addComponent(prefixingModeHelp)
|
||||
.addLabeledComponent("Branch Extraction Pattern:", branchExtractionPatternField)
|
||||
.addComponent(branchPatternHelp)
|
||||
.addLabeledComponent("Commit Message Format:", commitMessageFormatField)
|
||||
.addComponent(formatHelp);
|
||||
|
||||
return builder.getPanel();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isModified() {
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
return !branchExtractionPatternField.getText().equals(settings.getBranchExtractionPattern()) ||
|
||||
!commitMessageFormatField.getText().equals(settings.getCommitMessageFormat()) ||
|
||||
enabledCheckBox.isSelected() != settings.isEnabled() ||
|
||||
prefixingModeComboBox.getSelectedItem() != settings.getPrefixingMode();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void apply() throws ConfigurationException {
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
settings.setBranchExtractionPattern(branchExtractionPatternField.getText());
|
||||
settings.setCommitMessageFormat(commitMessageFormatField.getText());
|
||||
settings.setEnabled(enabledCheckBox.isSelected());
|
||||
settings.setPrefixingMode((CommitPrefixerSettings.PrefixingMode) prefixingModeComboBox.getSelectedItem());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void reset() {
|
||||
CommitPrefixerSettings settings = CommitPrefixerSettings.getInstance(project);
|
||||
branchExtractionPatternField.setText(settings.getBranchExtractionPattern());
|
||||
commitMessageFormatField.setText(settings.getCommitMessageFormat());
|
||||
enabledCheckBox.setSelected(settings.isEnabled());
|
||||
prefixingModeComboBox.setSelectedItem(settings.getPrefixingMode());
|
||||
}
|
||||
|
||||
@Nullable
|
||||
@Override
|
||||
public String getHelpTopic() {
|
||||
return "Commit Prefixer Settings";
|
||||
}
|
||||
}
|
||||
95
src/main/java/org/example/CommitPrefixerSettings.java
Normal file
95
src/main/java/org/example/CommitPrefixerSettings.java
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
package org.example;
|
||||
|
||||
import com.intellij.openapi.components.*;
|
||||
import com.intellij.openapi.project.Project;
|
||||
import com.intellij.util.xmlb.XmlSerializerUtil;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
/**
|
||||
* Persistent settings for the Commit Prefixer plugin.
|
||||
* Stores the regex pattern for extracting information from branch names
|
||||
* and the format pattern for the commit message prefix.
|
||||
*/
|
||||
@State(
|
||||
name = "CommitPrefixerSettings",
|
||||
storages = {@Storage("commitPrefixerSettings.xml")}
|
||||
)
|
||||
public class CommitPrefixerSettings implements PersistentStateComponent<CommitPrefixerSettings> {
|
||||
/**
|
||||
* Enum defining when the prefix should be added to the commit message.
|
||||
*/
|
||||
public enum PrefixingMode {
|
||||
BEFORE_COMMIT("Before commit"),
|
||||
PRE_FILL("Pre-fill in commit dialog");
|
||||
|
||||
private final String displayName;
|
||||
|
||||
PrefixingMode(String displayName) {
|
||||
this.displayName = displayName;
|
||||
}
|
||||
|
||||
public String getDisplayName() {
|
||||
return displayName;
|
||||
}
|
||||
}
|
||||
|
||||
// Default regex pattern: matches "bug/12345-description" or "feature/12345-description"
|
||||
private String branchExtractionPattern = "(bug|feature)/(\\d+)-(.+)";
|
||||
|
||||
// Default format pattern: uses the second capture group from the regex
|
||||
private String commitMessageFormat = "#$2 - $MESSAGE";
|
||||
|
||||
// Whether the plugin is enabled
|
||||
private boolean enabled = true;
|
||||
|
||||
// When to add the prefix to the commit message
|
||||
private PrefixingMode prefixingMode = PrefixingMode.BEFORE_COMMIT;
|
||||
|
||||
public static CommitPrefixerSettings getInstance(Project project) {
|
||||
return project.getService(CommitPrefixerSettings.class);
|
||||
}
|
||||
|
||||
@Nullable
|
||||
@Override
|
||||
public CommitPrefixerSettings getState() {
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void loadState(@NotNull CommitPrefixerSettings state) {
|
||||
XmlSerializerUtil.copyBean(state, this);
|
||||
}
|
||||
|
||||
public String getBranchExtractionPattern() {
|
||||
return branchExtractionPattern;
|
||||
}
|
||||
|
||||
public void setBranchExtractionPattern(String branchExtractionPattern) {
|
||||
this.branchExtractionPattern = branchExtractionPattern;
|
||||
}
|
||||
|
||||
public String getCommitMessageFormat() {
|
||||
return commitMessageFormat;
|
||||
}
|
||||
|
||||
public void setCommitMessageFormat(String commitMessageFormat) {
|
||||
this.commitMessageFormat = commitMessageFormat;
|
||||
}
|
||||
|
||||
public boolean isEnabled() {
|
||||
return enabled;
|
||||
}
|
||||
|
||||
public void setEnabled(boolean enabled) {
|
||||
this.enabled = enabled;
|
||||
}
|
||||
|
||||
public PrefixingMode getPrefixingMode() {
|
||||
return prefixingMode;
|
||||
}
|
||||
|
||||
public void setPrefixingMode(PrefixingMode prefixingMode) {
|
||||
this.prefixingMode = prefixingMode;
|
||||
}
|
||||
}
|
||||
28
src/main/java/org/example/HelloWorldAction.java
Normal file
28
src/main/java/org/example/HelloWorldAction.java
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
package org.example;
|
||||
|
||||
import com.intellij.openapi.actionSystem.AnAction;
|
||||
import com.intellij.openapi.actionSystem.AnActionEvent;
|
||||
import com.intellij.openapi.project.Project;
|
||||
import com.intellij.openapi.ui.Messages;
|
||||
|
||||
/**
|
||||
* A simple action that displays a "Hello World" message when triggered.
|
||||
*/
|
||||
public class HelloWorldAction extends AnAction {
|
||||
|
||||
@Override
|
||||
public void actionPerformed(AnActionEvent e) {
|
||||
Project project = e.getProject();
|
||||
Messages.showMessageDialog(
|
||||
project,
|
||||
"Hello, World!",
|
||||
"Hello World Plugin",
|
||||
Messages.getInformationIcon()
|
||||
);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "";
|
||||
}
|
||||
}
|
||||
17
src/main/java/org/example/Main.java
Normal file
17
src/main/java/org/example/Main.java
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
package org.example;
|
||||
|
||||
//TIP To <b>Run</b> code, press <shortcut actionId="Run"/> or
|
||||
// click the <icon src="AllIcons.Actions.Execute"/> icon in the gutter.
|
||||
public class Main {
|
||||
public static void main(String[] args) {
|
||||
//TIP Press <shortcut actionId="ShowIntentionActions"/> with your caret at the highlighted text
|
||||
// to see how IntelliJ IDEA suggests fixing it.
|
||||
System.out.printf("Hello and welcome!");
|
||||
|
||||
for (int i = 1; i <= 5; i++) {
|
||||
//TIP Press <shortcut actionId="Debug"/> to start debugging your code. We have set one <icon src="AllIcons.Debugger.Db_set_breakpoint"/> breakpoint
|
||||
// for you, but you can always add more by pressing <shortcut actionId="ToggleLineBreakpoint"/>.
|
||||
System.out.println("i = " + i);
|
||||
}
|
||||
}
|
||||
}
|
||||
55
src/main/resources/META-INF/plugin.xml
Normal file
55
src/main/resources/META-INF/plugin.xml
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
<idea-plugin>
|
||||
<id>org.example.commit-prefixer</id>
|
||||
<name>Commit Message Prefixer</name>
|
||||
<vendor email="support@example.com" url="http://www.example.com">Example Vendor</vendor>
|
||||
|
||||
<description><![CDATA[
|
||||
A plugin for JetBrains IDEs that automatically prefixes commit messages with information extracted from branch names.
|
||||
|
||||
Features:
|
||||
<ul>
|
||||
<li>Extract information from branch names using configurable regex patterns</li>
|
||||
<li>Format commit messages using configurable format patterns</li>
|
||||
<li>Enable/disable the plugin from the commit dialog</li>
|
||||
<li>Configure the plugin from the IDE settings</li>
|
||||
</ul>
|
||||
|
||||
Example:
|
||||
<ul>
|
||||
<li>Branch name: feature/12345-add-new-feature</li>
|
||||
<li>Commit message: "Initial implementation"</li>
|
||||
<li>Result: "#12345 - Initial implementation"</li>
|
||||
</ul>
|
||||
]]></description>
|
||||
|
||||
<!-- Product and plugin compatibility requirements -->
|
||||
<depends>com.intellij.modules.platform</depends>
|
||||
<depends>com.intellij.modules.vcs</depends>
|
||||
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<!-- Register the settings service -->
|
||||
<projectService serviceImplementation="org.example.CommitPrefixerSettings"/>
|
||||
|
||||
<!-- Register the settings UI -->
|
||||
<projectConfigurable
|
||||
parentId="tools"
|
||||
instance="org.example.CommitPrefixerConfigurable"
|
||||
id="org.example.CommitPrefixerConfigurable"
|
||||
displayName="Commit Prefixer"/>
|
||||
|
||||
<!-- Register the commit message prefixer -->
|
||||
<checkinHandlerFactory implementation="org.example.CommitPrefixerCheckinHandlerFactory"/>
|
||||
</extensions>
|
||||
|
||||
<actions>
|
||||
<!-- Add your actions here -->
|
||||
<action id="org.example.HelloWorldAction"
|
||||
class="org.example.HelloWorldAction"
|
||||
text="Hello World"
|
||||
description="Displays a Hello World message">
|
||||
<add-to-group group-id="ToolsMenu" anchor="last"/>
|
||||
<keyboard-shortcut keymap="$default" first-keystroke="ctrl alt H"/>
|
||||
</action>
|
||||
|
||||
</actions>
|
||||
</idea-plugin>
|
||||
Loading…
Add table
Reference in a new issue