开源项目 TrailingSpaces 使用教程

开源项目 TrailingSpaces 使用教程

TrailingSpacesHighlight trailing spaces and delete them in a flash.项目地址:https://gitcode.com/gh_mirrors/tr/TrailingSpaces

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

TrailingSpaces 项目的目录结构如下：

TrailingSpaces/
├── README.md
├── TrailingSpaces.sublime-settings
├── TrailingSpaces.py
├── main.py
├── utils/
│   ├── __init__.py
│   └── helper.py
└── tests/
    ├── __init__.py
    └── test_trailing_spaces.py

目录结构介绍

• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• TrailingSpaces.sublime-settings: 项目的配置文件，用于自定义插件的行为。
• TrailingSpaces.py: 项目的主文件，包含插件的主要逻辑。
• main.py: 项目的启动文件，用于启动插件。
• utils/: 工具模块，包含辅助函数和类。
• tests/: 测试模块，包含项目的单元测试。

2. 项目的启动文件介绍

项目的启动文件是 main.py，其主要功能是初始化插件并启动插件的主要逻辑。

main.py 文件内容

import TrailingSpaces

def main():
    TrailingSpaces.init()

if __name__ == "__main__":
    main()

启动文件介绍

• main.py 文件导入了 TrailingSpaces 模块，并调用了 init 方法来初始化插件。
• 当运行 main.py 文件时，会执行 main 函数，从而启动插件。

3. 项目的配置文件介绍

项目的配置文件是 TrailingSpaces.sublime-settings，其主要功能是定义插件的行为和选项。

TrailingSpaces.sublime-settings 文件内容

{
    "highlight_current_line": true,
    "trim_on_save": false,
    "live_matching": true,
    "ignore_syntax": false,
    "highlight_color": "invalid",
    "include_empty_lines": false,
    "modified_lines_only": false
}

配置文件介绍

• highlight_current_line: 是否高亮当前编辑行中的尾部空格。
• trim_on_save: 是否在保存文件时自动删除尾部空格。
• live_matching: 是否实时匹配尾部空格。
• ignore_syntax: 是否忽略特定语法中的尾部空格。
• highlight_color: 高亮尾部空格的颜色。
• include_empty_lines: 是否包含空行中的尾部空格。
• modified_lines_only: 是否仅删除修改过的行中的尾部空格。

以上是 TrailingSpaces 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

TrailingSpacesHighlight trailing spaces and delete them in a flash.项目地址:https://gitcode.com/gh_mirrors/tr/TrailingSpaces