@chaoswise/intl 1.0.0 → 1.2.0

package/bin/chaoswise-intl.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 const runCollect = require('./scripts/collect');
 const runUpdate = require('./scripts/update');
+const runInitConfig = require('./scripts/initConfig');
 
 // 可执行的指令
-const SCRIPTS = ['collect', 'update'];
+const SCRIPTS = ['intl', 'collect', 'update'];
 
 const args = process.argv.slice(2);
 
@@ -14,6 +15,9 @@ const scriptIndex = args.findIndex(arg => {
 
 const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
 
+if(script === 'init') {
+  runInitConfig();
+}
 if(script === 'collect') {
   runCollect();
 }

package/bin/scripts/collect.js

@@ -5,11 +5,29 @@ const getTargetFiles = require('./util/getTargetFiles');
 const transformAst = require('./util/transformAst');
 const log = require('./util/log');
 const file = require('./util/file');
+const writeNewWordsFile = require('./util/writeNewWordsFile');
+const { readWordJson } = require('./util/getWord');
 
 const service = require('./service');
 
-async function init() {
+async function collect() {
+  log.info('词条扫描中...')
   const conf = getConf();
+  const newWordsFileType = conf.newWordsFileType || 'excel';
+
+  // 检查newWordsFileType
+  if (!['json', 'excel'].includes(newWordsFileType)) {
+    log.error(`配置：newWordsFileType 只能为json或者excel`);
+    process.exit(1);
+  }
+
+  // 读取wordJson
+  if (conf.localWordPath && !readWordJson(conf.localWordPath)) {
+    log.error('localWordPath配置有误');
+    process.exit(1);
+  }
+
+  // 获取需要遍历的文件
   const files = getTargetFiles(conf);
 
   // 遍历文件，并对代码进行ast处理的方法：transformAst(type, files, conf, replaceWords)
@@ -18,19 +36,25 @@ async function init() {
 
   // 在国际化平台中获取所有已存在中文信息
   const res = await service.searchByZh(info.allWords);
+
+  if (res.code !== 10000) {
+    log.error('请求数据出错:' + res.msg);
+    process.exit(1);
+  }
+
   const wordsMap = res.data;
 
   const replaceWords = {}; // { zh: id } 需要在代码中替换的词条id
   const newWords = {}; // { zh1: '待翻译', zh2: '请选择:中文1/中文2' }
-  Object.entries(wordsMap).forEach(([zh, value]) => {
+  Object.entries(wordsMap).forEach(([word, value]) => {
     // 如果当前中文词条在平台中存在，且对应英文翻译有且只有一条，那么直接替换代码中的中文为当前id，否则生成临时key，让开发者手动确认
     if (value.length === 1) {
-      replaceWords[zh] = value[0].key;
+      replaceWords[word] = value[0].key;
     } else {
       const id = uuidv4();
-      replaceWords[zh] = id;
+      replaceWords[word] = id;
       newWords[id] = {
-        zh,
+        zh: word,
         en:
           value.length === 0
             ? '待翻译'
@@ -48,20 +72,16 @@ async function init() {
   log.success('自定义配置文件在项目根目录的.intlconfig.js中');
   // 本次扫描出新的待翻译词条，写入到newWords中
   if (Object.keys(newWords).length) {
-    const newWordsJsonPath = 'newWords.json';
-
-    let oldNewWords = file.readJson(newWordsJsonPath) || {};
-    file.write(
-      newWordsJsonPath,
-      JSON.stringify({ ...oldNewWords, ...newWords }, null, 2)
-    );
+    writeNewWordsFile(newWordsFileType, newWords);
+  }
 
-    // 先注释掉，开始做指标时，会用到
-    // const package = file.read('package.json');
-    // file.write(newWordsJsonPath, JSON.stringify({ ...oldNewWords, ...newWords, projectName: package.name }, null, 2));
-    log.success(`需要翻译的文件在项目根目录的newWords.json中`);
+  const warnLogs = log.logs.warn;
+  if (warnLogs.length) {
+    const fileName = `intl.logs.warn.${(new Date).toLocaleString().replace(/[\/ ]/g, '_')}.txt`;
+    file.write(fileName, JSON.stringify(warnLogs, null, 2));
+    log.warnToLog(`警告日志文件:${fileName}`);
   }
 }
 
-// init();
-module.exports = init;
+// collect();
+module.exports = collect;

package/bin/scripts/conf/default.js

@@ -8,7 +8,6 @@ module.exports = function (excludes = []) {
     // exclude pattern, <string array>
     // e.g. ['**/dist/**', '**/*.config.js', '**/*.data.js']
     exclude: [
-      '**/router.config.js',
       '**/src/public/**',
       '**/_MOCK_/**'
     ],
@@ -19,7 +18,7 @@ module.exports = function (excludes = []) {
 
     // ignored components, <string array>
     // e.g. ['EventTracker']
-    ignoreComponents: [],
+    ignoreComponents: ['style', 'svg'],
 
     // ignored methods, <string array>
     // e.g. ['MirrorTrack']
@@ -41,6 +40,8 @@ module.exports = function (excludes = []) {
     // e.g. 't'
     i18nMethod: 'get',
 
+    i18nDefaultFunctionKey: 'd',
+
     // babel配置项
     babelPresets: [],
     babelPlugins: [],
@@ -54,6 +55,43 @@ module.exports = function (excludes = []) {
       endOfLine: 'lf',
     },
 
+    // <Tag id={{ key: 'id' }} defaultMessage='中文' />
+    // intlTag 是 'Tag'
+    // intlTagIdPath 是 'id.key'
+    // intlTagDefaultWordPath 是 'defaultMessage'，并且如果不配置，默认是'defaultMessage'
+    intlTag: '',
+    intlTagIdPath: '',
+    intlTagDefaultWordPath: '',
+
+    // intl.formatMessage({
+    //   key: 'id',
+    //   defaultMessage: '默认值',
+    // })
+    // intlFunctionName 是 intl.formatMessage
+    // intlFunctionIdPath 是 '0.key'。 如果 配置成 'key' 也行，intlFunctionIdPath如果不以数字开头，会在前面加上'0.' 'key' 就会变成 '0.key'
+    // intlFunctionDefaultWordPath 是 '0.defaultMessage',其他的说明同intlFunctionIdPath
+    intlFunctionName: '',
+    intlFunctionIdPath: '',
+    intlFunctionDefaultWordPath: '',
+
+    // 做过国际化的项目，中文config的路径。例如：'src/local/zh.json'
+    localWordPath: '',
+
+    // 配置 需要被脚本删除的依赖包的名字
+    removePkgName: [],
+
+    // 需要删除的函数和装饰器 的名称
+    removeFunctionName: ['injectIntl'],
+
+    // package.json中项目名称的key
+    groupNameKey: 'packageName',
+
+    // 特殊文件处理的正则  这里默认匹配router.config.js
+    specialFileReg: [/src\/config\/router\.config\.js/],
+
+    // newWords文件的类型 json或者excel
+    newWordsFileType: 'excel',
+
     // 国际化平台地址
     baseURL: 'http://10.0.1.133:18000',
   };

package/bin/scripts/conf/getCustomConfig.js

@@ -0,0 +1,8 @@
+const file = require('../util/file');
+
+module.exports = function () {
+  // 获取用户自定义配置文件
+  const customConfig = file.readJs('.intlconfig.js');
+
+  return customConfig;
+};

package/bin/scripts/conf/index.js

@@ -1,25 +1,5 @@
 const getDefaultConfig = require('./default');
-const file = require('../util/file');
-const prettier = require('prettier');
-
-function createCustomConfig() {
-  // 默认生成的配置文件，不需要给出全量可配置属性
-  const ignoreAttributes = [
-    'primaryRegx',
-    'importCode',
-    'i18nObject',
-    'i18nMethod',
-    'baseURL',
-  ];
-  const defaultConfig = getDefaultConfig(ignoreAttributes);
-
-  const code = `module.exports = ${JSON.stringify(defaultConfig, null, 2)};`;
-
-  file.write(
-    '.intlconfig.js',
-    prettier.format(code, { ...defaultConfig.prettier, parser: 'babel' })
-  );
-}
+const getCustomConfig = require('./getCustomConfig');
 
 // 内置一些，不需要被扫描的函数
 const ignoreMethods = [
@@ -28,11 +8,8 @@ Object.keys(console).forEach(key => ignoreMethods.push(`console.${key}`))
 
 module.exports = function () {
   // 获取用户自定义配置文件
-  const customConfig = file.readJs('.intlconfig.js');
+  const customConfig = getCustomConfig() || {};
 
-  if (!customConfig) {
-    createCustomConfig();
-  }
   // 合并配置文件
   const finalyConf = { ...getDefaultConfig(), ...customConfig };
 

package/bin/scripts/conf/initConfig.js

@@ -0,0 +1,37 @@
+const getCustomConfig = require('./getCustomConfig');
+const getDefaultConfig = require('./default');
+const file = require('../util/file');
+const prettier = require('prettier');
+const log = require('../util/log');
+
+module.exports = function initConfig() {
+  const customConfigName = '.intlconfig.js'
+
+  const customConfig = getCustomConfig();
+
+  if (customConfig) {
+    console.log(`${customConfigName}已存在，请手动删除本地已经有的配置文件再重新执行 npm run intl-init`);
+    return;
+  }
+
+  // 默认生成的配置文件，不需要给出全量可配置属性
+  const ignoreAttributes = [
+    'primaryRegx',
+    'importCode',
+    'i18nObject',
+    'i18nMethod',
+    'i18nDefaultFunctionKey',
+    'specialFileReg',
+    'baseURL',
+  ];
+  const defaultConfig = getDefaultConfig(ignoreAttributes);
+
+  const code = `module.exports = ${JSON.stringify(defaultConfig, null, 2)};`;
+
+  file.write(
+    customConfigName,
+    prettier.format(code, { ...defaultConfig.prettier, parser: 'babel' })
+  );
+
+  log.success(`初始化配置文件成功：.intlconfig.js`);
+}

package/bin/scripts/initConfig.js

@@ -0,0 +1,3 @@
+const initConfig = require('./conf/initConfig');
+
+module.exports = initConfig;

package/bin/scripts/service/index.js

@@ -24,6 +24,6 @@ exports.searchByZh = (zhs) => {
 };
 
 // 根据词条id获取所有数据库词条信息
-exports.getJson = (ids) => {
-  return axios.post('/getJson', ids);
+exports.getJson = ({ groupName, downloadIds }) => {
+  return axios.post('/getJson', { groupName, downloadIds });
 };

package/bin/scripts/update.js

@@ -5,7 +5,7 @@ const downloadJson = require('./util/downloadJson');
 const log = require('./util/log');
 const file = require('./util/file');
 
-async function replace() {
+async function update() {
   const conf = getConf();
   const files = getTargetFiles(conf);
 
@@ -13,7 +13,7 @@ async function replace() {
   const relationKey = file.readJson('relationKey.json') || {};
 
   const info = transformAst('update', files, conf, relationKey);
-  downloadJson(info.downloadIds);
+  await downloadJson(info.downloadIds);
 
   const needDelete = Boolean(Object.keys(relationKey).length);
   if (needDelete) {
@@ -23,10 +23,10 @@ async function replace() {
     log.success('newWords.json和relationKey.json 已删除');
   }
 
-  log.success('脚本执行成功2222');
+  log.success('脚本执行成功');
 }
 
-// replace();
-module.exports = replace;
+// update();
+module.exports = update;
 
 

package/bin/scripts/util/FormPath/contexts.d.ts

@@ -0,0 +1,10 @@
+export declare type Context = {
+    flag: string;
+    [key: string]: any;
+};
+export declare const bracketContext: Context;
+export declare const bracketArrayContext: Context;
+export declare const bracketDContext: Context;
+export declare const parenContext: Context;
+export declare const braceContext: Context;
+export declare const destructorContext: Context;

package/bin/scripts/util/FormPath/contexts.js

@@ -0,0 +1,23 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destructorContext = exports.braceContext = exports.parenContext = exports.bracketDContext = exports.bracketArrayContext = exports.bracketContext = void 0;
+var ContextType = function (flag, props) {
+    return __assign({ flag: flag }, props);
+};
+exports.bracketContext = ContextType("[]");
+exports.bracketArrayContext = ContextType("[\\d]");
+exports.bracketDContext = ContextType("[[]]");
+exports.parenContext = ContextType("()");
+exports.braceContext = ContextType("{}");
+exports.destructorContext = ContextType("{x}");

package/bin/scripts/util/FormPath/destructor.d.ts

@@ -0,0 +1,15 @@
+import { Segments, Node, DestrcutorRules } from './types';
+declare type Mutatators = {
+    getIn: (segments: Segments, source: any) => any;
+    setIn: (segments: Segments, source: any, value: any) => void;
+    deleteIn?: (segments: Segments, source: any) => any;
+    existIn?: (segments: Segments, source: any, start: number) => boolean;
+};
+export declare const getDestructor: (source: string) => any;
+export declare const setDestructor: (source: string, rules: DestrcutorRules) => void;
+export declare const parseDestructorRules: (node: Node) => DestrcutorRules;
+export declare const setInByDestructor: (source: any, rules: DestrcutorRules, value: any, mutators: Mutatators) => void;
+export declare const getInByDestructor: (source: any, rules: DestrcutorRules, mutators: Mutatators) => {};
+export declare const deleteInByDestructor: (source: any, rules: DestrcutorRules, mutators: Mutatators) => void;
+export declare const existInByDestructor: (source: any, rules: DestrcutorRules, start: number, mutators: Mutatators) => boolean;
+export {};

package/bin/scripts/util/FormPath/destructor.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.existInByDestructor = exports.deleteInByDestructor = exports.getInByDestructor = exports.setInByDestructor = exports.parseDestructorRules = exports.setDestructor = exports.getDestructor = void 0;
+var types_1 = require("./types");
+var utils_1 = require("./utils");
+var DestrcutorCache = new Map();
+var isValid = function (val) { return val !== undefined && val !== null; };
+exports.getDestructor = function (source) {
+    return DestrcutorCache.get(source);
+};
+exports.setDestructor = function (source, rules) {
+    DestrcutorCache.set(source, rules);
+};
+exports.parseDestructorRules = function (node) {
+    var rules = [];
+    if (types_1.isObjectPattern(node)) {
+        var index_1 = 0;
+        node.properties.forEach(function (child) {
+            rules[index_1] = {
+                path: []
+            };
+            rules[index_1].key = child.key.value;
+            rules[index_1].path.push(child.key.value);
+            if (types_1.isIdentifier(child.value)) {
+                rules[index_1].key = child.value.value;
+            }
+            var basePath = rules[index_1].path;
+            var childRules = exports.parseDestructorRules(child.value);
+            var k = index_1;
+            childRules.forEach(function (rule) {
+                if (rules[k]) {
+                    rules[k].key = rule.key;
+                    rules[k].path = basePath.concat(rule.path);
+                }
+                else {
+                    rules[k] = {
+                        key: rule.key,
+                        path: basePath.concat(rule.path)
+                    };
+                }
+                k++;
+            });
+            if (k > index_1) {
+                index_1 = k;
+            }
+            else {
+                index_1++;
+            }
+        });
+        return rules;
+    }
+    else if (types_1.isArrayPattern(node)) {
+        var index_2 = 0;
+        node.elements.forEach(function (child, key) {
+            rules[index_2] = {
+                path: []
+            };
+            rules[index_2].key = key;
+            rules[index_2].path.push(key);
+            if (types_1.isIdentifier(child)) {
+                rules[index_2].key = child.value;
+            }
+            var basePath = rules[index_2].path;
+            var childRules = exports.parseDestructorRules(child);
+            var k = index_2;
+            childRules.forEach(function (rule) {
+                if (rules[k]) {
+                    rules[k].key = rule.key;
+                    rules[k].path = basePath.concat(rule.path);
+                }
+                else {
+                    rules[k] = {
+                        key: rule.key,
+                        path: basePath.concat(rule.path)
+                    };
+                }
+                k++;
+            });
+            if (k > index_2) {
+                index_2 = k;
+            }
+            else {
+                index_2++;
+            }
+        });
+        return rules;
+    }
+    if (types_1.isDestructorExpression(node)) {
+        return exports.parseDestructorRules(node.value);
+    }
+    return rules;
+};
+exports.setInByDestructor = function (source, rules, value, mutators) {
+    rules.forEach(function (_a) {
+        var key = _a.key, path = _a.path;
+        mutators.setIn([key], source, mutators.getIn(path, value));
+    });
+};
+exports.getInByDestructor = function (source, rules, mutators) {
+    var response = {};
+    if (rules.length) {
+        if (utils_1.isNum(rules[0].path[0])) {
+            response = [];
+        }
+    }
+    source = isValid(source) ? source : {};
+    rules.forEach(function (_a) {
+        var key = _a.key, path = _a.path;
+        mutators.setIn(path, response, source[key]);
+    });
+    return response;
+};
+exports.deleteInByDestructor = function (source, rules, mutators) {
+    rules.forEach(function (_a) {
+        var key = _a.key;
+        mutators.deleteIn([key], source);
+    });
+};
+exports.existInByDestructor = function (source, rules, start, mutators) {
+    return rules.every(function (_a) {
+        var key = _a.key;
+        return mutators.existIn([key], source, start);
+    });
+};

package/bin/scripts/util/FormPath/index.d.ts

@@ -0,0 +1,49 @@
+import { Segments, Node, Pattern } from './types';
+export * from './types';
+export declare class Path {
+    entire: string;
+    segments: Segments;
+    isMatchPattern: boolean;
+    isWildMatchPattern: boolean;
+    haveExcludePattern: boolean;
+    matchScore: number;
+    tree: Node;
+    private matchCache;
+    private includesCache;
+    constructor(input: Pattern);
+    toString(): string;
+    toArray(): Segments;
+    get length(): number;
+    private parse;
+    private parseString;
+    concat: (...args: Pattern[]) => Path;
+    slice: (start?: number, end?: number) => Path;
+    push: (item: Pattern) => this;
+    pop: () => void;
+    splice: (start: number, deleteCount?: number, ...items: Array<string | number>) => this;
+    forEach: (callback: (key: string | number) => any) => void;
+    map: (callback: (key: string | number) => any) => any[];
+    reduce: <T>(callback: (buf: T, item: string | number, index: number) => T, initial: T) => T;
+    getNearestChildPathBy: (target?: Pattern) => Path;
+    parent: () => Path;
+    includes: (pattern: Pattern) => any;
+    transform: <T>(regexp: string | RegExp, callback: (...args: string[]) => T) => string | T;
+    match: (pattern: Pattern) => boolean;
+    matchAliasGroup: (name: Pattern, alias: Pattern) => boolean;
+    existIn: (source?: any, start?: number | Path) => boolean;
+    getIn: (source?: any) => any;
+    setIn: (source?: any, value?: any) => any;
+    deleteIn: (source?: any) => any;
+    static match(pattern: Pattern): {
+        (target: any): boolean;
+        path: Path;
+    };
+    static transform<T>(pattern: Pattern, regexp: string | RegExp, callback: (...args: string[]) => T): any;
+    static parse(path?: Pattern): Path;
+    static getPath(path?: Pattern): Path;
+    static getIn: (source: any, pattern: Pattern) => any;
+    static setIn: (source: any, pattern: Pattern, value: any) => any;
+    static deleteIn: (source: any, pattern: Pattern) => any;
+    static existIn: (source: any, pattern: Pattern, start?: number | Path) => boolean;
+}
+export default Path;