EditorConfig Sublime 插件使用教程

EditorConfig Sublime 插件使用教程

editorconfig-sublimeSublime Text plugin for EditorConfig - Helps developers maintain consistent coding styles between different editors项目地址:https://gitcode.com/gh_mirrors/ed/editorconfig-sublime

1. 项目的目录结构及介绍

EditorConfig Sublime 插件的 GitHub 仓库目录结构如下：

editorconfig-sublime/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── messages/
│   └── welcome.txt
├── plugin/
│   ├── __init__.py
│   ├── editorconfig.py
│   ├── editorconfig_core.py
│   ├── editorconfig_exceptions.py
│   ├── editorconfig_handler.py
│   ├── editorconfig_properties.py
│   └── editorconfig_settings.py
├── sublime-project
└── sublime-workspace

• CHANGELOG.md: 记录项目的更新日志。
• CONTRIBUTING.md: 指导如何为项目贡献代码。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• messages/: 包含插件的欢迎消息。
• plugin/: 包含插件的核心代码文件。
• sublime-project 和 sublime-workspace: Sublime Text 的项目和 workspace 文件。

2. 项目的启动文件介绍

EditorConfig Sublime 插件的启动文件位于 plugin/__init__.py。这个文件是插件的入口点，负责初始化和加载插件的其他模块。

# plugin/__init__.py

import sublime
import sublime_plugin

from .editorconfig_handler import EditorConfigHandler

def plugin_loaded():
    EditorConfigHandler.setup()

def plugin_unloaded():
    EditorConfigHandler.teardown()

• plugin_loaded(): 当插件被加载时调用，初始化插件。
• plugin_unloaded(): 当插件被卸载时调用，清理资源。

3. 项目的配置文件介绍

EditorConfig Sublime 插件的配置文件是 .editorconfig 文件，它定义了代码风格的规则。这个文件通常位于项目的根目录。

一个典型的 .editorconfig 文件内容如下：

# .editorconfig

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

• root: 表示这是项目的根目录。
• [*]: 适用于所有文件的通用配置。
• indent_style: 缩进风格（space 或 tab）。
• indent_size: 缩进大小。
• end_of_line: 行尾字符（lf、cr 或 crlf）。
• charset: 字符集（utf-8 等）。
• trim_trailing_whitespace: 是否去除行尾空格。
• insert_final_newline: 文件末尾是否插入空行。
• [*.md]: 适用于 Markdown 文件的特殊配置。

通过这些配置，EditorConfig 插件可以确保在不同的编辑器和 IDE 中保持一致的代码风格。

editorconfig-sublimeSublime Text plugin for EditorConfig - Helps developers maintain consistent coding styles between different editors项目地址:https://gitcode.com/gh_mirrors/ed/editorconfig-sublime