1/* 2 * Copyright (c) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16const { ErrorType, ErrorLevel, FileType, fileTagOrder, ErrorValueInfo } = require('./utils'); 17const { parseJsDoc } = require('./utils'); 18const { addAPICheckErrorLogs } = require('./compile_info'); 19 20function checkFileTagOrder(node, sourcefile, fileName) { 21 const comments = parseJsDoc(node); 22 if (comments.length === 0) { 23 return; 24 } 25 const fileJsdoc = comments[0].tags; 26 for (let tagIndex = 0; tagIndex < fileJsdoc.length; tagIndex++) { 27 if (tagIndex + 1 < fileJsdoc.length) { 28 // 获取前后两个tag下标 29 const firstIndex = fileTagOrder.indexOf(fileJsdoc[tagIndex].tag); 30 const secondIndex = fileTagOrder.indexOf(fileJsdoc[tagIndex + 1].tag); 31 // 非自定义标签在前或数组降序时报错 32 if (firstIndex > secondIndex && secondIndex > -1 && firstIndex > -1) { 33 addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.WRONG_SCENE, ErrorValueInfo.ERROR_FILE_TAG_ORDER, 34 FileType.JSDOC, ErrorLevel.MIDDLE); 35 break; 36 } 37 } 38 }; 39} 40exports.checkFileTagOrder = checkFileTagOrder;