i18n-easy 1.0.0

package/types/eslint/vue/i18n_easy_plugin.d.ts

@@ -0,0 +1,5 @@
+import type { ESLint } from 'eslint';
+import { BaseCodeType, TextNode } from '../../type.js';
+export type CollectNodes = (textNode: TextNode, codeType: Extract<BaseCodeType, 'js' | 'jsx' | 'script' | 'template'>) => void;
+declare const VuePlugin: ESLint.Plugin;
+export default VuePlugin;

package/types/eslint/vue/i18n_utils.d.ts

@@ -0,0 +1,65 @@
+import type { Rule } from 'eslint';
+import type { AST } from 'vue-eslint-parser';
+import * as ESTree from 'estree';
+import { TextNode, SetUpNode, CodeType } from '../../type.js';
+/**
+ * @description 创建i18n-ignore注释检查器
+ * @param context - ESLint规则上下文
+ * @param templateBody - Vue模板体节点
+ * @returns 检查节点是否被忽略的函数
+ */
+export declare function createI18nIgnoreChecker(context: Rule.RuleContext, templateBody: AST.VElement & AST.HasConcreteInfo): (node: any) => boolean;
+/**
+ * @description 判断能否注入
+ * @param context - ESLint规则上下文
+ * @param node - Program节点、FunctionExpression节点、ArrowFunctionExpression节点
+ * @param codeType - 代码类型
+ * @returns 是否能注入
+ */
+export declare function callNameNotExist(context: Rule.RuleContext, node: SetUpNode, codeType: Exclude<CodeType, 'template'>): boolean;
+/**
+ *  1、不存在节点返回null
+ *  2、存在import节点，返回最后一个import节点
+ *  3、不存在import节点，返回第一个非import节点
+ * @description 获取最后一个 import 或第一个非 import 节点
+ * @param context - ESLint规则上下文
+ * @returns 最后一个 import 节点或第一个非 import 节点或 null
+ */
+export declare function getLastImportOrFirstNotImportNode(context: Rule.RuleContext): {
+    node: ESTree.Node;
+    type: string;
+} | null;
+/**
+ * @description 获取hooks注入节点
+ * @param context - ESLint规则上下文
+ * @param node - BlockStatement节点或Program节点
+ * @returns 注入节点或null
+ */
+export declare function getInjectNode(context: Rule.RuleContext, node: ESTree.BlockStatement | ESTree.Program): ESTree.Comment | ESTree.ModuleDeclaration | ESTree.Statement;
+/**
+ *  判断能否收集操作节点
+ *  排除：
+ *      1、使用@i18n-ignore注释的节点
+ *      2、未使用中文的节点
+ * @description 判断能否收集操作节点
+ * @param node - TextNode节点
+ * @param isIgnored - 判断节点是否被忽略的函数
+ * @returns 是否能收集操作节点
+ */
+export declare function canCollectOperateNodes(node: TextNode, isIgnored: (n: TextNode) => boolean): boolean;
+/**
+ * @description 获取节点前的空格
+ * @param context - ESLint规则上下文
+ * @param node - 节点
+ * @returns 节点前的空格
+ */
+export declare function getLeadingSpaces(context: Rule.RuleContext, node: ESTree.Node | ESTree.Comment): string;
+/**
+ * @description 获取国际化调用方法
+ * @param callMethodName - 国际化调用方法
+ * @param key - 国际化键值
+ * @param value - 国际化参数
+ * @returns 国际化调用方法
+ */
+export declare function getI18nCallMethod(callMethodName: string, key: string, value?: string): string;
+export declare function isScriptSetup(context: Rule.RuleContext): boolean;

package/types/eslint/vue/report_and_fix.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint';
+import { CollectListType } from '../../type.js';
+/**
+ * @description 批量执行修复函数 根据收集到节点生成修复函数并执行
+ * @param context - 规则上下文
+ * @param state - 收集到的节点信息
+ */
+export declare function batchFixAll(context: Rule.RuleContext, state: CollectListType): void;

package/types/file_processor_utils.d.ts

