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

Revert "添加systemapi和atomicservice互斥校验"，同步代码

Browse Source 
This reverts commit eb9f0591ec.

Signed-off-by: wangcaoyu <wangcaoyu@huawei.com>
This commit is contained in:
wangcaoyu 2024-09-04 10:40:55 +08:00
parent b75c7fa092
commit 8fe58627c2
12 changed files with 24 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt
View File

@ -121,7 +121,6 @@ buttonconfig
bypassed
bypassing
bytrace
backforward
callbackfn
camped
canceling
@ -165,6 +164,7 @@ compositing
compresses
concatenates
cone
concatenates
conferencing
confpersist
connectable
@ -786,7 +786,6 @@ pss
pssh
puk
pvr
qualities
quant
querier
queriers
@ -809,13 +808,13 @@ recovered
recovering
recovers
recursions
reclaimed
redefines
redirections
reenter
refill
refresher
refusing
regarded
rehandshake
rejects
relocation
@ -863,7 +862,6 @@ rtt
ruim
ruleset
rwt
resfile
s5
sac
sae
@ -906,6 +904,7 @@ sha1
shadertype
sharedarraybuffer
shenzhen
shrinks
shortkey
showcounter
shrinks
@ -917,6 +916,11 @@ singly
skews
slidable
sliderstyle
statvfs
stk
str
strokes
structurally
sm3
smil
smpte
@ -982,8 +986,8 @@ suscriber
suscribes
suspending
suspends
suspending
swanctl
switchmode
switchvideomode
symantec
symbolglyph
@ -999,7 +1003,6 @@ systemapp
systembar
systemsize
systemui
suspending
tabletype
tailoring
talkback

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

@ -636,7 +636,6 @@ 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;

6
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,8 +122,7 @@
"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_JSDOC_04": "The [systemapi] and [atomicservice] cannot exist in the same doc."
"API_DOC_UNKNOW_DECORATOR_01": "The [XXXX] tag does not exist. Please use a valid JSDoc tag."
},
"DEFINE": {
"API_DEFINE_UNALLOWABLE_01": "Illegal [any] keyword used in the API.",

2
build-tools/dts_parser/src/coreImpl/checker/config/dictionaries.json
View File

@ -48179,7 +48179,6 @@
"predominant",
"predominate",
"predomination",
"preexisting",
"preemie",
"preeminence",
"preeminent",
@ -48193,6 +48192,7 @@
"preexist",
"preexistence",
"preexistent",
"preexisting",
"pref",
"prefab",
"prefabbed",

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

@ -33,10 +33,6 @@ 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);
@ -251,25 +247,4 @@ 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);
}
}

4
build-tools/dts_parser/src/coreImpl/checker/src/tag_value_check.ts
View File

