openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-03-01 13:46:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix:JSDoc整改工具更新

Browse Source 
Signed-off-by: yangbo_404 <yangbo198@huawei.com>
Change-Id: I6f2c13be73e082d5efe6d4f0b99549efe3874fb9
This commit is contained in:
yangbo_404 2023-03-24 09:23:08 +00:00
parent bbe70427db
commit 95d8914323
3 changed files with 76 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
build-tools/api_check_plugin/src/check_jsdoc_value/check_rest_value.js
View File

@ -85,17 +85,21 @@ function checkReturnsValue(tag, node, sourcefile, fileName, index) {
const voidArr = ['void'];
const tagValue = tag.type;
if (commentNodeWhiteList.includes(node.kind)) {
const apiReturnsValue = node.type?.getText();
const apiReturnsValue = node.type ? node.type.getText() : '';
if (voidArr.indexOf(apiReturnsValue) !== -1 || apiReturnsValue === undefined) {
returnsResult.checkResult = false;
returnsResult.errorInfo = 'returns标签使用错误, 返回类型为void时不应该使用returns标签.';
addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_ORDER, returnsResult.errorInfo, FileType.JSDOC,
ErrorLevel.LOW);
} else if (tagValue !== apiReturnsValue) {
returnsResult.checkResult = false;
returnsResult.errorInfo = 'returns标签类型错误, 请检查标签类型是否与返回类型一致.';
addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_ORDER, returnsResult.errorInfo, FileType.JSDOC,
ErrorLevel.LOW);
} else if (tagValue.replace(/\s+/g, '') !== apiReturnsValue.replace(/\s+/g, '')) {
if (node.type && ((ts.isTypeLiteralNode(node.type) && tag.type === 'object') || (ts.isFunctionTypeNode(node.type) && tag.type === 'function'))) {
return returnsResult;
} else {
returnsResult.checkResult = false;
returnsResult.errorInfo = 'returns标签类型错误, 请检查标签类型是否与返回类型一致.';
addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_ORDER, returnsResult.errorInfo, FileType.JSDOC,
ErrorLevel.LOW);
}
}
}
return returnsResult;
@ -113,11 +117,15 @@ function checkParamValue(tag, node, sourcefile, fileName, index) {
const apiParamInfos = node.parameters;
if (apiParamInfos[index]) {
const apiName = apiParamInfos[index].name.escapedText;
const apiType = apiParamInfos[index].type?.getText();
const apiType = apiParamInfos[index].type ? apiParamInfos[index].type.getText() : '';
let errorInfo = '';
if (apiType !== tagTypeValue) {
paramResult.checkResult = false;
errorInfo += `第[${index + 1}]个param标签类型错误, 请检查是否与第[${index + 1}]个参数类型保持一致.`;
if (apiType.replace(/\s+/g, '') !== tagTypeValue.replace(/\s+/g, '')) {
if (apiParamInfos[index].type && ((ts.isTypeLiteralNode(apiParamInfos[index].type) && tag.type === 'object') || (ts.isFunctionTypeNode(apiParamInfos[index].type) && tag.type === 'function'))) {
return paramResult;
} else {
paramResult.checkResult = false;
errorInfo += `第[${index + 1}]个param标签类型错误, 请检查是否与第[${index + 1}]个参数类型保持一致.`;
}
}
if (apiName !== tagNameValue) {
paramResult.checkResult = false;
@ -187,9 +195,9 @@ function isArkUIApiFile(fileName) {
* xxx.xxx#event:xxx
*/
function checkModule(moduleValue) {
return /^[A-Za-z_]+\b(\.[A-Za-z_]+\b)*$/.test(moduleValue) ||
/^[A-Za-z_]+\b(\.[A-Za-z_]+\b)*\#[A-Za-z_]+\b$/.test(moduleValue) ||
/^[A-Za-z_]+\b(\.[A-Za-z_]+\b)*\#event:[A-Za-z_]+\b$/.test(moduleValue);
return /^[A-Za-z_0-9]+\b(\.[A-Za-z_0-9]+\b)*$/.test(moduleValue) ||
/^[A-Za-z_0-9]+\b(\.[A-Za-z_0-9]+\b)*\#[A-Za-z_0-9]+\b$/.test(moduleValue) ||
/^[A-Za-z_0-9]+\b(\.[A-Za-z_0-9]+\b)*\#event:[A-Za-z_0-9]+\b$/.test(moduleValue);
}
function splitUseinsteadValue(useinsteadValue) {
@ -259,15 +267,34 @@ function checkTypeValue(tag, node, sourcefile, fileName, index) {
checkResult: true,
errorInfo: '',
};
let errorInfo = '';
const tagTypeValue = tag.type;
if (commentNodeWhiteList.includes(node.kind)) {
const apiTypeValue = node.type?.getText();
if (apiTypeValue !== tagTypeValue) {
typeResult.checkResult = false;
typeResult.errorInfo = 'type标签类型错误, 请检查类型是否与属性类型一致.';
addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_ORDER, typeResult.errorInfo, FileType.JSDOC,
ErrorLevel.LOW);
const apiTypeValue = node.type ? node.type.getText() : '';
if (apiTypeValue.replace(/[\? ]/g, '') !== tagTypeValue.replace(/[\? \(\)]/g, '')) {
if (!(node.type && ts.isTypeLiteralNode(node.type) && tagTypeValue === 'object') && !(node.type && ts.isFunctionTypeNode(node.type) && tagTypeValue === 'function')) {
typeResult.checkResult = false;
errorInfo += 'type标签类型错误, 请检查类型是否与属性类型一致.';
}
}
if (/\?/.test(tagTypeValue) && !node.questionToken) {
if (errorInfo !== '') {
errorInfo += '\n';
}
typeResult.checkResult = false;
errorInfo += '当前参数不是可选项, 请检查type标签类型是否应该删除[?]符号.';
} else if (!/\?/.test(tagTypeValue) && node.questionToken && node.questionToken.kind === ts.SyntaxKind.QuestionToken) {
if (errorInfo !== '') {
errorInfo += '\n';
}
typeResult.checkResult = false;
errorInfo += '当前参数为可选项, 请检查type标签类型是否缺少[?]符号.';
}
}
if (!typeResult.checkResult) {
typeResult.errorInfo = errorInfo;
addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_ORDER, errorInfo, FileType.JSDOC,
ErrorLevel.LOW);
}
return typeResult;
}
@ -297,7 +324,7 @@ function checkPermissionTag(tag, node, sourcefile, fileName, index) {
errorInfo: '',
};
const tagValue = tag.name + tag.description;
const permissionArr = tagValue.replace(/ /g, '').replace(/(or|and|\(|\))/g, '$').split('$');
const permissionArr = tagValue.replace(/\s+/g, '').replace(/(or|and|\(|\))/g, '$').split('$');
permissionArr.forEach(permissionStr => {
if ((permissionStr !== '' && !permissionRuleSet.has(permissionStr) && permissionStr !== 'N/A') || permissionStr === '') {
hasPermissionError = true;

6
build-tools/api_check_plugin/src/check_legality.js
View File

@ -157,6 +157,8 @@ function legalityCheck(node, sourcefile, legalKinds, tagsName, isRequire, checkI
}
} else if ((tagName === 'interface' || tagName === 'typedef') && (tag.tag === 'interface' || tag.tag === 'typedef')) {
checkResult = true;
} else if (tagName === 'syscap' && (ts.isModuleDeclaration(node) || ts.isClassDeclaration(node))) {
checkResult = true;
} else if (tag.tag === tagName) {
checkResult = true;
}
@ -174,7 +176,9 @@ function legalityCheck(node, sourcefile, legalKinds, tagsName, isRequire, checkI
(tagName === 'param' && paramTagNum < parameterNum)) && extraCheckCallback(node, checkResult)) {
// 报错
// console.log(`${sourcefile.fileName}, ${node.getText()} has no @${tagName}`);
checkInfoMap[index].missingTags.push(tagName);
if (tagName !== 'typedef' || checkInfoMap[index].missingTags.indexOf('interface') < 0) {
checkInfoMap[index].missingTags.push(tagName);
}
} else if (((tagName !== 'useinstead' && tagName !== 'param' && checkResult && illegalKindSet.has(node.kind)) ||
(tagName === 'useinstead' && !useinsteadResultObj.hasDeprecated && useinsteadResultObj.hasUseinstead) ||
(tagName === 'param' && paramTagNum > parameterNum)) && extraCheckCallback(node, checkResult)) {

40
build-tools/jsdoc_format_plugin/src/core/modificationProcessor.ts
View File

@ -211,7 +211,13 @@ class JSDocModificationManager {
if (tagName === 'returns' && (ts.isMethodDeclaration(node.astNode) || ts.isMethodSignature(node.astNode) ||
ts.isFunctionDeclaration(node.astNode) || ts.isCallSignatureDeclaration(node.astNode)) &&
node.astNode.type) {
tagType = node.astNode.type.getText();
if (ts.isTypeLiteralNode(node.astNode.type)) {
tagType = 'object';
} else if (ts.isFunctionTypeNode(node.astNode.type)) {
tagType = 'function';
} else {
tagType = node.astNode.type.getText();
}
} else if ((ts.isModuleDeclaration(node.astNode) || ts.isEnumDeclaration(node.astNode)) && node.astNode.name &&
ts.isIdentifier(node.astNode.name)) {
tagValue = node.astNode.name.escapedText.toString();
@ -299,22 +305,24 @@ class JSDocModificationManager {
if (curParameter) {
const apiName: string = node.astNode.name ? node.astNode.name.getText() : '';
const commentInfos: comment.CommentInfo[] = node.commentInfos ? node.commentInfos : [];
if (curParameter.type && (ts.isTypeLiteralNode(curParameter.type) || ts.isFunctionTypeNode(curParameter.type))) {
const checkLogResult: CheckLogResult = LogResult.createCheckResult(node.astNode, commentInfos,
JSDocModificationManager.createErrorInfo(ErrorInfo.PARAM_FORAMT_ERROR, [`${i + 1}`]), context, apiName,
JSDocCheckErrorType.API_FORMAT_ERROR);
context?.getLogReporter().addCheckResult(checkLogResult);
continue;
} else {
newCommentTag.type = curParameter.type ? curParameter.type.getText() : '';
newCommentTag.name = curParameter.name ? curParameter.name.getText() : '';
commentInfo.commentTags.push(newCommentTag);
// 提示description缺失信息
const checkLogResult: CheckLogResult = LogResult.createCheckResult(node.astNode, commentInfos,
JSDocModificationManager.createErrorInfo(ErrorInfo.PARAM_FORAMT_DESCRIPTION_ERROR, [`${curIndex + 1}`]), context, apiName,
JSDocCheckErrorType.PARAM_DESCRIPTION_WARNING);
context?.getLogReporter().addCheckResult(checkLogResult);
let paramType: string = '';
if (curParameter.type) {
if (ts.isTypeLiteralNode(curParameter.type)) {
paramType = 'object';
} else if (ts.isFunctionTypeNode(curParameter.type)) {
paramType = 'function';
} else {
paramType = curParameter.type.getText();
}
}
newCommentTag.type = paramType;
newCommentTag.name = curParameter.name ? curParameter.name.getText() : '';
commentInfo.commentTags.push(newCommentTag);
// 提示description缺失信息
const checkLogResult: CheckLogResult = LogResult.createCheckResult(node.astNode, commentInfos,
JSDocModificationManager.createErrorInfo(ErrorInfo.PARAM_FORAMT_DESCRIPTION_ERROR, [`${curIndex + 1}`]), context, apiName,
JSDocCheckErrorType.PARAM_DESCRIPTION_WARNING);
context?.getLogReporter().addCheckResult(checkLogResult);
}
}
}