Merge pull request #417 from alibaba/feat/mx/394

feat: #394 支持自定义翻译文件的生成路径

Author: z979054461

docs/pontConfig.md

@@ -22,6 +22,7 @@
 | usingOperationId | 使用operationId作为方法名 | `boolean` | `true` |
 | usingMultipleOrigins | pont 支持一个项目中配置多个 Swagger 来源。此处配置是否启用多数据源 | `boolean` | `false` |
 | baiduTranslateConfigs | pont内置多种翻译引擎，用于转换非法类名（如包含特殊字符或者中文）。填写了此配置将优先使用百度开放翻译引擎。需填写APP_ID和APP_SECRET,详见https://fanyi-api.baidu.com/product/113 | `Array<{appId:string,appSecret:string}>` | null |
+| translatePath | 自定义翻译文件的生成路径,包含文件名（使用相对路径指定）| `string` | `"node_modules/.pont/translate-dict.txt"` |
 
 
 ## origins 配置项

packages/pont-engine/src/compatible/Config.ts

@@ -5,6 +5,7 @@ import { IBaiduTranslateConfig, OriginType, Surrounding } from '../types/pontCon
 import { getTemplate } from '../utils/templateHelp';
 import { defaultFetchMethodCode, defaultTransformCode } from '../constants/defaultCode';
 import { Mocks } from './Mocks';
