eslint-plugin-doist
A collection of Doist ESLint rules.
Installation
You'll first need to install ESLint:
npm i eslint --save-dev
Next, install eslint-plugin-doist:
npm install eslint-plugin-doist --save-dev
Usage
Add doist to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
"plugins": [
"@doist/doist"
]
}
Supported Rules
Enforce only string literals as arguments to our i18n helpers _().
Enforce naming conventions when importing certain file types using ES6 modules.
Enforce only string literals as arguments to our static deployment tool $static_path.
Add a new rule
Use generator-eslint:
yo eslint:rule
Stick to the ESLint recomendations regarding working with rules and working with plugins.
关于 @doist/eslint-plugin-doist 的常见问题
@doist/eslint-plugin-doist 是什么？
A collection of Doist ESLint rules
如何安装 @doist/eslint-plugin-doist？
在项目目录运行 npm install @doist/eslint-plugin-doist，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（>=9）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@doist/eslint-plugin-doist 支持 TypeScript 吗？
该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/doist__eslint-plugin-doist 是否存在。
@doist/eslint-plugin-doist 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@doist/eslint-plugin-doist 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js ^22.14.0 || >= 24.10.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@doist/eslint-plugin-doist 可以商用吗？
@doist/eslint-plugin-doist 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@doist/eslint-plugin-doist 的下载量有多少？
根据 npm 官方下载统计，@doist/eslint-plugin-doist 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,146 次，日均约 105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@doist/eslint-plugin-doist 还在维护吗？
最新版本 2.0.1 发布于 2025/11/14（11 个月前）；至今共发布 6 个版本，其中过去 12 个月发布了 2 个；首次发布于 2019/06/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。