openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-07 06:03:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

添加systemapi和atomicservice互斥校验

Browse Source 
Signed-off-by: fanjiaojiao0729 <fanjiaojiao@huawei.com>
This commit is contained in:
fanjiaojiao0729 2024-07-26 14:57:45 +08:00
parent 2fc8a05b31
commit eb9f0591ec
5 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build-tools/api_check_plugin/src/utils.js
View File

@ -636,6 +636,7 @@ const ruleArr = ['API_DOC_ATOMICSERVICE_01',
'API_CHANGE_INCOMPATIBLE_34',
'API_CHANGE_INCOMPATIBLE_35',
'API_CHANGE_INCOMPATIBLE_36',
'API_DOC_JSDOC_04'
];
exports.ruleArr = ruleArr;

4
build-tools/dts_parser/package/JS_API_CHECK.js
View File

File diff suppressed because one or more lines are too long

3
build-tools/dts_parser/src/coreImpl/checker/config/api_check_config.json
View File

@ -122,7 +122,8 @@
"API_DOC_JSDOC_01": "Jsdoc needs to be added to the current API.",
"API_DOC_JSDOC_02": "JSDoc tag validity verification failed. Please confirm if the [since] tag is missing.JSDoc tag validity verification failed. Please confirm if the [syscap] tag is missing.",
"API_DOC_JSDOC_03": "Jsdoc has chinese.",
"API_DOC_UNKNOW_DECORATOR_01": "The [XXXX] tag does not exist. Please use a valid JSDoc tag."
"API_DOC_UNKNOW_DECORATOR_01": "The [XXXX] tag does not exist. Please use a valid JSDoc tag.",
"API_DOC_JSDOC_04": "The [systemapi] and [atomicservice] cannot exist in the same doc."
},
"DEFINE": {
"API_DEFINE_UNALLOWABLE_01": "Illegal [any] keyword used in the API.",

25
build-tools/dts_parser/src/coreImpl/checker/src/tag_legality_check.ts
View File

@ -33,6 +33,10 @@ export class LegalityCheck {
*/
static apiLegalityCheck(singleApi: ApiInfo, apiJsdoc: Comment.JsDocInfo): ErrorTagFormat[] {
const apiLegalityCheckResult: ErrorTagFormat[] = [];
//check systemapi and atomicservice
LegalityCheck.checkSystemapiAtomicservice(apiJsdoc, apiLegalityCheckResult);
const nodeInfo: ts.Node = singleApi.getNode() as ts.Node;
const apiLegalityTagsArray: string[] = apiLegalityCheckTypeMap.get(nodeInfo.kind) as string[];
const apiLegalityTagsSet: Set<string> = new Set(apiLegalityTagsArray);
@ -247,4 +251,25 @@ export class LegalityCheck {
});
return illegalTagsArray;
}
/**
* systemapi and atomicservice cannot exist at the same time
* @param apiJsdoc
*/
static checkSystemapiAtomicservice(apiJsdoc: Comment.JsDocInfo, apiLegalityCheckResult: ErrorTagFormat[]) {
const apiSystemapiAtomicservice: ErrorTagFormat = {
state: true,
errorInfo: '',
};
const tagsName: string[] = [];
apiJsdoc.tags?.forEach((tag: Comment.CommentTag) => {
tagsName.push(tag.tag);
})
const hasSystemapi: boolean = tagsName.includes('systemapi');
const hasAtomicservice: boolean = tagsName.includes('atomicservice');
if (hasSystemapi && hasAtomicservice) {
apiSystemapiAtomicservice.state=false;
apiSystemapiAtomicservice.errorInfo=ErrorMessage.ERROR_ERROR_SYSTEMAPI_ATOMICSERVICE;
}
apiLegalityCheckResult.push(apiSystemapiAtomicservice);
}
}

1
build-tools/dts_parser/src/typedef/checker/result_type.ts
View File

@ -148,6 +148,7 @@ export enum ErrorMessage {
ERROR_NO_JSDOC_TAG = 'add tags to the Jsdoc.',
ERROR_HAS_CHINESE = 'Jsdoc has chinese.',
ERROR_ERROR_CODE = 'The generic error code does not contain the current error code.',
ERROR_ERROR_SYSTEMAPI_ATOMICSERVICE = 'The [systemapi] and [atomicservice] cannot exist in the same doc.',
ERROR_CHANGES_JSDOC_LEVEL = 'Forbid changes: Cannot change from public API to system API.',
ERROR_CHANGES_JSDOC_PERMISSION_RANGE = 'Forbid changes: Cannot reduce or permission or increase and permission.',
ERROR_CHANGES_JSDOC_PERMISSION_VALUE = 'Forbid changes: Cannot change permission value,cannot judge the range change.',