+import { LOCAL_DICT_DIR, TRANSLATE_DICT_NAME } from '../constants';
 
 /** @deprecated */
 export class DataSourceConfig {
@@ -29,6 +30,8 @@ export class DataSourceConfig {
   mocks = new Mocks();
   customTemplatePath: string;
   baiduTranslateConfigs: Array<IBaiduTranslateConfig> = null;
+  /** 指定翻译文件的生成路径（相对路径） */
+  translatePath = `${LOCAL_DICT_DIR}/${TRANSLATE_DICT_NAME}`;
 
   constructor(config: DataSourceConfig) {
     Object.keys(config).forEach((key) => {

packages/pont-engine/src/compatible/scripts/base.ts

@@ -30,7 +30,9 @@ export class OriginBaseReader {
       chineseKeyCollect.sort((pre, next) => next.length - pre.length);
 
       let result = await Promise.all(
-        chineseKeyCollect.map((text) => translate(this.config.rootDir, this.config.baiduTranslateConfigs, text))
+        chineseKeyCollect.map((text) =>
+          translate(this.config.rootDir, this.config.translatePath, this.config.baiduTranslateConfigs, text)
+        )
       );
       // const normalizeRegStr = (str: string) => str.replace(/(\W)/g, '$1');
       const toRegStr = (str) => str.replace(/(\W)/g, '\\$1');

packages/pont-engine/src/main/Config.ts

@@ -74,6 +74,7 @@ export class Config extends OldConfig {
             customTemplatePath: origin.customTemplatePath
           },
           baiduTranslateConfigs: standardBaseConfig.baiduTranslateConfigs,
+          translatePath: standardBaseConfig.translatePath,
           ...origin
         };
       });
@@ -88,7 +89,8 @@ export class Config extends OldConfig {
           templateOriginalPath: {
             customTemplatePath: null
           },
-          baiduTranslateConfigs: standardBaseConfig.baiduTranslateConfigs
+          baiduTranslateConfigs: standardBaseConfig.baiduTranslateConfigs,
+          translatePath: standardBaseConfig.translatePath
         }
       ];
     }

packages/pont-engine/src/main/originManage/OriginReader.ts

@@ -20,7 +20,12 @@ export class OriginReader implements IOriginReader {
   }
 
   translate(jsonString: string): Promise<string> {
-    return translateChinese(jsonString, this.config.rootDir, this.config.baiduTranslateConfigs);
+    return translateChinese(
+      jsonString,
+      this.config.rootDir,
+      this.config.translatePath,
+      this.config.baiduTranslateConfigs
+    );
   }
 
   async transform2StandardDataSource(json: any, config: IStandardOirginConfig): Promise<StandardDataSource> {

packages/pont-engine/src/types/pontConfig.ts

@@ -59,6 +59,9 @@ export interface IBaseConfig {
 
   /** 百度翻译秘钥信息 */
   baiduTranslateConfigs?: Array<IBaiduTranslateConfig>;
+
+  /** 指定翻译文件的生成路径（相对路径） */
+  translatePath?: string;
 }
 
 export interface IPontConfig extends IBaseConfig {
@@ -91,4 +94,7 @@ export interface IStandardOirginConfig extends IOriginConfig {
 
   /** 百度翻译秘钥信息 */
   baiduTranslateConfigs?: Array<IBaiduTranslateConfig>;
+
+  /** 指定翻译文件的生成路径（相对路径） */
+  translatePath?: string;
 }

packages/pont-engine/src/utils/PontFileManager.ts

@@ -8,7 +8,10 @@ import * as path from 'path';
 import { LOCAL_DICT_DIR } from '../constants';
 
 export class PontFileManager {
-  static getLocalFilePath(rootDir: string, filename: string): string {
+  static getLocalFilePath(rootDir: string, filename: string, customPath?: string): string {
+    if (customPath) {
+      return path.join(rootDir, customPath);
+    }
     return path.join(rootDir, LOCAL_DICT_DIR, filename);
   }
 
@@ -56,8 +59,8 @@ export class PontFileManager {
   static appendFile(filePath: string, content: string) {
     if (fs.existsSync(filePath)) {
       return fs.appendFile(filePath, content);
-    }else{
-      return PontFileManager.saveFile(filePath,content)
+    } else {
+      return PontFileManager.saveFile(filePath, content);
     }
   }
 

packages/pont-engine/src/utils/translate.ts

@@ -5,7 +5,6 @@
 import * as assert from 'assert';
 import * as _ from 'lodash';
 import { PontFileManager } from './PontFileManager';
-import { TRANSLATE_DICT_NAME } from '../constants';
 import { IBaiduTranslateConfig } from '../types/pontConfig';
 import { youdao, baidu, google } from 'translation.js';
 import pinyin from './pinyin';
@@ -48,8 +47,8 @@ const engines = [
 export const dict: { [rootDir: string]: { [cn: string]: string } } = {};
 const dicPath: { [rootDir: string]: string } = {};
 
-function init(rootDir: string) {
-  dicPath[rootDir] = PontFileManager.getLocalFilePath(rootDir, TRANSLATE_DICT_NAME);
+function init(rootDir: string, translatePath: string) {
+  dicPath[rootDir] = PontFileManager.getLocalFilePath(rootDir, null, translatePath);
   const localDict = PontFileManager.loadFile(dicPath[rootDir]);
 
   if (localDict) {
@@ -85,12 +84,13 @@ function startCaseClassName(result) {
 
 export async function translate(
   rootDir,
+  translatePath,
   baiduTranslateConfigs: IBaiduTranslateConfig[],
   text: string,
   engineIndex = 0
 ) {
   if (!dicPath[rootDir]) {
-    init(rootDir);
+    init(rootDir, translatePath);
   }
 
   if (dict[rootDir]?.[text]) {
@@ -140,14 +140,15 @@ export async function translate(
     return enKey;
   } catch (err) {
     console.error(`translateEngine:${translateEngine.name} text:${text} err:${err}`);
-    return translate(rootDir, baiduTranslateConfigs, text, index + 1);
+    return translate(rootDir, translatePath, baiduTranslateConfigs, text, index + 1);
   }
 }
 
 /** 翻译中文类名等 */
 export async function translateChinese(
   jsonString: string,
   rootDir: string,
+  translatePath: string,
   baiduTranslateConfigs?: IBaiduTranslateConfig[]
 ) {
   let retString = jsonString;
@@ -168,7 +169,9 @@ export async function translateChinese(
     // 例如: 请求参数vo, 请求参数, 替换时先替换 请求参数vo, 后替换请求参数
     chineseKeyCollect.sort((pre, next) => next.length - pre.length);
 
-    let result = await Promise.all(chineseKeyCollect.map((text) => translate(rootDir, baiduTranslateConfigs, text)));
+    let result = await Promise.all(
+      chineseKeyCollect.map((text) => translate(rootDir, translatePath, baiduTranslateConfigs, text))
+    );
     // const normalizeRegStr = (str: string) => str.replace(/(\W)/g, '$1');
     const toRegStr = (str) => str.replace(/(\W)/g, '\\$1');
     result.forEach((enKey: string, index) => {

packages/vscode-pont/configSchema.json

@@ -134,6 +134,10 @@
           }
         }
       }
+    },
+    "translatePath": {
+      "description": "自定义翻译文件的生成路径,包含文件名（使用相对路径指定）",
+      "type": "string"
     }
   }
 }