138 lines
6.9 KiB
XML
138 lines
6.9 KiB
XML
<idea-plugin url="https://plugins.jetbrains.com/plugin/18553-show-comment">
|
||
<id>io.github.linwancen.show-comment</id>
|
||
<name>Show Comment</name>
|
||
<vendor email="1498425439@qq.com" url="https://github.com/LinWanCen/show-comment">林万程</vendor>
|
||
|
||
<description><![CDATA[
|
||
Show doc comment at the Project view Tree, line End, json etc.
|
||
<ul>
|
||
<li>"xx-ClassNameOrSimpleName.json" and jump to field
|
||
<li>input `doc` `docc` -> /** */
|
||
<li>json doc from xxx.json.tsv
|
||
<li>json dict doc from (key).tsv
|
||
<li>from External Conf for folder, resources, COBOL etc.
|
||
<li>Config: settings -> Tools -> // Show Comment Global/Project
|
||
</ul>
|
||
|
||
<h3>External Comment:</h3>
|
||
<a href="https://github.com/LinWanCen/show-comment/tree/main/src/test/java/io/github/linwancen/plugin/show/demo/ext">Demo(GitHub)</a>
|
||
<ul>
|
||
<li>Reload: Tools -> 🔄 // Reload External Comment
|
||
<li>path/[any][filename.]ext.tree.tsv // file and folder tree comment 📝 📁
|
||
<li>path/[any][filename.]ext.key.tsv // line keywords to split and comment
|
||
<li>path/[any][filename.]ext.doc.tsv // line words comment
|
||
<li>In path, "doc" can replace any, and can use % like in SQL, effect at previous layer when folder named -1
|
||
<li>The lines in key.tsv will be concatenated with `|` to regexp; longer str should in front; startWith `?` to exclude
|
||
<li>Chang tsv file in find pop window would not reload!
|
||
<li>The tsv conf file must could be search in "Go to File"(Ctrl + Shift + N)
|
||
</ul>
|
||
|
||
|
||
<h2>中文说明:</h2>
|
||
<ul>
|
||
<li>在结构树显示 文档注释
|
||
<li>在行末尾显示 文档注释
|
||
<li>输入 doc / docc 等生成 /** */
|
||
<li>json 字段注释从 xxx.json.tsv 读取
|
||
<li>json 字典注释从 键名.tsv 读取
|
||
<li>支持 "xx-类全名或简名.json" 文档注释与跳转到字段
|
||
<li>支持 从配置文件获取外部注释用于文件夹、资源、COBOL 等
|
||
<li>修改配置：设置 -> 工具 -> // Show Comment Global/Project
|
||
</ul>
|
||
|
||
<h3>外部注释：</h3>
|
||
<a href="https://gitee.com/LinWanCen/show-comment/tree/main/src/test/java/io/github/linwancen/plugin/show/demo/ext">示例(Gitee)</a>
|
||
：比如你要给 .go 的文件配置文件注释可以放在相同目录或父目录的 xxx.go.tree.tsv 中
|
||
<ul>
|
||
<li>重新加载：工具 -> "🔄 // Reload External Comment"
|
||
<li>path/[any][filename.]ext.tree.tsv // 文件(夹)注释 📝 📁
|
||
<li>path/[any][filename.]ext.key.tsv // 切割关键字与注释
|
||
<li>path/[any][filename.]ext.doc.tsv // 词注释
|
||
<li>key.tsv 的每一行将会用`|`连接起来形成正则表达式，较长的关键字应该放在前面，用 `?` 开头排除
|
||
<li>doc 文件夹可以替换任何一层文件夹，可以像 SQL 那样用 % 模糊匹配，文件夹名为 -1 时在上一层文件夹生效
|
||
<li>在搜索弹出窗中修改 tsv 文件将不会被重加载
|
||
<li>tsv 配置文件必须能被搜索(Ctrl + Shift + N)
|
||
</ul>
|
||
|
||
如果对你有所帮助，别忘了给本项目
|
||
<a href="https://github.com/LinWanCen/show-comment">GitHub</a>
|
||
主页一个 Start，您的支持是项目前进的动力。
|
||
]]></description>
|
||
|
||
<!-- please see https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html
|
||
on how to target different products -->
|
||
<depends>com.intellij.modules.platform</depends>
|
||
<depends optional="true" config-file="java.xml">com.intellij.modules.java</depends>
|
||
<depends optional="true" config-file="sql.xml">com.intellij.database</depends>
|
||
<depends optional="true" config-file="js.xml">JavaScript</depends>
|
||
<depends optional="true" config-file="python.xml">com.intellij.modules.python</depends>
|
||
<depends optional="true" config-file="go.xml">org.jetbrains.plugins.go</depends>
|
||
<depends optional="true" config-file="kotlin.xml">org.jetbrains.kotlin</depends>
|
||
<!--suppress PluginXmlValidity, MybatisMapperXmlInspection -->
|
||
<!--<depends optional="true" config-file="cs.xml">com.intellij.modules.rider</depends>-->
|
||
|
||
<applicationListeners>
|
||
<listener class="io.github.linwancen.plugin.show.ext.conf.ConfFileListener"
|
||
topic="com.intellij.openapi.vfs.newvfs.BulkFileListener"/>
|
||
<listener class="io.github.linwancen.plugin.show.ext.conf.ConfFileChangeListener"
|
||
topic="com.intellij.openapi.fileEditor.FileEditorManagerListener"/>
|
||
</applicationListeners>
|
||
|
||
<projectListeners>
|
||
<listener class="io.github.linwancen.plugin.show.ext.conf.ConfFileInitListener"
|
||
topic="com.intellij.openapi.project.ProjectManagerListener"/>
|
||
</projectListeners>
|
||
|
||
<extensions defaultExtensionNs="com.intellij">
|
||
<editor.linePainter implementation="io.github.linwancen.plugin.show.LineEnd"/>
|
||
<projectViewNodeDecorator implementation="io.github.linwancen.plugin.show.Tree"/>
|
||
<defaultLiveTemplates file="/liveTemplates/show-comment-doc.xml"/>
|
||
<defaultLiveTemplates file="/liveTemplates/show-comment-xml.xml"/>
|
||
|
||
<applicationConfigurable parentId="tools"
|
||
instance="io.github.linwancen.plugin.show.settings.AppSettingsConfigurable"
|
||
id="io.github.linwancen.plugin.show.settings.AppSettingsConfigurable"
|
||
displayName="// Show Comment Global"/>
|
||
<applicationService serviceImplementation="io.github.linwancen.plugin.show.settings.AppSettingsState"/>
|
||
<projectConfigurable parentId="tools"
|
||
instance="io.github.linwancen.plugin.show.settings.ProjectSettingsConfigurable"
|
||
id="io.github.linwancen.plugin.show.settings.ProjectSettingsConfigurable"
|
||
displayName="// Show Comment Project"/>
|
||
<projectService serviceImplementation="io.github.linwancen.plugin.show.settings.ProjectSettingsState"/>
|
||
</extensions>
|
||
|
||
<actions>
|
||
<action
|
||
id="io.github.linwancen.plugin.show.ext.conf.ReLoadExtDocAction"
|
||
class="io.github.linwancen.plugin.show.ext.conf.ReloadExtDocAction"
|
||
text="🔄 // Reload External Comment">
|
||
<add-to-group group-id="ToolsMenu"/>
|
||
</action>
|
||
<action
|
||
id="io.github.linwancen.plugin.show.ext.conf.ResetExtDocAction"
|
||
class="io.github.linwancen.plugin.show.ext.conf.ResetExtDocAction"
|
||
text="🆑 // Clear External Comment">
|
||
<add-to-group group-id="ToolsMenu"/>
|
||
</action>
|
||
<action
|
||
id="io.github.linwancen.plugin.show.LineEndCopy"
|
||
class="io.github.linwancen.plugin.show.LineEndCopy"
|
||
text="// Copy With Line Comment">
|
||
<add-to-group group-id="EditorPopupMenu" anchor="after"
|
||
relative-to-action="CopyReference"/>
|
||
</action>
|
||
<action
|
||
id="io.github.linwancen.plugin.show.CopyReferenceSimple"
|
||
class="io.github.linwancen.plugin.show.CopyReferenceSimple"
|
||
text="Copy Class.Method / File:Line">
|
||
<add-to-group group-id="EditorPopupMenu" anchor="after"
|
||
relative-to-action="CopyReference"/>
|
||
</action>
|
||
<action
|
||
id="io.github.linwancen.plugin.show.LineEndAdd"
|
||
class="io.github.linwancen.plugin.show.LineEndAdd"
|
||
text="// Add Line Comment">
|
||
<add-to-group group-id="ProjectViewPopupMenu" anchor="last"/>
|
||
</action>
|
||
</actions>
|
||
</idea-plugin> |