@@ -0,0 +1,14 @@
+import { BaseCodeType } from './type.js';
+type LangFileType = Extract<BaseCodeType, 'json' | 'js' | 'ts'>;
+export declare function getModifiedFiles(): Promise<string[]>;
+export declare function readFile(filePath: string): Promise<string>;
+export declare function getFileType(filePath: string): string;
+export declare function writeFile(filePath: string, content: string): Promise<void>;
+export declare function fileExists(filePath: string): Promise<boolean>;
+export declare function writeI18nFile(filePath: string, content: Record<string, string>): Promise<void>;
+export declare function getFileContent(filePath: string, fileType: LangFileType): Promise<{
+    exportPrefix: string;
+    code: any;
+}>;
+export declare function isDescendant(file: string, dir: string): boolean;
+export {};

package/types/i18n_easy.d.ts

@@ -0,0 +1,77 @@
+import { Framework, I18nInfoType, KeyType, ReactCollectItemType, ReactI18nInfoType, TextNode } from './type.js';
+import type { Rule } from 'eslint';
+interface FileToI18nConfig<T extends Framework> {
+    type: T;
+    keyType?: KeyType;
+    i18nInfo: T extends 'vue' ? I18nInfoType : ReactI18nInfoType;
+    customIgnore?: (node: T extends 'vue' ? TextNode : ReactCollectItemType['textNode'], context: Rule.RuleContext) => boolean;
+}
+interface FileToI18nAndTranslateConfig<T extends Framework> extends FileToI18nConfig<T> {
+    lang: string[];
+    apiKey: string;
+}
+export declare class I18nEasy {
+    /**
+     * vue框架中将文件内容转换成i18n写法并翻译
+     * @param filePath 文件绝对路径
+     * @param options 配置项
+     */
+    private fileToI18nVue;
+    /**
+     * react框架中将文件内容转换成i18n写法并翻译
+     * @param filePath 文件绝对路径
+     * @param options 配置项
+     */
+    private fileToI18nReact;
+    /**
+     * 将文件内容转换成i18n写法
+     * @param filePath 文件绝对路径
+     * @param options 配置项
+     */
+    fileToI18n<T extends Framework>(filePath: string, options: FileToI18nConfig<T>): Promise<{
+        newFileContent: string;
+        fixed: boolean;
+        filePath: string;
+        oldFileContent: string;
+        keyValueMap: [string, string][];
+    }>;
+    /**
+     * 将文件内容转换成i18n写法并翻译
+     * @param filePath 文件绝对路径
+     * @param options 配置项
+     */
+    fileToI18nAndTranslate<T extends Framework>(filePath: string, options: FileToI18nAndTranslateConfig<T>): Promise<{
+        translateResult: Record<string, Record<string, string>>;
+        newFileContent: string;
+        fixed: boolean;
+        filePath: string;
+        oldFileContent: string;
+        keyValueMap: [string, string][];
+    }>;
+    /**
+     * 将文件内容转换成i18n写法并翻译，支持批量
+     * @param filePath 文件绝对路径
+     * @param options 配置项
+     */
+    fileToI18nAndTranslateBatch<T extends Framework>(filePaths: string[], options: FileToI18nAndTranslateConfig<T>): Promise<{
+        transformResult: {
+            newFileContent: string;
+            fixed: boolean;
+            filePath: string;
+            oldFileContent: string;
+            keyValueMap: [string, string][];
+        }[];
+        translateResult: Record<string, Record<string, string>>;
+    }>;
+    /**
+     * @description 获取需要处理的文件信息
+     * @returns 文件信息
+     */
+    private getPendingFiles;
+    /**
+     * @description 对git暂存区的文件进行i18n转换和翻译 并将翻译结果写入语言文件
+     * @returns {Promise<void>}
+     */
+    transformModifiedFiles(): Promise<void>;
+}
+export {};

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export { I18nEasy } from './i18n_easy.js';
+export { progressBus } from './progressBus.js';
+export { defineConfig } from './utils.js';
+export type { LogStatus } from './type.js';

package/types/key_map.d.ts

