CommentShell
CommentShell(CSL)一个能够在正文中运行shell命令的intellij插件。
其能够帮忙开发者疾速在文件内执行指定命令,而不须要在终端去敲打shell命令, 如:开发golang的grpc服务时,咱们须要用protoc工具生成pb.go,传统做法是编写完proto文件后在关上终端输出shell命令去生成pb文件,
然而当初,你能够用CLS去代替传统做法进步你的开发效率,只须要在单行正文中以x:generate结尾, 前面跟上你须要执行的shell命令即可,如:我冀望通过shell命令打印 hello proto
,
你能够通过 //x:generate echo hello proto
这样一行单行正文即可实现
反对的语言
- .gitignore
- Antlr(g4)
- Api(go-zero)
- Dart
- Dockerfile
- Drools
- Gherkin
- Gradle
- Groovy
- Html
- Java
- JavaScript
- JFlex
- JSPX
- Kotlin
- Lua
- Markdown
- Perl
- PHP
- Properties
- Proto
- Python
- R
- React
- Ruby
- Rust
- Scala
- SQl
- TypeScript
- Vue
- XML
- YAML
以上语言或者文件曾经通过测试,除此外,只有编程语言或者某类型文件反对单行正文语法且指定单行正文类型和语法书写标准实践均可应用(见下文)。
装置形式
形式一: 下载地址
形式二: intellij plugin仓库搜寻 CommentShell
install即可,plugin商店还在审核中。
反对的正文类型
-
Java格调单行正文
//x:generate echo hello java
-
Yaml格调单行正文
#x:generate echo hello yaml
-
SQL格调单行正文
--x:generate echo hello sql
-
xml/html格调单行正文
<!--x:generate echo hello xml-->
书写规定
格局
[linePrefix]x:generate [arg...] [lineSuffix]
linePrefix
为单行正文开始标记,仅反对//
,#
,--
,<!--
lineSuffix
为单行正文完结标记,仅反对-->
此为html/xml格调单行正文特有x:generate
为关键字
留神
- linePrefix与
x:generate
之间不能有任何其余内容
常量
%DIR%
代表以后文件的文件目录,如:/foo/bar
%FILENAME%
代表以后文件门路,如:/foo/bar/foobar.txt
%PERCENT_SIGN%
代表百分号符号自身%"%BASE%"
代表以后文件名称,如:foobar.txt
示例
-
在Java文件正文中输入
hello java
//x:generate echo hello java
output:
hello java
-
在proto文件中生成pb.go
//x:generate protoc --go_out=plugins=grpc:. %FILENAME%
-
在Java代码中输入
PATH
环境变量值//x:generate echo $PATH
点击这里查看各支流编程语言的shell写法。