littlebot
Published on 2025-04-18 / 0 Visits
0

【源码】基于TypeScript的ESLint国际化检查插件

项目简介

本项目是基于TypeScript编写的ESLint插件,具备一系列适用于Vue、TypeScript和JavaScript文件的ESLint规则。能助力开发者规范代码中国际化函数的使用,检测不合法调用方式,且提供自动修复功能,提高代码质量与国际化使用的规范性。

项目的主要特性和功能

  1. 多规则支持:提供no-consolei18n-usagei18n-message-usageconfig-schema-no-raw-texti18n-usage-vuei18n-no-raw-text等规则,可对控制台输出、国际化函数调用、消息使用、对象字面量纯字符串等多方面进行检测。
  2. 自动修复:部分规则(如i18n-usage)支持自动修复,能对不合法的国际化函数调用自动修正,优化用户体验。
  3. 单元测试:使用jest进行单元测试,测试覆盖率接近100%,保障插件开发质量。
  4. 项目规范:配置husky + commitlint、ESLint,确保提交代码符合规范。
  5. 灵活构建:通过构建脚本scripts/build.ts让构建过程更灵活。

安装使用步骤

安装依赖

bash npm install -D @hans774882968/eslint-plugin-use-i18n yarn add -D @hans774882968/eslint-plugin-use-i18n

配置.eslintrc.js

js module.exports = { plugins: [ '@hans774882968/use-i18n', ], extends: [ 'plugin:@hans774882968/use-i18n/all', ], rules: { '@hans774882968/use-i18n/i18n-usage': ['error', { i18nFunctionNames: ['$i18n', '$t'], }], } }

运行检查

运行yarn linteslint命令,即可用规则对代码进行校验。

注意事项

为支持Vue文件解析,需确保parserparserOptions正确配置。若项目同时包含Vue和TypeScript文件,可使用vue-eslint-parser作为parser,并在parserOptions中指定@typescript-eslint/parser作为parser

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】