@@ -0,0 +1,14 @@
+import { KeyType } from './type.js';
+export default class KeyMap {
+    private charMap;
+    private keyType;
+    private static instance;
+    private constructor();
+    static getInstance(): KeyMap;
+    get charList(): Map<string, string>;
+    generateKey(str: string): string;
+    clearCharMap(): void;
+    setCharMap(key: string, value: string): void;
+    isEmpty(): boolean;
+    setKeyType(type: KeyType): void;
+}

package/types/progressBus.d.ts

@@ -0,0 +1,6 @@
+import { EventEmitter } from 'events';
+import { LogStatus } from './type.js';
+/** 全局单例事件总线 */
+export declare const progressBus: EventEmitter<[never]>;
+/** 内部通用日志函数：既 console.log，也 emit */
+export declare function log(msg: string, status: LogStatus): void;

package/types/translate.d.ts

@@ -0,0 +1,34 @@
+export default class Translate {
+    private endpoint;
+    private apiKey;
+    private static instance;
+    private constructor();
+    static getInstance(): Translate;
+    /**
+     * 构建微软翻译API请求配置
+     * @param originalTextArr 原始文本数组，每个元素为{ text: string }
+     * @param lang 目标语言数组
+     * @returns
+     */
+    private buildRequestConfig;
+    /**
+     * 处理微软翻译API响应数据
+     * @param responseData 翻译API响应数据，每个元素为{ translations: { text: string }[] }
+     * @param originalTextArr 原始文本数组，每个元素为[ key: string, text: string ]
+     * @param lang 目标语言数组
+     * @returns 翻译结果，格式为{ language: { key: text } }
+     */
+    private processResponse;
+    /**
+     * 翻译中文为其他指定语言
+     * @param originalTextArr 原始文本数组，每个元素为[ key: string, text: string ]
+     * @param lang 目标语言数组
+     * @returns 翻译结果，格式为{ language: { key: text } }
+     */
+    translate(originalTextArr: [string, string][], lang: string[]): Promise<Record<string, Record<string, string>>>;
+    /**
+     * 设置微软翻译API密钥
+     * @param apiKey 微软翻译API密钥
+     */
+    setApiKey(apiKey: string): void;
+}

package/types/type.d.ts

@@ -0,0 +1,94 @@
+import type { AST } from 'vue-eslint-parser';
+import * as ESTree from 'estree';
+import type { Rule } from 'eslint';
+export type Framework = 'vue' | 'react';
+export type BaseCodeType = 'vue' | 'js' | 'jsx' | 'ts' | 'tsx' | 'json' | 'template' | 'script' | 'scriptSetup';
+export interface SupportFileMap {
+    vue: Extract<BaseCodeType, 'vue' | 'js' | 'jsx' | 'ts' | 'tsx'>;
+    react: Extract<BaseCodeType, 'js' | 'jsx' | 'ts' | 'tsx'>;
+}
+export interface I18nInfoType {
+    template?: {
+        callMethodName: string;
+    };
+    script?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+    };
+    scriptSetup?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+        injectHooksCall?: string;
+    };
+    js?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+    };
+    jsx?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+    };
+}
+export interface LangType {
+    name: string;
+    i18nFilePath: string;
+}
+export interface JSXText extends ESTree.BaseNode, ESTree.BaseExpression {
+    type: 'JSXText';
+    value: string;
+    raw: string | undefined;
+}
+export type TextNode = AST.VText | AST.VAttribute | ESTree.TemplateLiteral | (ESTree.Literal & Rule.NodeParentExtension) | JSXText;
+export type TextNodeType = 'VText' | 'VAttribute' | 'TemplateLiteral' | 'Literal' | 'JSXText';
+export type SetUpNode = ESTree.FunctionExpression | ESTree.ArrowFunctionExpression | ESTree.Program | null;
+export type CodeType = Extract<BaseCodeType, 'js' | 'jsx' | 'script' | 'scriptSetup' | 'template'>;
+interface CollectItemType {
+    textNode: TextNode;
+    codeType: Extract<BaseCodeType, 'js' | 'jsx' | 'script' | 'template'>;
+    setUpNode: SetUpNode;
+    inSetup: boolean;
+}
+export interface CollectListType {
+    templateTextNodeList: CollectItemType[];
+    scriptTextNodeList: CollectItemType[];
+    jsTextNodeList: CollectItemType[];
+    jsxTextNodeList: CollectItemType[];
+}
+export interface NodeListener extends Rule.NodeListener {
+    VText: (node: AST.VText) => void;
+    VAttribute: (node: AST.VAttribute) => void;
+    JSXText: (node: JSXText) => void;
+    [key: string]: ((...args: any[]) => void) | undefined;
+}
+export interface ReactCollectItemType {
+    textNode: ESTree.TemplateLiteral | (ESTree.Literal & Rule.NodeParentExtension) | JSXText;
+    componentNode: ESTree.FunctionDeclaration | ESTree.VariableDeclarator | null;
+    programNode: ESTree.Program | null;
+    inComp: boolean;
+}
+export interface ReactCollectListType {
+    inComponent: ReactCollectItemType[];
+    outComponent: ReactCollectItemType[];
+}
+export type ReactInjectCodeType = ESTree.FunctionDeclaration | ESTree.VariableDeclarator | ESTree.Program;
+export interface ReactI18nInfoType {
+    js?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+    };
+    jsx?: {
+        callMethodName: string;
+        injectImport?: string;
+        injectCodeToTopLevel?: string;
+        injectHooksCall?: string;
+    };
+}
+export type ReactCodeType = Extract<BaseCodeType, 'js' | 'jsx'>;
+export type LogStatus = 'success' | 'info' | 'fail';
+export type KeyType = 'hash' | 'pinyin' | 'pinyinWithNumber';
+export {};