@ -133,11 +133,11 @@ export class TagValueCheck {
state: true,
errorInfo: '',
};
let extendsTagValue: string = tag.name + tag.description;
let extendsTagValue: string = tag.name;
if (singleApi.getApiType() === ApiType.CLASS || singleApi.getApiType() === ApiType.INTERFACE) {
const extendsApiValue: string = CommonFunctions.getExtendsApiValue(singleApi);
const ImplementsApiValue: string = CommonFunctions.getImplementsApiValue(singleApi);
if (tag.tag === 'extends' && extendsTagValue.replace(/\s/g, '') !== extendsApiValue) {
if (tag.tag === 'extends' && extendsTagValue !== extendsApiValue) {
extendsValueCheckResult.state = false;
extendsValueCheckResult.errorInfo = ErrorMessage.ERROR_INFO_VALUE_EXTENDS;
}

23
build-tools/dts_parser/src/coreImpl/diff/diff.ts
View File

@ -105,12 +105,12 @@ export class DiffHelper {
oldSourceFileInfo?.setSyscap(DiffHelper.getSyscapField(oldSourceFileInfo));
const oldKitInfo: string | undefined = oldSourceFileInfo?.getLastJsDocInfo()?.getKit();
//文件在新版本中被删除
if (!clonedNewSDKApiMap.get(key) && oldKitInfo !== 'NA') {
if (!clonedNewSDKApiMap.get(key) && oldKitInfo) {
diffInfos.push(
DiffProcessorHelper.wrapDiffInfo(
oldSourceFileInfo,
undefined,
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, ApiDiffType.KIT_HAVE_TO_NA, oldKitInfo, 'NA')
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, ApiDiffType.KIT_CHANGE, oldKitInfo, 'NA')
)
);
} else if (clonedNewSDKApiMap.get(key)) {
@ -121,7 +121,7 @@ export class DiffHelper {
DiffProcessorHelper.wrapDiffInfo(
oldSourceFileInfo,
newSourceFileInfo,
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, DiffHelper.getKitDiffType(oldKitInfo, newKitInfo), oldKitInfo, newKitInfo)
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, ApiDiffType.KIT_CHANGE, oldKitInfo, newKitInfo)
)
);
}
@ -131,31 +131,18 @@ export class DiffHelper {
for (const key of clonedNewSDKApiMap.keys()) {
const newSourceFileInfo: ApiInfo | undefined = DiffHelper.getSourceFileInfo(clonedNewSDKApiMap.get(key));
const newKitInfo: string | undefined = newSourceFileInfo?.getLastJsDocInfo()?.getKit();
if (!clonedOldSDKApiMap.get(key) && newKitInfo !== 'NA') {
if (!clonedOldSDKApiMap.get(key) && newKitInfo) {
diffInfos.push(
DiffProcessorHelper.wrapDiffInfo(
undefined,
newSourceFileInfo,
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, ApiDiffType.KIT_NA_TO_HAVE, 'NA', newKitInfo)
new DiffTypeInfo(ApiStatusCode.KIT_CHANGE, ApiDiffType.KIT_CHANGE, 'NA', newKitInfo)
)
);
}
}
}
static getKitDiffType(oldKitInfo: string | undefined, newKitInfo: string | undefined): ApiDiffType {
if (oldKitInfo === 'NA' && newKitInfo === '') {
return ApiDiffType.KIT_NA_TO_HAVE;
} else if (oldKitInfo === '' && newKitInfo === 'NA') {
return ApiDiffType.KIT_HAVE_TO_NA;
} else if (oldKitInfo === 'NA' || oldKitInfo === '') {
return ApiDiffType.KIT_NA_TO_HAVE;
} else if (newKitInfo === 'NA' || newKitInfo === '') {
return ApiDiffType.KIT_HAVE_TO_NA;
}
return ApiDiffType.KIT_CHANGE;
}
static getSourceFileInfo(fileMap: FileInfoMap | undefined): ApiInfo | undefined {
if (!fileMap) {
return undefined;

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

@ -148,7 +148,6 @@ 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.',

10
build-tools/dts_parser/src/typedef/diff/ApiInfoDiff.ts
View File

@ -682,8 +682,6 @@ export enum ApiDiffType {
ATOMIC_SERVICE_NA_TO_HAVE,
ATOMIC_SERVICE_HAVE_TO_NA,
PROPERTY_TYPE_SIGN_CHANGE,
KIT_HAVE_TO_NA,
KIT_NA_TO_HAVE,
}
export const diffTypeMap: Map<ApiDiffType, string> = new Map([
@ -770,8 +768,6 @@ export const diffTypeMap: Map<ApiDiffType, string> = new Map([
[ApiDiffType.SINCE_VERSION_HAVE_TO_NA, '起始版本有变化'],
[ApiDiffType.SINCE_VERSION_NA_TO_HAVE, '起始版本有变化'],
[ApiDiffType.KIT_CHANGE, 'kit变更'],
[ApiDiffType.KIT_HAVE_TO_NA, '删除kit'],
[ApiDiffType.KIT_NA_TO_HAVE, '新增kit'],
[ApiDiffType.ATOMIC_SERVICE_HAVE_TO_NA, 'API从支持元服务到不支持元服务'],
[ApiDiffType.ATOMIC_SERVICE_NA_TO_HAVE, 'API从不支持元服务到支持元服务'],
]);
@ -862,8 +858,6 @@ export const diffMap: Map<ApiDiffType, string> = new Map([
[ApiDiffType.HISTORICAL_JSDOC_CHANGE, '历史版本jsdoc变更'],
[ApiDiffType.HISTORICAL_API_CHANGE, '历史版本API变更'],
[ApiDiffType.KIT_CHANGE, 'kit变更'],
[ApiDiffType.KIT_HAVE_TO_NA, 'kit信息从有到无'],
[ApiDiffType.KIT_NA_TO_HAVE, 'kit信息从无到有'],
[ApiDiffType.ATOMIC_SERVICE_HAVE_TO_NA, 'API从支持元服务到不支持元服务'],
[ApiDiffType.ATOMIC_SERVICE_NA_TO_HAVE, 'API从不支持元服务到支持元服务'],
]);
@ -939,8 +933,6 @@ export const apiChangeMap: Map<ApiDiffType, string> = new Map([
[ApiDiffType.SINCE_VERSION_HAVE_TO_NA, 'API修改（约束变化）'],
[ApiDiffType.SINCE_VERSION_NA_TO_HAVE, 'API修改（约束变化）'],
[ApiDiffType.KIT_CHANGE, '非API变更'],
[ApiDiffType.KIT_HAVE_TO_NA, '非API变更'],
[ApiDiffType.KIT_NA_TO_HAVE, '非API变更'],
[ApiDiffType.ATOMIC_SERVICE_HAVE_TO_NA, 'API修改（约束变化）'],
[ApiDiffType.ATOMIC_SERVICE_NA_TO_HAVE, 'API修改（约束变化）'],
[ApiDiffType.TYPE_ALIAS_FUNCTION_RETURN_TYPE_ADD, 'API修改（原型修改）'],
@ -1011,8 +1003,6 @@ export const incompatibleApiDiffTypes: Set<ApiDiffType> = new Set([
ApiDiffType.SYSCAP_A_TO_B,
ApiDiffType.SYSCAP_HAVE_TO_NA,
ApiDiffType.SYSCAP_NA_TO_HAVE,
ApiDiffType.KIT_CHANGE,
ApiDiffType.KIT_HAVE_TO_NA,
]);
export const isNotApiSet: Set<string> = new Set([

4
build-tools/dts_parser/src/typedef/parser/ApiInfoDefination.ts
View File

@ -319,7 +319,7 @@ export class ApiInfo extends BasicApiInfo {
constructor(apiType: string = '', node: ts.Node, parentApi: BasicApiInfo | undefined) {
super(apiType, node, parentApi);
let parentKitInfo: string = 'NA';
let parentKitInfo: string = '';
let parentIsFile: boolean = false;
if (parentApi) {
parentKitInfo = this.getKitInfoFromParent(parentApi).kitInfo;
@ -342,7 +342,7 @@ export class ApiInfo extends BasicApiInfo {
getKitInfoFromParent(parentApi: BasicApiInfo): FileTag {
const parentApiInfo = parentApi as ApiInfo;
const jsDocInfos: Comment.JsDocInfo[] = parentApiInfo.getJsDocInfos();
let kitInfo: string | undefined = '';
let kitInfo: string = '';
let isFile: boolean = false;
jsDocInfos.forEach((jsDocInfo: Comment.JsDocInfo) => {
kitInfo = jsDocInfo.getKit();

4
build-tools/dts_parser/src/utils/checkUtils.ts
View File

@ -231,17 +231,15 @@ export class CommonFunctions {
}
static getExtendsApiValue(singleApi: ApiInfo): string {
let extendsApiValue: string = '';
const extendsApiValueArr: string[] = [];
const extendsApiArr: ParentClass[] = (singleApi as ClassInfo).getParentClasses();
if (extendsApiArr.length === 0) {
return extendsApiValue;
}
extendsApiArr.forEach(extendsApi => {
if (extendsApi.getExtendClass().length !== 0) {
extendsApiValueArr.push(extendsApi.getExtendClass());
extendsApiValue = extendsApi.getExtendClass();
}
});
extendsApiValue = extendsApiValueArr.join(',');
return extendsApiValue;
}