Proofreader 项目教程

Proofreader 项目教程

Proofreader Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling). 项目地址: https://gitcode.com/gh_mirrors/pr/Proofreader

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

Proofreader 项目的目录结构如下：

Proofreader/
├── bin/
│   └── (各种可执行文件)
├── dictionaries/
│   └── (词典文件)
├── lib/
│   └── (库文件)
├── specs/
│   └── (测试文件)
├── .editorconfig
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── settings.json
├── test.html
└── test.md

目录结构介绍

• bin/: 包含项目的可执行文件。
• dictionaries/: 包含项目的词典文件，用于拼写检查。
• lib/: 包含项目的库文件，用于实现核心功能。
• specs/: 包含项目的测试文件，用于测试项目的功能。
• .editorconfig: 配置文件，用于统一代码风格。
• .gitignore: 配置文件，指定 Git 忽略的文件和目录。
• .travis.yml: 配置文件，用于 Travis CI 的持续集成。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文件，包含项目的基本信息和使用方法。
• package-lock.json: 锁定项目依赖的版本。
• package.json: 项目的配置文件，包含项目的依赖和脚本。
• settings.json: 项目的配置文件，包含自定义配置选项。
• test.html: 测试文件，用于测试 HTML 文件的校对功能。
• test.md: 测试文件，用于测试 Markdown 文件的校对功能。

2. 项目的启动文件介绍

Proofreader 项目的启动文件主要是通过 package.json 中的脚本来执行。以下是 package.json 中的一些关键脚本：

{
  "scripts": {
    "start": "node bin/proofreader",
    "test": "mocha specs/"
  }
}

启动文件介绍

• start: 该脚本用于启动 Proofreader 项目。执行 npm start 命令时，会调用 node bin/proofreader 来启动项目。
• test: 该脚本用于运行项目的测试。执行 npm test 命令时，会调用 mocha specs/ 来运行测试文件。

3. 项目的配置文件介绍

Proofreader 项目的主要配置文件是 settings.json，该文件用于配置项目的自定义选项。以下是 settings.json 的一个示例：

{
  "dictionaries": {
    "build-in": ["en_US", "en_GB"],
    "custom": ["devtools-docs.dic"]
  },
  "selectors": {
    "whitelist": "p, li, h1, h2, h3, h4, th, td, dl, figcaption",
    "blacklist": "pre, code"
  },
  "write-good": {
    "weasel": false
  }
}

配置文件介绍

• dictionaries: 配置词典选项。
  • build-in: 指定内置词典，支持 en_US 和 en_GB。
  • custom: 指定自定义词典文件。
• selectors: 配置 CSS 选择器选项。
  • whitelist: 指定需要处理的 HTML 元素。
  • blacklist: 指定需要排除的 HTML 元素。
• write-good: 配置 write-good 库的选项。
  • weasel: 配置是否启用 weasel 检查。

通过这些配置文件，用户可以根据自己的需求自定义 Proofreader 项目的行为。

Proofreader Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling). 项目地址: https://gitcode.com/gh_mirrors/pr/Proofreader