SublimeLinter-shellcheck 使用教程
1、项目的目录结构及介绍
SublimeLinter-shellcheck 项目的目录结构如下:
SublimeLinter-shellcheck/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── linter.py
└── messages.json
.gitignore
: 用于指定 Git 版本控制系统忽略的文件和目录。.travis.yml
: Travis CI 的配置文件,用于持续集成。LICENSE
: 项目的许可证文件,本项目采用 MIT 许可证。README.md
: 项目的说明文档,包含项目的基本信息和使用方法。linter.py
: 项目的主要启动文件,用于提供与 shellcheck 的接口。messages.json
: 包含一些消息和配置信息。
2、项目的启动文件介绍
项目的启动文件是 linter.py
,它提供了与 shellcheck 的接口。该文件主要负责以下功能:
- 初始化 linter 插件。
- 调用 shellcheck 进行代码检查。
- 处理检查结果并反馈给 Sublime Text 编辑器。
3、项目的配置文件介绍
项目的配置文件主要包括 SublimeLinter 的全局设置和 linter 的特定设置。
SublimeLinter 全局设置
全局设置的文档地址为:SublimeLinter 设置
Linter 特定设置
特定设置的文档地址为:Linter 设置
SublimeLinter-shellcheck 额外设置
SublimeLinter-shellcheck 提供了一些额外的设置选项:
exclude
: 一个逗号分隔的代码列表,用于排除某些检查。例如:"SC2034, SC2086"
或["SC2034", "SC2086"]
。
通过这些设置,用户可以根据自己的需求定制 shellcheck 的检查行为。
以上是 SublimeLinter-shellcheck 项目的使用教程,希望对您有所帮助。