维加林特
Vega 项目的 Eslint 插件
安装
你首先需要安装 ESLint 语录数字 :
npm i eslint --save-dev
下一个,安装 @globalpayments/eslint-plugin-vega-eslint数字 :
npm install @globalpayments/eslint-plugin-vega-eslint --save-dev
使用量
添加 @globalpayments/vega-eslint 到您的插件区 .eslintrc 配置文件 。 你可以省略这个 eslint-plugin- 前缀 :
{
"plugins": [
"@globalpayments/vega-eslint"
]
}
然后在规则章节下配置您想要使用的规则 .
{
"rules": {
"@globalpayments/vega-eslint/rule-name": 2
}
}
支持的规则
关于现有规则的全部清单,见:
- 文档数字 :
docs/rules/每项规则的详细描述和实例 - 来源数字 :
src/rules/——规则实施
测试
该插件包括一个由Vitest公司建造的综合测试套件. 测试确保所有规则正确运作,并保持高码覆盖.
运行测试
# Run all tests
npm test
# Run tests with coverage
npm run test:coverage
# Watch mode for development
npm run test:watch
关于测试指导,请参见测试文件 tests/rules/。 。 。 .
发展
构建
要构建软件包,请运行
npm run build
发布
自动( 建议)
每一次推(或合并PR) main 自动 :
- 弹出 补丁 版本在
package.json - 构建软件包
- 发布到 npm 注册
- 推动版本弹出承诺并给回标签
main
这是由 GitHub 动作工作流程驱动的 .github/workflows/publish.yml。 。 。 .
先决条件 - 在其中添加以下寄存器密钥:
设置 – 秘密和变量 – 动作数字 :
秘诀 说明 NPM_TOKEN_GLOBALPAYMENTSnpm 格拉纳访问 调用 读写 允许范围到 @globalpayments/eslint-plugin-vega-eslint
盘旋 - npm Granular 访问 插件过期于 90天时间 (最大数).
设置日历提醒, 每~80天旋转一个符号 :
- 生成新符号 :
npm token create --name "vega-eslint-ci" --expires 90 --packages "@globalpayments/eslint-plugin-vega-eslint" --packages-and-scopes-permission read-write --bypass-2fa- 更新
NPM_TOKEN_GLOBALPAYMENTS隐藏在 GitHub 中 设置 – 秘密和变量 – 动作- 撤销旧的标志:
npm token revoke <old-token-id>