又怕你用错单词?retext-wordusage 给你帮助!npm 包 retext-wordusage 是一个用于检查英文单词使用的命令行工具和库,它可以帮助你发现文章中的单词使用错误并提醒你进行修正。
安装
你可以通过 npm 来安装 retext-wordusage。
npm install retext-wordusage
安装后,你可以在 CLI 中使用 retext-wordusage 命令行工具以及在 JavaScript 中使用 retext-wordusage 库。
使用
命令行使用
retext-wordusage 命令行工具支持使用输入文件,输出结果到 CLI 和 JSON 文件。以下是一个使用 retext-wordusage 检查文本中单词使用错误并输出 JSON 文件的示例:
retext-wordusage input.txt --json > output.json
output.json 的内容类似于:
-- -------------------- ---- ------- - ----------- - - -------- ------ ------- -- --------- -- -------- -- --------- -------------- ----------- -- --------- ------------------- ---------- ---------------- --- ---------- --------- --------- ----------- --------- ------- ---- - -- ------- - --------- -------- - -
JavaScript 使用
retext-wordusage 也可以在 JavaScript 中使用。以下是一个使用 retext-wordusage 库检查文本中单词使用错误并输出结果的示例:
const retext = require('retext'); const wordUsage = require('retext-wordusage'); retext() .use(wordUsage) .process('There will have an affect on the economy.', (err, file) => { console.log(String(file)); });
输出结果为:
1:11-1:17 warning 可能使用词语:’affect‘ 而不是 ’effect‘ word-choice ⚠ 1 warning
配置
retext-wordusage 支持自定义词典和配置。
自定义词典
你可以使用一个 JSON 格式的词典来指定已知词汇,以避免出现错误警报。需要将自定义词典指定为对象的 words
属性。
-- -------------------- ---- ------- ----- ------ - ------------------ ----- --------- - ---------------------------- ----- ----- - ------------------------------------ -------- --------------- - ----- -- --------------- ---- --- ------- -- - ------ ----- ----- -- - -------------------------- ---
custom-dictionary.json 示例:
{ "words": { "ran aground": true, "on a": true, "reef": true } }
自定义配置
retext-wordusage 支持自定义配置,包括忽略指定单词、将警告转换为错误等。需要将自定义配置指定为对象的 config
属性。
-- -------------------- ---- ------- ----- ------ - ------------------ ----- --------- - ---------------------------- ----- ------ - - ------- ---------- ---------- --------- ------- -- -------- --------------- - ------ -- --------------- --- --- ------- -- -- -------- ----- ----- -- - -------------------------- ---
配置项:
severity
: 警告级别,默认是 'warning'。ignore
: 忽略指定单词。spelling
: 单词拼写检查。
结论
通过 retext-wordusage ,你可以检查文本中单词使用错误并快速地纠正它们。同时,你也可以自定义词典和配置,以满足你的特定需求。适用于博客、新闻、发布稿等具有一定篇幅的英文文章的检查。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600557fb81e8991b448d5154