@awesome-fe/translate
Version:
Translation utils
219 lines • 11.4 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __spreadArrays = (this && this.__spreadArrays) || function () {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.JsdocTranslator = void 0;
var translator_1 = require("./translator");
var ts_morph_1 = require("ts-morph");
var util_1 = require("util");
var markdown_translator_1 = require("./markdown-translator");
function getTagsWithAncestors(node) {
if (!node) {
return [];
}
// 如果不是，就跳过这一层，直接返回父级的结果
if (!ts_morph_1.Node.isJSDocableNode(node)) {
return getTagsWithAncestors(node.getParent());
}
// 取当前节点的所有标记
var tags = node.getJsDocs().map(function (it) { return it.getTags(); }).flat();
// 合并当前节点的标记和父级节点的标记
return __spreadArrays(tags, getTagsWithAncestors(node.getParent()));
}
function shouldTranslate(node, options) {
if (!ts_morph_1.Node.isJSDocableNode(node)) {
return false;
}
var tags = getTagsWithAncestors(node).map(function (it) { return it.getTagName(); });
return (!options.mustIncludesTag || tags.includes(options.mustIncludesTag)) &&
(!options.mustExcludesTag || !tags.includes(options.mustExcludesTag));
}
var JsdocTranslator = /** @class */ (function (_super) {
__extends(JsdocTranslator, _super);
function JsdocTranslator() {
var _this = _super !== null && _super.apply(this, arguments) || this;
_this.markdownTranslator = new markdown_translator_1.MarkdownTranslator(_this.engine);
return _this;
}
JsdocTranslator.prototype.translate = function (text) {
return __awaiter(this, void 0, void 0, function () {
var project, sourceFile;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
project = new ts_morph_1.Project({ manipulationSettings: { indentationText: ts_morph_1.IndentationText.TwoSpaces } });
sourceFile = project.createSourceFile('placeholder.ts', text);
return [4 /*yield*/, this.translateNode(sourceFile, this.engine)];
case 1:
_a.sent();
return [2 /*return*/, sourceFile.getFullText()];
}
});
});
};
JsdocTranslator.prototype.translateNode = function (node, engine) {
return __awaiter(this, void 0, void 0, function () {
var docs, _i, docs_1, doc, structure, _a, _b, tag, origin_1, translation, _c, _d, subNode;
return __generator(this, function (_e) {
switch (_e.label) {
case 0:
if (!(ts_morph_1.Node.isJSDocableNode(node) && shouldTranslate(node, this.options))) return [3 /*break*/, 9];
docs = node.getJsDocs();
_i = 0, docs_1 = docs;
_e.label = 1;
case 1:
if (!(_i < docs_1.length)) return [3 /*break*/, 9];
doc = docs_1[_i];
structure = doc.getStructure();
_a = 0, _b = structure.tags;
_e.label = 2;
case 2:
if (!(_a < _b.length)) return [3 /*break*/, 5];
tag = _b[_a];
return [4 /*yield*/, this.translateTag(tag, engine)];
case 3:
_e.sent();
_e.label = 4;
case 4:
_a++;
return [3 /*break*/, 2];
case 5:
origin_1 = structure.description.trim();
if (!origin_1) return [3 /*break*/, 7];
return [4 /*yield*/, this.markdownTranslator.translate(structure.description)];
case 6:
translation = _e.sent();
if (translation.trim() !== origin_1.trim()) {
structure.description = trimLastLf(translation);
}
_e.label = 7;
case 7:
if (!util_1.isDeepStrictEqual(structure, doc.getStructure())) {
doc.set(structure);
}
_e.label = 8;
case 8:
_i++;
return [3 /*break*/, 1];
case 9:
_c = 0, _d = node.getChildren();
_e.label = 10;
case 10:
if (!(_c < _d.length)) return [3 /*break*/, 13];
subNode = _d[_c];
return [4 /*yield*/, this.translateNode(subNode, engine)];
case 11:
_e.sent();
_e.label = 12;
case 12:
_c++;
return [3 /*break*/, 10];
case 13: return [2 /*return*/];
}
});
});
};
JsdocTranslator.prototype.translateTag = function (tag, engine) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var text, _b, name_1, description, translation, _c, prefix, description, translation;
return __generator(this, function (_d) {
switch (_d.label) {
case 0:
text = tag.text;
if (!isBinaryTag(tag)) return [3 /*break*/, 3];
_b = (_a = text.match(/^((?:{.*?}\s*)?[\w.]+\s+)([\s\S]*)$/)) !== null && _a !== void 0 ? _a : [], name_1 = _b[1], description = _b[2];
if (!(description === null || description === void 0 ? void 0 : description.trim())) return [3 /*break*/, 2];
return [4 /*yield*/, this.markdownTranslator.translate(description)];
case 1:
translation = _d.sent();
if (translation.trim() !== description.trim()) {
tag.text = (name_1 !== null && name_1 !== void 0 ? name_1 : '') + trimLastLf(translation);
}
_d.label = 2;
case 2: return [3 /*break*/, 5];
case 3:
if (!isUnaryTag(tag)) return [3 /*break*/, 5];
_c = text.match(/^({.*?}\s*)?([\s\S]*)$/), prefix = _c[1], description = _c[2];
if (!(description === null || description === void 0 ? void 0 : description.trim())) return [3 /*break*/, 5];
return [4 /*yield*/, this.markdownTranslator.translate(description)];
case 4:
translation = _d.sent();
if (translation.trim() !== description.trim()) {
tag.text = (prefix !== null && prefix !== void 0 ? prefix : '') + trimLastLf(translation);
}
_d.label = 5;
case 5: return [2 /*return*/];
}
});
});
};
return JsdocTranslator;
}(translator_1.Translator));
exports.JsdocTranslator = JsdocTranslator;
// 有两个参数且需要翻译的标记，如 @param a Some value
function isBinaryTag(tag) {
return ['param', 'arg', 'argument', 'property', 'prop', 'yields', 'yield', 'template', 'breaking-change'].includes(tag.tagName);
}
// 有一个参数且需要翻译的标记，如 @returns Some value
function isUnaryTag(tag) {
return ['returns', 'return', 'classdesc', 'description', 'desc', 'summary', 'throws', 'deprecated', 'usageNotes', 'see'].includes(tag.tagName);
}
function trimLastLf(translation) {
return translation.replace(/\n$/s, '');
}
//# sourceMappingURL=jsdoc-translator.js.map