SublimeLinter-pep8 插件使用教程
1. 项目的目录结构及介绍
SublimeLinter-pep8 是一个用于 Sublime Text 3 的插件,用于检查 Python 代码的 PEP8 规范。以下是该项目的目录结构:
SublimeLinter-pep8/
├── README.md
├── sublime_linter.py
├── sublime_linter_plugin.py
├── sublime_linter_util.py
├── sublime_linter_config.py
└── ...
README.md
: 项目说明文档。sublime_linter.py
: 主启动文件。sublime_linter_plugin.py
: 插件核心逻辑。sublime_linter_util.py
: 工具函数。sublime_linter_config.py
: 配置文件处理。
2. 项目的启动文件介绍
sublime_linter.py
是项目的启动文件,负责初始化和加载插件。以下是该文件的主要功能:
import sublime
import sublime_plugin
from .sublime_linter_plugin import SublimeLinterPlugin
class SublimeLinter(sublime_plugin.EventListener):
def on_post_save(self, view):
plugin = SublimeLinterPlugin(view)
plugin.lint()
on_post_save
: 在文件保存后触发,调用SublimeLinterPlugin
进行代码检查。
3. 项目的配置文件介绍
配置文件位于 Sublime Text 的设置中,可以通过 Preferences -> Package Settings -> SublimeLinter -> Settings
进行编辑。以下是一个示例配置:
{
"linters": {
"pep8": {
"@disable": false,
"args": [],
"excludes": [],
"ignore": "",
"max-line-length": null,
"select": ""
}
}
}
@disable
: 是否禁用该 linter。args
: 传递给 pep8 的额外参数。excludes
: 排除检查的文件或目录。ignore
: 忽略的错误代码。max-line-length
: 最大行长度。select
: 选择的错误代码。
以上是 SublimeLinter-pep8 插件的基本使用教程,希望对你有所帮助。