package/types/utils.d.ts

@@ -0,0 +1,54 @@
+import { Framework, SupportFileMap, KeyType, LangType, I18nInfoType, ReactI18nInfoType, TextNode, ReactCollectItemType } from './type.js';
+import type { Rule } from 'eslint';
+export interface Config<T extends Framework> {
+    projects: {
+        projectPath: string;
+        lang: LangType[];
+        i18nInfo: T extends 'vue' ? I18nInfoType : ReactI18nInfoType;
+        keyType: KeyType;
+        type: T;
+        customIgnore?: (node: T extends 'vue' ? TextNode : ReactCollectItemType['textNode'], context: Rule.RuleContext) => boolean;
+    }[];
+    apiKey: string;
+}
+/**
+ * @description 判断字符串是否包含中文
+ * @param str 字符串
+ * @returns {boolean} 是否包含中文
+ */
+export declare function hasChineseChar(str: string | undefined | null): boolean;
+/**
+ * @description 生成对应字符串的 hash 值或拼音值
+ * @param char 字符串
+ * @param keyType 键类型
+ * @returns {string} hash 值或拼音值
+ */
+export declare function generateKeyByKeyType(char: string, keyType: KeyType): string;
+/**
+ * @description 判断是否为vue文件的script src导入
+ * @param filePath 文件路径
+ * @param fileType 文件类型
+ * @returns {Promise<boolean>} 是否为vue文件的script src导入
+ */
+export declare function isVueScriptSrcImport(filePath: string, fileType: string): Promise<boolean>;
+/**
+ * @description 判断文件类型是否支持转换
+ * @param fileType 文件类型
+ * @param framework 框架类型
+ * @returns {boolean} 是否支持转换
+ */
+export declare function isSupportFileType<F extends Framework>(fileType: string, framework: F): fileType is SupportFileMap[F];
+/**
+ * @description 在指定目录下查重指定名称文件，并加载文件导出内容
+ * @param dirPath 目录路径
+ * @param searchPlaces 文件名称列表
+ * @returns {Promise<any | null>} 文件内容
+ */
+export declare function searchFileContent<T extends Framework>(dirPath: string, searchPlaces: string[]): Promise<Config<T> | null>;
+/**
+ * @description 配置辅助函数
+ * @param config  配置项
+ * @returns 配置项
+ */
+export declare function defineConfig<T extends Framework>(config: Config<T>): Config<T>;
+export declare function customTranslation(source: string, translation: string): string;