Yaspeller 使用教程
1. 项目的目录结构及介绍
Yaspeller 是一个用于检查文本文件和网站中拼写错误的工具。以下是其基本目录结构:
yaspeller/
├── bin/
│ └── yaspeller
├── lib/
│ ├── check.js
│ ├── cli.js
│ ├── config.js
│ ├── index.js
│ ├── report.js
│ └── utils.js
├── test/
│ ├── fixtures/
│ └── test.js
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── yaspellerrc
bin/
: 包含可执行文件yaspeller
。lib/
: 包含主要的 JavaScript 文件,如check.js
、cli.js
等。test/
: 包含测试文件和测试数据。.editorconfig
,.eslintrc
,.gitignore
,.travis.yml
: 配置文件。LICENSE
: 许可证文件。package.json
: 项目依赖和脚本配置。README.md
: 项目说明文档。yaspellerrc
: 配置文件。
2. 项目的启动文件介绍
Yaspeller 的启动文件位于 bin/
目录下,名为 yaspeller
。这个文件是一个可执行脚本,用于启动 Yaspeller 工具。
#!/usr/bin/env node
require('../lib/cli').run();
这个脚本使用 Node.js 运行 lib/cli.js
文件中的 run
方法,启动 Yaspeller 的命令行界面。
3. 项目的配置文件介绍
Yaspeller 的配置文件名为 yaspellerrc
,可以是一个 JSON 文件或 JavaScript 文件。以下是一个示例配置:
{
"lang": "en,ru",
"excludeFiles": [
"**/node_modules/**",
"**/vendor/**"
],
"ignoreUrls": true,
"ignoreDigits": true,
"maxRequests": 5
}
lang
: 指定检查的语言,如en
表示英语,ru
表示俄语。excludeFiles
: 指定要排除的文件或目录。ignoreUrls
: 忽略 URL 地址。ignoreDigits
: 忽略包含数字的单词。maxRequests
: 同时向 Yandex Speller API 发送的请求数量。
通过这些配置,可以自定义 Yaspeller 的行为,以适应不同的检查需求。