├── .gitignore ├── .idea ├── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── compiler.xml ├── copyright │ ├── kaede.xml │ └── profiles_settings.xml ├── encodings.xml ├── markdown-navigator │ └── profiles_settings.xml └── vcs.xml ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── release ├── comment-formatter-0.1.0.jar └── comment-formatter-0.1.1.jar └── src └── main ├── java └── moe │ └── studio │ └── formatter │ └── CommentFormatter.java └── resources └── META-INF └── plugin.xml /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | *.log 4 | bin 5 | gen 6 | build 7 | out 8 | .DS_Store 9 | misc.xml 10 | workspace.xml 11 | .gradle 12 | .idea/caches 13 | .idea/libraries 14 | .idea/modules 15 | .idea/modules.xml 16 | .idea/gradle.xml 17 | 18 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 8 | 30 | 249 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /.idea/copyright/kaede.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | -------------------------------------------------------------------------------- /.idea/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Intellij Comment Formatter 2 | 3 | ```java 4 | /** 5 | +---------------------------------------------+ 6 | | public static final FiledA mFiledA; // xxx | 7 | | private static final FiledB mFiledB; // xxx | 8 | | public FiledC mFiledC; // xxx | 9 | | protected final FiledD mFiledD; // xxx | 10 | | FiledE mFiledE; // xxx | 11 | | | | 12 | | v | 13 | | public static final FiledA mFiledA; // xxx | 14 | | private static final FiledB mFiledB; // xxx | 15 | | public FiledC mFiledC; // xxx | 16 | | protected final FiledD mFiledD; // xxx | 17 | | FiledE mFiledE; // xxx | 18 | +---------------------------------------------+ 19 | */ 20 | ``` 21 | 22 | Comment Formatter is an intellij plugin that formats comments as above. 23 | 24 | ## Getting Started 25 | 26 | 1. Install `CommentFormatter` from [release](https://github.com/kaedea/comment-formatter/releases) or [IntelliJ Plugin Repository](https://plugins.jetbrains.com/plugin/9337?pr=idea). 27 | 2. Select all the lines which you wanna format. 28 | 3. Select `Tool - Format comment` or toggle `Ctrl + Cmd + L` to format. 29 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | repositories { 3 | mavenCentral() 4 | maven { 5 | url "https://oss.sonatype.org/content/repositories/snapshots/" 6 | } 7 | maven { 8 | url 'http://dl.bintray.com/jetbrains/intellij-plugin-service' 9 | } 10 | 11 | } 12 | dependencies { 13 | classpath "org.jetbrains.intellij.plugins:gradle-intellij-plugin:0.2.0-SNAPSHOT" 14 | } 15 | } 16 | 17 | apply plugin: 'java' 18 | apply plugin: 'org.jetbrains.intellij' 19 | 20 | intellij { 21 | version '2018.1' 22 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kaedea/comment-formatter/dfbbe7a6cfb118d4452c26900e7bbdf27c37e012/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Mon Aug 27 14:13:38 CST 2018 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /release/comment-formatter-0.1.0.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kaedea/comment-formatter/dfbbe7a6cfb118d4452c26900e7bbdf27c37e012/release/comment-formatter-0.1.0.jar -------------------------------------------------------------------------------- /release/comment-formatter-0.1.1.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kaedea/comment-formatter/dfbbe7a6cfb118d4452c26900e7bbdf27c37e012/release/comment-formatter-0.1.1.jar -------------------------------------------------------------------------------- /src/main/java/moe/studio/formatter/CommentFormatter.java: -------------------------------------------------------------------------------- 1 | package moe.studio.formatter; 2 | 3 | import com.intellij.openapi.actionSystem.AnAction; 4 | import com.intellij.openapi.actionSystem.AnActionEvent; 5 | import com.intellij.openapi.actionSystem.CommonDataKeys; 6 | import com.intellij.openapi.command.WriteCommandAction; 7 | import com.intellij.openapi.editor.Document; 8 | import com.intellij.openapi.editor.Editor; 9 | import com.intellij.openapi.editor.SelectionModel; 10 | import com.intellij.openapi.project.Project; 11 | import com.intellij.openapi.ui.Messages; 12 | import org.apache.commons.lang.StringUtils; 13 | import org.apache.http.util.TextUtils; 14 | 15 | /** 16 | * @author Kaede 17 | * @version 16/12/11 18 | */ 19 | public class CommentFormatter extends AnAction { 20 | 21 | // +---------------------------------------------+ 22 | // | public static final FiledA mFiledA; // xxx | 23 | // | private static final FiledB mFiledB; // xxx | 24 | // | public FiledC mFiledC; // xxx | 25 | // | protected final FiledD mFiledD; // xxx | 26 | // | FiledE mFiledE; // xxx | 27 | // | | | 28 | // | v | 29 | // | public static final FiledA mFiledA; // xxx | 30 | // | private static final FiledB mFiledB; // xxx | 31 | // | public FiledC mFiledC; // xxx | 32 | // | protected final FiledD mFiledD; // xxx | 33 | // | FiledE mFiledE; // xxx | 34 | // +---------------------------------------------+ 35 | 36 | public void actionPerformed(AnActionEvent e) { 37 | 38 | // Get all the required data from data keys 39 | final Editor editor = e.getRequiredData(CommonDataKeys.EDITOR); 40 | final Project project = e.getRequiredData(CommonDataKeys.PROJECT); 41 | // Access document, caret, and selection 42 | final Document document = editor.getDocument(); 43 | final SelectionModel model = editor.getSelectionModel(); 44 | 45 | String text = model.getSelectedText(); 46 | if (TextUtils.isEmpty(text)) { 47 | alert("Empty selected text."); 48 | return; 49 | } 50 | 51 | String[] strings = text.split("\n"); 52 | int longestComment = -1; 53 | 54 | for (String item : strings) { 55 | if (!item.contains("//")) { 56 | alert("Line without \"//\" detected."); 57 | return; 58 | } 59 | if (!item.contains(";")) { 60 | alert("Line without \";\" detected."); 61 | return; 62 | } 63 | 64 | int position = item.indexOf("//"); 65 | if (position > longestComment) { 66 | longestComment = position; 67 | } 68 | } 69 | 70 | if (longestComment == -1) { 71 | alert("WTF."); 72 | return; 73 | } 74 | 75 | final StringBuilder sb = new StringBuilder(); 76 | 77 | for (int i = 0; i < strings.length; i++) { 78 | String item = strings[i]; 79 | int position = item.indexOf("//"); 80 | 81 | if (position == longestComment) { 82 | sb.append(item); 83 | 84 | } else { 85 | int start = item.indexOf(";"); 86 | if (start >= position) { 87 | alert("WTF."); 88 | return; 89 | } 90 | String left = item.substring(0, start + 1); 91 | String middle = StringUtils.repeat(" ", longestComment - position); 92 | String right = item.substring(start + 1); 93 | sb.append(left).append(middle).append(right); 94 | } 95 | 96 | if (i < strings.length - 1) { 97 | sb.append("\n"); 98 | } 99 | } 100 | 101 | final int start = model.getSelectionStart(); 102 | final int end = model.getSelectionEnd(); 103 | 104 | WriteCommandAction.runWriteCommandAction(project, new Runnable() { 105 | @Override 106 | public void run() { 107 | document.replaceString(start, end, sb.toString()); 108 | } 109 | }); 110 | model.removeSelection(); 111 | } 112 | 113 | private void alert(String msg) { 114 | Messages.showMessageDialog( 115 | msg, 116 | "Comment Formatter", 117 | Messages.getInformationIcon() 118 | ); 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | moe.studio.formatter 3 | Comment Formatter 4 | 0.1.1 5 | Moe Studio 7 | 8 | 9 | 26 | 27 | 28 | 31 | 32 | 33 | 34 | 35 | 36 | 38 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 52 | 55 | 58 | 59 | 60 | 61 | --------------------------------------------------------------------------------