From bd243ce8770cabca099ff68f54299effd7d804dd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9E=97=E4=B8=87=E7=A8=8B?= <1498425439@qq.com>
Date: Sun, 28 Sep 2025 22:51:58 +0800
Subject: [PATCH] =?UTF-8?q?feat:=202.26=20load=20*.sql=20ddl=20comment=20|?=
=?UTF-8?q?=20=E8=AF=BB=E5=8F=96=20*.sql=20ddl=20=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
build.gradle | 4 +-
.../github/linwancen/plugin/show/LineEnd.java | 10 +-
.../linwancen/plugin/show/LineEndAdd.java | 2 +-
.../linwancen/plugin/show/ext/LineExt.java | 14 --
.../plugin/show/ext/listener/FileLoader.java | 5 +-
.../plugin/show/ext/sql/SqlCache.java | 135 ++++++++++++++++++
.../linwancen/plugin/show/ext/sql/SqlDoc.java | 130 +++++++++++++++++
.../plugin/show/lang/base/PsiUnSaveUtils.java | 22 +++
.../settings/AbstractSettingsComponent.java | 103 +++++++++++++
.../AbstractSettingsConfigurable.java | 24 ++++
.../show/settings/AbstractSettingsState.java | 89 ++++++++++++
.../settings/GlobalSettingsComponent.java | 3 +-
.../show/settings/ProjectSettingsState.java | 6 +
src/main/resources/META-INF/plugin.xml | 1 +
.../messages/ShowCommentBundle.properties | 7 +
.../messages/ShowCommentBundle_zh.properties | 7 +
.../mybatis/info/resources/xml.doc.tsv.sql | 1 +
.../show/demo/ext/sql/FromSqlMapper.xml | 21 +++
.../plugin/show/demo/ext/sql/MySQL_ddl.sql | 21 +++
.../plugin/show/demo/ext/sql/Oracle_ddl.sql | 7 +
20 files changed, 590 insertions(+), 22 deletions(-)
create mode 100644 src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlCache.java
create mode 100644 src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlDoc.java
create mode 100644 src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/FromSqlMapper.xml
create mode 100644 src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/MySQL_ddl.sql
create mode 100644 src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/Oracle_ddl.sql
diff --git a/build.gradle b/build.gradle
index f76d90a..3fad938 100644
--- a/build.gradle
+++ b/build.gradle
@@ -4,7 +4,7 @@ plugins {
}
group 'io.github.linwancen'
-version '2.25.0.' + (new Date().format('yyyy.MM.dd_HH.mm'))
+version '2.26.0.' + (new Date().format('yyyy.MM.dd_HH.mm'))
patchPluginXml {
// The performance of 2019.3 has been greatly improved.
@@ -15,6 +15,7 @@ patchPluginXml {
changeNotes = """
English Change Notes:
+- 2.26 Add External Comment load *.sql ddl comment
- 2.25 Add project-view-tree use xml/html/vue 1st or 2nd line comment
- 2.24 Add line-end-comment Maven pom.xml \${} doc
- 2.23 Add line-end-comment kotlin anno doc
@@ -69,6 +70,7 @@ patchPluginXml {
中文更新说明:
+- 2.26 增加 外部注释 读取 *.sql ddl 注释
- 2.25 增加 文件树注释 用 xml/html/vue 第 1 或第 2 行注释当文件注释
- 2.24 增加 行末注释 Maven pom.xml \${} 注释
- 2.23 增加 行末注释 kotlin 注解注释
diff --git a/src/main/java/io/github/linwancen/plugin/show/LineEnd.java b/src/main/java/io/github/linwancen/plugin/show/LineEnd.java
index 75be1be..02d820c 100644
--- a/src/main/java/io/github/linwancen/plugin/show/LineEnd.java
+++ b/src/main/java/io/github/linwancen/plugin/show/LineEnd.java
@@ -14,6 +14,7 @@ import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.bean.SettingsInfo;
import io.github.linwancen.plugin.show.cache.LineEndCacheUtils;
import io.github.linwancen.plugin.show.ext.LineExt;
+import io.github.linwancen.plugin.show.ext.sql.SqlDoc;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import io.github.linwancen.plugin.show.line.LineSelect;
import org.jetbrains.annotations.NotNull;
@@ -112,10 +113,17 @@ public class LineEnd extends EditorLinePainter {
}
private static @Nullable String lineDocSkipHave(@NotNull LineInfo info) {
- @Nullable String doc = LineExt.doc(info);
+ int i = info.text.indexOf(info.appSettings.lineEndPrefix);
+ @NotNull String code = i <= 0 ? info.text : info.text.substring(0, i);
+ @Nullable String doc = LineExt.extDoc(info, code);
if (doc == null) {
+ // include table and column doc from db
doc = BaseLangDoc.langDoc(info);
}
+ if (doc == null) {
+ // table and column doc from *.sql ddl
+ doc = SqlDoc.sqlDoc(info, code);
+ }
if (doc == null) {
return null;
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/LineEndAdd.java b/src/main/java/io/github/linwancen/plugin/show/LineEndAdd.java
index ecfe310..463f6c5 100644
--- a/src/main/java/io/github/linwancen/plugin/show/LineEndAdd.java
+++ b/src/main/java/io/github/linwancen/plugin/show/LineEndAdd.java
@@ -99,7 +99,7 @@ public class LineEndAdd extends CopyReferenceAction {
int startLine = 0;
int endLine = info.document.getLineCount() - 1;
LineEnd.textWithDoc(info, startLine, endLine, indicator, s ->
- info.document.replaceString(0, info.document.getTextLength() - 1, s)
+ info.document.replaceString(0, info.document.getTextLength(), s)
);
}
}
\ No newline at end of file
diff --git a/src/main/java/io/github/linwancen/plugin/show/ext/LineExt.java b/src/main/java/io/github/linwancen/plugin/show/ext/LineExt.java
index 6c6cd7e..0ae4428 100644
--- a/src/main/java/io/github/linwancen/plugin/show/ext/LineExt.java
+++ b/src/main/java/io/github/linwancen/plugin/show/ext/LineExt.java
@@ -14,20 +14,6 @@ public class LineExt {
private LineExt() {}
- public static @Nullable String doc(@NotNull LineInfo info) {
- int i = info.text.indexOf(info.appSettings.lineEndPrefix);
- @NotNull String code = i <= 0 ? info.text : info.text.substring(0, i);
- @Nullable String extDoc = LineExt.extDoc(info, code);
- if (extDoc == null) {
- return null;
- }
- extDoc = extDoc.trim();
- if (info.text.endsWith(extDoc)) {
- return null;
- }
- return extDoc;
- }
-
@Nullable
public static String extDoc(@NotNull LineInfo info, @NotNull String code) {
@NotNull String path = info.file.getPath();
diff --git a/src/main/java/io/github/linwancen/plugin/show/ext/listener/FileLoader.java b/src/main/java/io/github/linwancen/plugin/show/ext/listener/FileLoader.java
index 644bbb5..650d77e 100644
--- a/src/main/java/io/github/linwancen/plugin/show/ext/listener/FileLoader.java
+++ b/src/main/java/io/github/linwancen/plugin/show/ext/listener/FileLoader.java
@@ -25,10 +25,7 @@ public abstract class FileLoader {
public final Map fileDoc = new ConcurrentHashMap<>();
@Nullable
- public String treeDoc(@Nullable VirtualFile virtualFile) {
- if (virtualFile == null) {
- return null;
- }
+ public String treeDoc(@NotNull VirtualFile virtualFile) {
return fileDoc.get(virtualFile);
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlCache.java b/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlCache.java
new file mode 100644
index 0000000..2157045
--- /dev/null
+++ b/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlCache.java
@@ -0,0 +1,135 @@
+package io.github.linwancen.plugin.show.ext.sql;
+
+import com.intellij.ide.projectView.ProjectView;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.search.FilenameIndex;
+import io.github.linwancen.plugin.show.ext.listener.FileLoader;
+import io.github.linwancen.plugin.show.lang.base.PsiUnSaveUtils;
+import io.github.linwancen.plugin.show.settings.GlobalSettingsState;
+import io.github.linwancen.plugin.show.settings.ProjectSettingsState;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class SqlCache extends FileLoader {
+ private static final Logger LOG = LoggerFactory.getLogger(SqlCache.class);
+
+ /**
+ * support sql in other project
+ */
+ public static final Map TABLE_DOC_CACHE = new ConcurrentHashMap<>();
+ public static final Map COLUMN_DOC_CACHE = new ConcurrentHashMap<>();
+ public static final Map INDEX_DOC_CACHE = new ConcurrentHashMap<>();
+
+ private SqlCache() {}
+
+ @Nullable
+ @Override
+ public String treeDoc(@NotNull VirtualFile virtualFile) {
+ String name = virtualFile.getNameWithoutExtension();
+ return TABLE_DOC_CACHE.get(name);
+ }
+
+ @Override
+ public void clearAll() {
+ TABLE_DOC_CACHE.clear();
+ COLUMN_DOC_CACHE.clear();
+ }
+
+ @Override
+ public void remove(@NotNull VirtualFile file, @Nullable String name) {}
+
+ @Override
+ public void copyImpl(@NotNull VirtualFile file, @NotNull VirtualFile newFile) {}
+
+ @Override
+ public void loadAllImpl(@NotNull Project project) {
+ GlobalSettingsState g = GlobalSettingsState.getInstance();
+ ProjectSettingsState p = ProjectSettingsState.getInstance(project);
+ if (!g.sqlSplitEffect && !p.sqlSplitEffect) {
+ return;
+ }
+ @NotNull Collection files = FilenameIndex.getAllFilesByExt(project, "sql");
+ @NotNull StringBuilder sb = new StringBuilder();
+ for (@NotNull VirtualFile file : files) {
+ loadFileImpl(file, project);
+ sb.append(file.getName()).append("\n");
+ }
+ if (files.isEmpty()) {
+ return;
+ }
+ if (!project.isDisposed()) {
+ ProjectView.getInstance(project).refresh();
+ }
+ LOG.info("SQL doc load all complete {} files\n{}", files.size(), sb);
+ }
+
+ @Override
+ public void loadFileImpl(@NotNull VirtualFile file, @Nullable Project project) {
+ String code = PsiUnSaveUtils.fileText(project, file);
+ if (code == null) {
+ return;
+ }
+ GlobalSettingsState g = GlobalSettingsState.getInstance();
+ loadSqlDoc(code, TABLE_DOC_CACHE, g.tableDocEffect, g.tableDoc);
+ loadSqlDoc(code, COLUMN_DOC_CACHE, g.columnDocEffect, g.columnDoc);
+ loadSqlDoc(code, INDEX_DOC_CACHE, g.indexDocEffect, g.indexDoc);
+ if (project == null) {
+ return;
+ }
+ ProjectSettingsState p = ProjectSettingsState.getInstance(project);
+ loadSqlDoc(code, TABLE_DOC_CACHE, p.tableDocEffect, p.tableDoc);
+ loadSqlDoc(code, COLUMN_DOC_CACHE, p.columnDocEffect, p.columnDoc);
+ loadSqlDoc(code, INDEX_DOC_CACHE, p.indexDocEffect, p.indexDoc);
+ }
+
+ public static final Pattern KEY_PATTERN = Pattern.compile("`?, *`?");
+
+ private static void loadSqlDoc(@NotNull String code, @NotNull Map map,
+ boolean effect, Map patternMap) {
+ if (!effect) {
+ return;
+ }
+ for (Pattern[] patterns : patternMap.values()) {
+ for (Pattern pattern : patterns) {
+ Matcher m = pattern.matcher(code);
+ while (m.find()) {
+ String key = m.group(1);
+ String comment = m.group(2);
+ if (!key.contains(",")) {
+ putComment(map, key, comment);
+ continue;
+ }
+ // multi column index seq
+ String[] split = KEY_PATTERN.split(key);
+ for (int i = 0; i < split.length; i++) {
+ String k = split[i];
+ putComment(map, k, String.valueOf(i + 1));
+ }
+ }
+ }
+ }
+ }
+
+ private static final Pattern IGNORE_KEY_PATTERN = Pattern.compile("(?i)^(id|name)$");
+
+ private static void putComment(@NotNull Map map, @NotNull String k, String comment) {
+ if (IGNORE_KEY_PATTERN.matcher(k).find()) {
+ return;
+ }
+ String s = map.get(k);
+ if (s != null && !s.equalsIgnoreCase(comment) && !s.contains(comment)) {
+ map.put(k, s + " | " + comment);
+ } else {
+ map.put(k, comment);
+ }
+ }
+}
diff --git a/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlDoc.java b/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlDoc.java
new file mode 100644
index 0000000..4e7ff8d
--- /dev/null
+++ b/src/main/java/io/github/linwancen/plugin/show/ext/sql/SqlDoc.java
@@ -0,0 +1,130 @@
+package io.github.linwancen.plugin.show.ext.sql;
+
+import io.github.linwancen.plugin.show.bean.LineInfo;
+import io.github.linwancen.plugin.show.settings.AbstractSettingsState;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class SqlDoc {
+
+ @Nullable
+ public static String sqlDoc(@NotNull LineInfo info, @NotNull String code) {
+ String extension = info.file.getExtension();
+ if (extension == null) {
+ return null;
+ }
+ String s = sqlDocState(extension, info.projectSettings, code);
+ if (s != null) {
+ return s;
+ }
+ return sqlDocState(extension, info.globalSettings, code);
+ }
+
+ private static String sqlDocState(@NotNull String extension, @NotNull AbstractSettingsState state,
+ @NotNull String code) {
+ if (!state.sqlSplitEffect) {
+ return null;
+ }
+ Pattern[] patterns = state.sqlSplit.get(extension);
+ if (patterns == null) {
+ return null;
+ }
+ for (Pattern pattern : patterns) {
+ return sqlDocPattern(pattern, code);
+ }
+ return null;
+ }
+
+
+ @Nullable
+ private static String sqlDocPattern(@NotNull Pattern pattern, @NotNull String code) {
+ String[] words = pattern.split(code);
+ @NotNull Matcher matcher = pattern.matcher(code);
+
+ boolean haveDoc = false;
+ boolean haveKey = false;
+ @NotNull StringBuilder sb = new StringBuilder();
+ for (@NotNull String s : words) {
+ haveDoc |= appendDocSQL(sb, s);
+ haveKey = appendKeyDocSQL(sb, matcher);
+ }
+ while (haveKey) {
+ haveKey = appendKeyDocSQL(sb, matcher);
+ }
+ if (!haveDoc) {
+ return null;
+ }
+ return sb.toString();
+ }
+
+ private static boolean appendDocSQL(@NotNull StringBuilder sb, @NotNull String word) {
+ word = word.trim();
+ if (word.isEmpty()) {
+ return false;
+ }
+ @Nullable String tableDoc = SqlCache.TABLE_DOC_CACHE.get(word);
+ if (tableDoc != null) {
+ sb.append(tableDoc);
+ return true;
+ }
+ @Nullable String columnDoc = SqlCache.COLUMN_DOC_CACHE.get(word);
+ if (columnDoc != null) {
+ sb.append(columnDoc);
+ @Nullable String indexDoc = SqlCache.INDEX_DOC_CACHE.get(word);
+ if (indexDoc != null) {
+ sb.append(indexSymbol(indexDoc));
+ }
+ return true;
+ }
+ sb.append(" ");
+ return false;
+ }
+
+ private static String indexSymbol(String indexDoc) {
+ switch (indexDoc) {
+ case "primary":
+ case "PRIMARY":
+ return " √ P";
+ case "UNIQUE":
+ case "unique":
+ return " √ U";
+ case ")":
+ return " √";
+ default:
+ // multi column index seq
+ return " √ " + indexDoc;
+ }
+ }
+
+ private static boolean appendKeyDocSQL(@NotNull StringBuilder sb, @NotNull Matcher matcher) {
+ if (!matcher.find()) {
+ return false;
+ }
+ String keyword = matcher.group();
+ keyword = unescape(keyword);
+ sb.append(keyword);
+ return true;
+ }
+
+ @NotNull
+ private static String unescape(String keyword) {
+ // >|<|&|"|'
+ switch (keyword) {
+ case ">":
+ return ">";
+ case "<":
+ return "<";
+ case "&":
+ return "&";
+ case """:
+ return "\"";
+ case "'":
+ return "'";
+ default:
+ return " ";
+ }
+ }
+}
diff --git a/src/main/java/io/github/linwancen/plugin/show/lang/base/PsiUnSaveUtils.java b/src/main/java/io/github/linwancen/plugin/show/lang/base/PsiUnSaveUtils.java
index 0878db8..4de642f 100644
--- a/src/main/java/io/github/linwancen/plugin/show/lang/base/PsiUnSaveUtils.java
+++ b/src/main/java/io/github/linwancen/plugin/show/lang/base/PsiUnSaveUtils.java
@@ -1,9 +1,15 @@
package io.github.linwancen.plugin.show.lang.base;
import com.intellij.openapi.editor.Document;
+import com.intellij.openapi.fileEditor.FileDocumentManager;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiDocumentManager;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
+import com.intellij.psi.PsiManager;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
public class PsiUnSaveUtils {
@@ -36,4 +42,20 @@ public class PsiUnSaveUtils {
return element.getText();
}
}
+
+ @Nullable
+ public static String fileText(@Nullable Project project, @NotNull VirtualFile file) {
+ Document document = FileDocumentManager.getInstance().getDocument(file);
+ if (document != null) {
+ return document.getText();
+ }
+ if (project == null) {
+ return null;
+ }
+ PsiFile psiFile = PsiManager.getInstance(project).findFile(file);
+ if (psiFile != null) {
+ return psiFile.getText();
+ }
+ return null;
+ }
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsComponent.java b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsComponent.java
index fbc1225..948ec4b 100644
--- a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsComponent.java
+++ b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsComponent.java
@@ -33,11 +33,25 @@ public abstract class AbstractSettingsComponent {
private final JBTextField docGet = new JBTextField();
private final JBCheckBox annoDocEffect = new JBCheckBox("");
private final JBTextArea annoDoc = new JBTextArea();
+
+ // region PatternMap: dirDoc fileDoc sqlSplit tableDoc columnDoc indexDoc
+
private final JBCheckBox dirDocEffect = new JBCheckBox("");
private final JBTextArea dirDoc = new JBTextArea();
private final JBCheckBox fileDocEffect = new JBCheckBox("");
private final JBTextArea fileDoc = new JBTextArea();
+ protected final JBCheckBox sqlSplitEffect = new JBCheckBox("");
+ private final JBTextArea sqlSplit = new JBTextArea();
+ private final JBCheckBox tableDocEffect = new JBCheckBox("");
+ private final JBTextArea tableDoc = new JBTextArea();
+ private final JBCheckBox columnDocEffect = new JBCheckBox("");
+ private final JBTextArea columnDoc = new JBTextArea();
+ private final JBCheckBox indexDocEffect = new JBCheckBox("");
+ private final JBTextArea indexDoc = new JBTextArea();
+
+ // endregion
+
@NotNull
protected JPanel commonPanel() {
return FormBuilder.createFormBuilder()
@@ -97,6 +111,24 @@ public abstract class AbstractSettingsComponent {
return panel;
}
+ @SuppressWarnings("unused")
+ @NotNull
+ private JPanel sqlPanel() {
+ // sqlSplit tableDoc columnDoc indexDoc
+ @NotNull JPanel sqlLabel = JPanelFactory.of(sqlSplitEffect, new JBLabel(ShowBundle.message("sql.split.regexp")));
+ @NotNull JPanel tableLabel = JPanelFactory.of(tableDocEffect, new JBLabel(ShowBundle.message("table.doc.regexp")));
+ @NotNull JPanel columnLabel = JPanelFactory.of(columnDocEffect, new JBLabel(ShowBundle.message("column.doc.regexp")));
+ @NotNull JPanel indexLabel = JPanelFactory.of(indexDocEffect, new JBLabel(ShowBundle.message("index.doc.regexp")));
+ JPanel panel = FormBuilder.createFormBuilder()
+ .addLabeledComponent(sqlLabel, sqlSplit, 1, true)
+ .addLabeledComponent(tableLabel, tableDoc, 1, true)
+ .addLabeledComponent(columnLabel, columnDoc, 1, true)
+ .addLabeledComponent(indexLabel, indexDoc, 1, true)
+ .getPanel();
+ panel.setBorder(IdeBorderFactory.createTitledBorder(ShowBundle.message("sql.comment")));
+ return panel;
+ }
+
@NotNull
public String getLineEndCount() {
return lineEndCount.getText();
@@ -223,6 +255,7 @@ public abstract class AbstractSettingsComponent {
annoDoc.setText(newText);
}
+ // region PatternMap
public boolean getDirDocEffect() {
return dirDocEffect.isSelected();
@@ -258,4 +291,74 @@ public abstract class AbstractSettingsComponent {
public void setFileDoc(@NotNull String newText) {
fileDoc.setText(newText);
}
+
+ public boolean getSqlSplitEffect() {
+ return sqlSplitEffect.isSelected();
+ }
+
+ public void setSqlSplitEffect(boolean newStatus) {
+ sqlSplitEffect.setSelected(newStatus);
+ }
+
+ @NotNull
+ public String getSqlSplit() {
+ return sqlSplit.getText();
+ }
+
+ public void setSqlSplit(@NotNull String newText) {
+ sqlSplit.setText(newText);
+ }
+
+ public boolean getTableDocEffect() {
+ return tableDocEffect.isSelected();
+ }
+
+ public void setTableDocEffect(boolean newStatus) {
+ tableDocEffect.setSelected(newStatus);
+ }
+
+ @NotNull
+ public String getTableDoc() {
+ return tableDoc.getText();
+ }
+
+ public void setTableDoc(@NotNull String newText) {
+ tableDoc.setText(newText);
+ }
+
+ public boolean getColumnDocEffect() {
+ return columnDocEffect.isSelected();
+ }
+
+ public void setColumnDocEffect(boolean newStatus) {
+ columnDocEffect.setSelected(newStatus);
+ }
+
+ @NotNull
+ public String getColumnDoc() {
+ return columnDoc.getText();
+ }
+
+ public void setColumnDoc(@NotNull String newText) {
+ columnDoc.setText(newText);
+ }
+
+ public boolean getIndexDocEffect() {
+ return indexDocEffect.isSelected();
+ }
+
+ public void setIndexDocEffect(boolean newStatus) {
+ indexDocEffect.setSelected(newStatus);
+ }
+
+ @NotNull
+ public String getIndexDoc() {
+ return indexDoc.getText();
+ }
+
+ public void setIndexDoc(@NotNull String newText) {
+ indexDoc.setText(newText);
+ }
+
+ // endregion PatternMap for AI: dirDoc fileDoc sqlSplit tableDoc columnDoc indexDoc
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsConfigurable.java b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsConfigurable.java
index eb4d6ec..1003c72 100644
--- a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsConfigurable.java
+++ b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsConfigurable.java
@@ -26,6 +26,14 @@ public class AbstractSettingsConfigurable {
modified |= !component.getDirDoc().equals(settings.getDirDoc());
modified |= component.getFileDocEffect() != settings.fileDocEffect;
modified |= !component.getFileDoc().equals(settings.getFileDoc());
+ modified |= component.getSqlSplitEffect() != settings.sqlSplitEffect;
+ modified |= !component.getSqlSplit().equals(settings.getSqlSplit());
+ modified |= component.getTableDocEffect() != settings.tableDocEffect;
+ modified |= !component.getTableDoc().equals(settings.getTableDoc());
+ modified |= component.getColumnDocEffect() != settings.columnDocEffect;
+ modified |= !component.getColumnDoc().equals(settings.getColumnDoc());
+ modified |= component.getIndexDocEffect() != settings.indexDocEffect;
+ modified |= !component.getIndexDoc().equals(settings.getIndexDoc());
return modified;
}
@@ -52,6 +60,14 @@ public class AbstractSettingsConfigurable {
settings.setDirDoc(component.getDirDoc());
settings.fileDocEffect = component.getFileDocEffect();
settings.setFileDoc(component.getFileDoc());
+ settings.sqlSplitEffect = component.getSqlSplitEffect();
+ settings.setSqlSplit(component.getSqlSplit());
+ settings.tableDocEffect = component.getTableDocEffect();
+ settings.setTableDoc(component.getTableDoc());
+ settings.columnDocEffect = component.getColumnDocEffect();
+ settings.setColumnDoc(component.getColumnDoc());
+ settings.indexDocEffect = component.getIndexDocEffect();
+ settings.setIndexDoc(component.getIndexDoc());
}
static void reset(@NotNull AbstractSettingsState settings, @NotNull AbstractSettingsComponent component) {
@@ -73,5 +89,13 @@ public class AbstractSettingsConfigurable {
component.setDirDoc(settings.getDirDoc());
component.setFileDocEffect(settings.fileDocEffect);
component.setFileDoc(settings.getFileDoc());
+ component.setSqlSplitEffect(settings.sqlSplitEffect);
+ component.setSqlSplit(settings.getSqlSplit());
+ component.setTableDocEffect(settings.tableDocEffect);
+ component.setTableDoc(settings.getTableDoc());
+ component.setColumnDocEffect(settings.columnDocEffect);
+ component.setColumnDoc(settings.getColumnDoc());
+ component.setIndexDocEffect(settings.indexDocEffect);
+ component.setIndexDoc(settings.getIndexDoc());
}
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsState.java b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsState.java
index 48e6858..dfa9ecc 100644
--- a/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsState.java
+++ b/src/main/java/io/github/linwancen/plugin/show/settings/AbstractSettingsState.java
@@ -44,6 +44,8 @@ public abstract class AbstractSettingsState {
{"field", "cn.idev.excel.annotation.ExcelProperty", "value"},
};
+ // region PatternMap: dirDoc fileDoc sqlSplit tableDoc columnDoc indexDoc
+
public boolean dirDocEffect = true;
@NotNull
public transient Map dirDoc = new LinkedHashMap<>() {{
@@ -68,6 +70,57 @@ public abstract class AbstractSettingsState {
put("sh", new Pattern[]{Pattern.compile("(?m)^#++ *([^!].*)")});
}};
+ public boolean sqlSplitEffect = true;
+ @NotNull
+ public transient Map sqlSplit = new LinkedHashMap<>() {{
+ put("sql", new Pattern[]{Pattern.compile("\\W")});
+ put("xml", new Pattern[]{Pattern.compile(",|" +
+ "<.+=|" +
+ " ?[!=].*>|" +
+ "[<=>/\"\\s()]|" +
+ "#\\{[^}]++}|" +
+ "\\w++\\.|" +
+ ">|<|&|"|'")});
+ }};
+
+ public boolean tableDocEffect = true;
+ @NotNull
+ public transient Map tableDoc = new LinkedHashMap<>() {{
+ put("Oracle", new Pattern[]{Pattern.compile("(?i)comment\\s++on\\s++table\\s++" +
+ "(?:['\"]?\\w++['\"]?\\s*+\\.\\s*+)?" +
+ "['\"]?(\\w++)['\"]?\\s++" +
+ "is\\s++['\"]([^'\"]++)")});
+ put("MySQL", new Pattern[]{Pattern.compile("(?i)table(?:\\s++if\\s++not\\s++exists)?\\s++" +
+ "(?:`?\\w++`?\\.)?" +
+ "`?(\\w++)[^;]+?" +
+ "comment\\s*+=\\s*+['\"]([^'\"]++)")});
+ }};
+
+ public boolean columnDocEffect = true;
+ @NotNull
+ public transient Map columnDoc = new LinkedHashMap<>() {{
+ put("Oracle", new Pattern[]{Pattern.compile("(?i)comment\\s++on\\s++column\\s++" +
+ "(?:['\"]?\\w++['\"]?\\s*+\\.\\s*+)?" +
+ "['\"]?\\w++['\"]?\\s*+\\.\\s*+" +
+ "['\"]?(\\w++)['\"]?" +
+ "\\s++is\\s++['\"]([^'\"]++)")});
+ put("MySQL", new Pattern[]{Pattern.compile("(?i)\\W(\\w++)`?\\s++" +
+ "(?:varchar|int|tinyint|char|text|decimal|datetime|timestamp|time|date|float|double|bigint|mediumtext" +
+ "|longtext|tinytext|enum|set|json|boolean|bit|binary|varbinary|blob|mediumblob|longblob|tinyblob).+?" +
+ "comment\\s++['\"]([^'\"]++)")});
+ }};
+
+ public boolean indexDocEffect = true;
+ @NotNull
+ public transient Map indexDoc = new LinkedHashMap<>() {{
+ put("add", new Pattern[]{Pattern.compile("(?i)(?:index|primary).+?\\(`?([^)]+?)`?(\\))")});
+ put("create", new Pattern[]{Pattern.compile("(?i)\\W(\\w++)`?\\s++" +
+ "(?:varchar|int|tinyint|char|text|decimal|datetime|timestamp|time|date|float|double|bigint|mediumtext" +
+ "|longtext|tinytext|enum|set|json|boolean|bit|binary|varbinary|blob|mediumblob|longblob|tinyblob).+?" +
+ "(primary|unique)")});
+ }};
+
+ // endregion
public String getLineInclude() {
return lineInclude.pattern();
@@ -179,4 +232,40 @@ public abstract class AbstractSettingsState {
public void setFileDoc(@NotNull String fileDoc) {
this.fileDoc = PatternMapUtils.toMap(fileDoc);
}
+
+ @NotNull
+ public String getSqlSplit() {
+ return PatternMapUtils.toString(sqlSplit);
+ }
+
+ public void setSqlSplit(@NotNull String sqlSplit) {
+ this.sqlSplit = PatternMapUtils.toMap(sqlSplit);
+ }
+
+ @NotNull
+ public String getTableDoc() {
+ return PatternMapUtils.toString(tableDoc);
+ }
+
+ public void setTableDoc(@NotNull String tableDoc) {
+ this.tableDoc = PatternMapUtils.toMap(tableDoc);
+ }
+
+ @NotNull
+ public String getColumnDoc() {
+ return PatternMapUtils.toString(columnDoc);
+ }
+
+ public void setColumnDoc(@NotNull String columnDoc) {
+ this.columnDoc = PatternMapUtils.toMap(columnDoc);
+ }
+
+ @NotNull
+ public String getIndexDoc() {
+ return PatternMapUtils.toString(indexDoc);
+ }
+
+ public void setIndexDoc(@NotNull String indexDoc) {
+ this.indexDoc = PatternMapUtils.toMap(indexDoc);
+ }
}
diff --git a/src/main/java/io/github/linwancen/plugin/show/settings/GlobalSettingsComponent.java b/src/main/java/io/github/linwancen/plugin/show/settings/GlobalSettingsComponent.java
index e7c41eb..e9d5c2a 100644
--- a/src/main/java/io/github/linwancen/plugin/show/settings/GlobalSettingsComponent.java
+++ b/src/main/java/io/github/linwancen/plugin/show/settings/GlobalSettingsComponent.java
@@ -14,7 +14,8 @@ public class GlobalSettingsComponent extends AbstractSettingsComponent {
resetDefault.addActionListener(e -> GlobalSettingsConfigurable.reset(GlobalSettingsState.DEFAULT_SETTING, this));
myMainPanel = FormBuilder.createFormBuilder()
.addComponent(JPanelFactory.of(resetDefault,
- new JBLabel(ShowBundle.message("line.count")), lineEndCount
+ new JBLabel(ShowBundle.message("line.count")), lineEndCount,
+ JPanelFactory.of(sqlSplitEffect, new JBLabel(ShowBundle.message("sql.comment")))
), 1)
.addComponent(commonPanel(), 1)
.addComponentFillVertically(new JPanel(), 0)
diff --git a/src/main/java/io/github/linwancen/plugin/show/settings/ProjectSettingsState.java b/src/main/java/io/github/linwancen/plugin/show/settings/ProjectSettingsState.java
index 64bcc5a..2ee216d 100644
--- a/src/main/java/io/github/linwancen/plugin/show/settings/ProjectSettingsState.java
+++ b/src/main/java/io/github/linwancen/plugin/show/settings/ProjectSettingsState.java
@@ -28,6 +28,12 @@ public class ProjectSettingsState extends AbstractSettingsState implements Persi
this.dirDoc = Collections.emptyMap();
this.fileDocEffect = false;
this.fileDoc = Collections.emptyMap();
+ this.sqlSplitEffect = false;
+ this.sqlSplit = Collections.emptyMap();
+ this.tableDocEffect = false;
+ this.tableDoc = Collections.emptyMap();
+ this.columnDocEffect = false;
+ this.columnDoc = Collections.emptyMap();
}
public static final ProjectSettingsState DEFAULT_SETTING = new ProjectSettingsState();
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
index 332cdd6..e253f90 100644
--- a/src/main/resources/META-INF/plugin.xml
+++ b/src/main/resources/META-INF/plugin.xml
@@ -169,6 +169,7 @@ Show doc comment in the Project view Tree, line End, json, other
+
diff --git a/src/main/resources/messages/ShowCommentBundle.properties b/src/main/resources/messages/ShowCommentBundle.properties
index 6a43614..aa814d0 100644
--- a/src/main/resources/messages/ShowCommentBundle.properties
+++ b/src/main/resources/messages/ShowCommentBundle.properties
@@ -25,6 +25,7 @@ prefix=prefix:
line.end.comment=Line End Comment
web.comment=Web Comment
tree.comment=Tree Comment
+sql.comment=SQL Comment From *.sql
regexp.tip=Separated by '|' (Regexp), use '' to include all or exclude none.
sign.include.regexp=className#memberName include Regexp:
sign.exclude.regexp=className#memberName exclude Regexp:
@@ -36,8 +37,14 @@ attr.include.regexp=attr include Regexp:
attr.exclude.regexp=attr exclude Regexp:
get.doc.regexp=get doc Regexp, last () when had, default is first sentence .+?(?:[\u3002\r\n]|. ) :
anno.doc=anno doc, class/method/field/!doc/all#AnnoFullName#methodName#methodName2, Separated by \\n:
+# region PatternMap: dirDoc fileDoc sqlSplit tableDoc columnDoc indexDoc
dir.doc.regexp=dir doc, fileName||Regexp1||Regexp2\\n:
file.doc.regexp=file doc, fileExtension||Regexp1||Regexp2\\n:
+sql.split.regexp=sql split, fileExtension||Regexp1||Regexp2\\n:
+table.doc.regexp=table doc, fileExtension||Regexp1||Regexp2\\n:
+column.doc.regexp=column doc, fileExtension||Regexp1||Regexp2\\n:
+index.doc.regexp=index doc, fileExtension||Regexp1||Regexp2\\n:
+# endregion
global.settings.effective=Global Settings Effective
project.settings.effective=Project Settings Effective
diff --git a/src/main/resources/messages/ShowCommentBundle_zh.properties b/src/main/resources/messages/ShowCommentBundle_zh.properties
index bbeebed..5bfdaac 100644
--- a/src/main/resources/messages/ShowCommentBundle_zh.properties
+++ b/src/main/resources/messages/ShowCommentBundle_zh.properties
@@ -25,6 +25,7 @@ prefix=\u524D\u7F00\uFF1A
line.end.comment=\u884C\u672B\u6CE8\u91CA
web.comment=Web \u6CE8\u91CA
tree.comment=\u6811\u6CE8\u91CA
+sql.comment=SQL\u6CE8\u91CA\u6765\u81EA *.sql
regexp.tip=| \u5206\u9694 (\u6B63\u5219), \u7A7A\u5B57\u7B26\u4E32\u4EE3\u8868\u5305\u62EC\u6240\u6709\u6216\u4E0D\u6392\u9664
sign.include.regexp=\u7C7B#\u65B9\u6CD5 \u5305\u542B \u6B63\u5219\uFF1A
sign.exclude.regexp=\u7C7B#\u65B9\u6CD5 \u6392\u9664 \u6B63\u5219\uFF1A
@@ -36,8 +37,14 @@ attr.include.regexp=\u5C5E\u6027 \u5305\u542B \u6B63\u5219\uFF1A
attr.exclude.regexp=\u5C5E\u6027 \u6392\u9664 \u6B63\u5219\uFF1A
get.doc.regexp=\u6CE8\u91CA\u63D0\u53D6\u6B63\u5219\uFF0C\u82E5\u6709 () \u5219\u53D6\u6700\u540E\u4E00\u4E2A\uFF0C\u9ED8\u8BA4\u6B63\u5219\u662F\u7B2C\u4E00\u53E5 .+?(?:[\u3002\r\n]|. )\uFF1A
anno.doc=\u6CE8\u89E3\u6CE8\u91CA\uFF0Cclass/method/field/!doc/all#\u6CE8\u89E3\u5168\u540D#\u65B9\u6CD5\u540D1#\u65B9\u6CD5\u540D2 \u6362\u884C\u5206\u9694\uFF1A
+# region PatternMap: dirDoc fileDoc sqlSplit tableDoc columnDoc indexDoc
dir.doc.regexp=\u76EE\u5F55\u6CE8\u91CA\uFF0C\u6587\u4EF6\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
file.doc.regexp=\u6587\u4EF6\u6CE8\u91CA\uFF0C\u6587\u4EF6\u62D3\u5C55\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
+sql.split.regexp=SQL\u5206\u9694\uFF0C\u6587\u4EF6\u62D3\u5C55\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
+table.doc.regexp=\u8868\u6CE8\u91CA\uFF0C\u65B9\u6848\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
+column.doc.regexp=\u5B57\u6BB5\u6CE8\u91CA\uFF0C\u65B9\u6848\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
+index.doc.regexp=\u7D22\u5F15\u6CE8\u91CA\uFF0C\u65B9\u6848\u540D||\u6B63\u52191||\u6B63\u52192\\n\uFF1A
+# endregion
global.settings.effective=\u5168\u5C40\u914D\u7F6E\u751F\u6548
project.settings.effective=\u9879\u76EE\u914D\u7F6E\u751F\u6548
diff --git a/src/test/java/io/github/linwancen/plugin/show/demo/ext/mybatis/info/resources/xml.doc.tsv.sql b/src/test/java/io/github/linwancen/plugin/show/demo/ext/mybatis/info/resources/xml.doc.tsv.sql
index 309f698..fce69a0 100644
--- a/src/test/java/io/github/linwancen/plugin/show/demo/ext/mybatis/info/resources/xml.doc.tsv.sql
+++ b/src/test/java/io/github/linwancen/plugin/show/demo/ext/mybatis/info/resources/xml.doc.tsv.sql
@@ -28,4 +28,5 @@ FROM information_schema.`COLUMNS` c
ON s.TABLE_SCHEMA = c.TABLE_SCHEMA AND s.TABLE_NAME = c.TABLE_NAME AND s.COLUMN_NAME = c.COLUMN_NAME
WHERE c.COLUMN_COMMENT != ''
AND c.TABLE_SCHEMA NOT IN ('mysql', 'information_schema', 'performance_schema', 'sys')
+ AND c.COLUMN_NAME NOT IN ('id', 'name')
GROUP BY c.COLUMN_NAME, c.COLUMN_COMMENT, c.TABLE_NAME, c.TABLE_SCHEMA;
\ No newline at end of file
diff --git a/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/FromSqlMapper.xml b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/FromSqlMapper.xml
new file mode 100644
index 0000000..9f18e68
--- /dev/null
+++ b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/FromSqlMapper.xml
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
diff --git a/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/MySQL_ddl.sql b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/MySQL_ddl.sql
new file mode 100644
index 0000000..6fc4cf4
--- /dev/null
+++ b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/MySQL_ddl.sql
@@ -0,0 +1,21 @@
+-- MySQL 注释来源 DDL
+CREATE TABLE from_mysql_table
+(
+ id INT NOT NULL AUTO_INCREMENT COMMENT '主键',
+ from_mysql_column INT NOT NULL COMMENT '创建列',
+ from_mysql_mod_column INT NOT NULL,
+ PRIMARY KEY (id)
+) ENGINE = InnoDB
+ DEFAULT CHARSET = utf8mb4 COMMENT ='表';
+
+ALTER TABLE from_mysql_table COMMENT = '修改表';
+
+ALTER TABLE from_mysql_table ADD from_mysql_add_column
+ VARCHAR(255) COMMENT '增加列';
+
+ALTER TABLE from_mysql_table
+ MODIFY COLUMN from_mysql_mod_column
+ DECIMAL(12, 2) DEFAULT 0 COMMENT '修改列';
+
+CREATE INDEX idx1 ON from_mysql_table(from_mysql_column);
+CREATE INDEX idx1 ON from_mysql_table(from_mysql_add_column, from_mysql_mod_column);
\ No newline at end of file
diff --git a/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/Oracle_ddl.sql b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/Oracle_ddl.sql
new file mode 100644
index 0000000..f0b075d
--- /dev/null
+++ b/src/test/java/io/github/linwancen/plugin/show/demo/ext/sql/Oracle_ddl.sql
@@ -0,0 +1,7 @@
+-- Oracle 注释来源 DDL
+COMMENT ON TABLE from_oracle_table IS '表';
+COMMENT ON COLUMN from_oracle_table.id IS '主键';
+COMMENT ON COLUMN from_oracle_table.name IS '名字';
+COMMENT ON COLUMN from_oracle_table.from_oracle_column IS '列';
+COMMENT ON TABLE schema1.from_oracle_table IS '带schema表';
+COMMENT ON COLUMN schema1.from_oracle_table.from_oracle_column IS '带schema列';
\ No newline at end of file