|
| 1 | +const env = require('jsdoc/lib/jsdoc/env'); |
| 2 | + |
| 3 | +const globalParams = env.conf.templates; |
| 4 | +const moduleconditionNames = []; |
| 5 | +const moduleconditionMap = {}; |
| 6 | +exports.defineTags = function (dictionary) { |
| 7 | + dictionary.defineTag('modulecondition', { |
| 8 | + mustHaveValue: false, |
| 9 | + mustNotHaveDescription: false, |
| 10 | + canHaveType: false, |
| 11 | + canHaveName: false, |
| 12 | + onTagged: function (doclet, tag) { |
| 13 | + if (tag.value) { |
| 14 | + const [modulecondition, value] = tag.value.split(':'); |
| 15 | + if (modulecondition === globalParams.moduleName) { |
| 16 | + moduleconditionNames.push(doclet.name); |
| 17 | + moduleconditionMap[doclet.name] = value.split('|'); |
| 18 | + } |
| 19 | + } |
| 20 | + doclet.undocumented = true; |
| 21 | + } |
| 22 | + }); |
| 23 | +}; |
| 24 | + |
| 25 | +// 处理类型名称替换，支持普通类型和泛型类型（如 Array.<Name>） |
| 26 | +function replaceTypeName(name) { |
| 27 | + // 直接匹配 |
| 28 | + if (moduleconditionNames.indexOf(name) >= 0) { |
| 29 | + return moduleconditionMap[name]; |
| 30 | + } |
| 31 | + |
| 32 | + // 检查是否包含泛型形式，如 Array.<Name> 或 Array.<Name|others> |
| 33 | + const genericMatch = name.match(/^(.+?)<(.+)>$/); |
| 34 | + if (genericMatch) { |
| 35 | + const [, prefix, inner] = genericMatch; |
| 36 | + |
| 37 | + // 去除外层括号 (如果有) |
| 38 | + let cleanInner = inner.trim(); |
| 39 | + let hasOuterParens = false; |
| 40 | + if (cleanInner.startsWith('(') && cleanInner.endsWith(')')) { |
| 41 | + cleanInner = cleanInner.substring(1, cleanInner.length - 1); |
| 42 | + hasOuterParens = true; |
| 43 | + } |
| 44 | + |
| 45 | + const types = cleanInner.split('|').map((t) => t.trim()); |
| 46 | + const newTypes = []; |
| 47 | + let hasReplacement = false; |
| 48 | + |
| 49 | + types.forEach((type) => { |
| 50 | + const trimmedType = type.trim(); |
| 51 | + if (moduleconditionNames.indexOf(trimmedType) >= 0) { |
| 52 | + const values = moduleconditionMap[trimmedType]; |
| 53 | + if (values && values.length > 0) { |
| 54 | + hasReplacement = true; |
| 55 | + newTypes.push(...values); |
| 56 | + } else { |
| 57 | + newTypes.push(trimmedType); |
| 58 | + } |
| 59 | + } else { |
| 60 | + newTypes.push(trimmedType); |
| 61 | + } |
| 62 | + }); |
| 63 | + |
| 64 | + if (hasReplacement) { |
| 65 | + // 返回单个泛型类型，内部是联合类型，保留原有的括号 |
| 66 | + const innerTypes = newTypes.join('|'); |
| 67 | + const result = hasOuterParens ? `${prefix}<(${innerTypes})>` : `${prefix}<${innerTypes}>`; |
| 68 | + return [result]; |
| 69 | + } |
| 70 | + } |
| 71 | + |
| 72 | + return null; |
| 73 | +} |
| 74 | + |
| 75 | +exports.handlers = { |
| 76 | + newDoclet: function (e) { |
| 77 | + if (moduleconditionNames.length === 0) { |
| 78 | + return; |
| 79 | + } |
| 80 | + // 处理成员类型 |
| 81 | + if (e.doclet.kind === 'member') { |
| 82 | + if (!e.doclet.type || !e.doclet.type.names) { |
| 83 | + return; |
| 84 | + } |
| 85 | + // 从后向前遍历，避免在遍历时修改数组导致的问题 |
| 86 | + for (let i = e.doclet.type.names.length - 1; i >= 0; i--) { |
| 87 | + const name = e.doclet.type.names[i]; |
| 88 | + const replacedValues = replaceTypeName(name); |
| 89 | + if (replacedValues && replacedValues.length > 0) { |
| 90 | + e.doclet.type.names.splice(i, 1, ...replacedValues); |
| 91 | + } |
| 92 | + } |
| 93 | + return; |
| 94 | + } |
| 95 | + |
| 96 | + // 处理function参数和返回值类型 |
| 97 | + const parameters = e.doclet.params; |
| 98 | + if (!parameters) { |
| 99 | + return; |
| 100 | + } |
| 101 | + |
| 102 | + parameters.forEach((element) => { |
| 103 | + if (!element.type || !element.type.names) { |
| 104 | + return; |
| 105 | + } |
| 106 | + // 从后向前遍历，避免在遍历时修改数组导致的问题 |
| 107 | + for (let i = element.type.names.length - 1; i >= 0; i--) { |
| 108 | + const name = element.type.names[i]; |
| 109 | + const replacedValues = replaceTypeName(name); |
| 110 | + if (replacedValues && replacedValues.length > 0) { |
| 111 | + element.type.names.splice(i, 1, ...replacedValues); |
| 112 | + } |
| 113 | + } |
| 114 | + }); |
| 115 | + |
| 116 | + const returns = e.doclet.returns; |
| 117 | + if (returns) { |
| 118 | + returns.forEach((element) => { |
| 119 | + if (!element.type || !element.type.names) { |
| 120 | + return; |
| 121 | + } |
| 122 | + // 从后向前遍历，避免在遍历时修改数组导致的问题 |
| 123 | + for (let i = element.type.names.length - 1; i >= 0; i--) { |
| 124 | + const name = element.type.names[i]; |
| 125 | + const replacedValues = replaceTypeName(name); |
| 126 | + if (replacedValues && replacedValues.length > 0) { |
| 127 | + element.type.names.splice(i, 1, ...replacedValues); |
| 128 | + } |
| 129 | + } |
| 130 | + }); |
| 131 | + } |
| 132 | + } |
| 133 | +}; |
0 commit comments