SublimeLinter-html-tidy 使用教程

SublimeLinter-html-tidy 使用教程

SublimeLinter-html-tidySublimeLinter 3 plugin for html tidy.项目地址:https://gitcode.com/gh_mirrors/su/SublimeLinter-html-tidy

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

SublimeLinter-html-tidy 是一个用于 Sublime Text 的插件，用于通过 tidy 工具检查和格式化 HTML 代码。以下是该项目的目录结构：

SublimeLinter-html-tidy/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── linter.py
├── messages.json
└── ...

• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• linter.py: 核心文件，包含插件的主要逻辑。
• messages.json: 包含插件的错误和警告信息。

2. 项目的启动文件介绍

项目的启动文件是 linter.py，它包含了插件的主要逻辑。该文件定义了如何调用 tidy 工具来检查 HTML 代码，并处理返回的结果。

# linter.py 部分代码示例
from SublimeLinter.lint import Linter, util

class HTMLTidy(Linter):
    cmd = 'tidy -errors -quiet'
    regex = r'(?P<message>.+)'
    error_stream = util.STREAM_STDERR
    defaults = {
        'selector': 'text.html'
    }

• cmd: 定义了调用 tidy 工具的命令。
• regex: 定义了如何解析 tidy 工具的输出。
• error_stream: 指定错误信息的输出流。
• defaults: 插件的默认配置。

3. 项目的配置文件介绍

项目的配置文件主要是 messages.json 和 README.md。

messages.json

messages.json 文件包含了插件的错误和警告信息，这些信息会在检查 HTML 代码时显示给用户。

{
    "errors": {
        "missing_doctype": "Missing doctype declaration",
        "missing_closing_tag": "Missing closing tag"
    },
    "warnings": {
        "deprecated_attribute": "Deprecated attribute"
    }
}

README.md

README.md 文件是项目的说明文档，包含了安装、配置和使用插件的详细步骤。

# SublimeLinter-html-tidy

## 安装

1. 通过 Package Control 安装 SublimeLinter。
2. 通过 Package Control 安装 SublimeLinter-html-tidy。
3. 确保系统中安装了 `tidy` 工具。

## 配置

在 Sublime Text 的设置文件中添加以下配置：

```json
{
    "linters": {
        "htmltidy": {
            "selector": "text.html"
        }
    }
}

使用

打开一个 HTML 文件，SublimeLinter-html-tidy 会自动检查代码并显示错误和警告信息。

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

SublimeLinter-html-tidySublimeLinter 3 plugin for html tidy.项目地址:https://gitcode.com/gh_mirrors/su/SublimeLinter-html-tidy