• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1{
2  "DOC": {
3    "API_DOC_ATOMICSERVICE_01": "JSDoc label order error, please adjust the order of [atomicservice] labels.",
4    "API_DOC_ATOMICSERVICE_02": "The validity verification of the JSDoc tag failed. The [atomicservice] tag is not allowed to be reused, please delete the extra tags.",
5    "API_DOC_ATOMICSERVICE_03": "It was detected that there is a following label [atomicservice] in the current file, but the parent nodes without this label.",
6    "API_DOC_CONSTANT_01": "JSDoc label order error, please adjust the order of [constant] labels.",
7    "API_DOC_CONSTANT_02": "JSDoc label validity verification failed. The [constant] label is not allowed. Please check the label usage method.",
8    "API_DOC_CONSTANT_03": "JSDoc tag validity verification failed. Please confirm if the [constant] tag is missing.",
9    "API_DOC_CONSTANT_04": "The validity verification of the JSDoc tag failed. The [constant] tag is not allowed to be reused, please delete the extra tags.",
10    "API_DOC_CROSSPLATFORM_01": "JSDoc label order error, please adjust the order of [crossplatform] labels.",
11    "API_DOC_CROSSPLATFORM_02": "The validity verification of the JSDoc tag failed. The [crossplatform] tag is not allowed to be reused, please delete the extra tags.",
12    "API_DOC_CROSSPLATFORM_03": "It was detected that there is an inheritable label [crossplatform] in the current file, but there are child nodes without this label.",
13    "API_DOC_DEFAULT_01": "The [default] tag value is incorrect. Please supplement the default value.",
14    "API_DOC_DEFAULT_02": "JSDoc label order error, please adjust the order of [default] labels.",
15    "API_DOC_DEFAULT_03": "JSDoc label validity verification failed. The [default] label is not allowed. Please check the label usage method.",
16    "API_DOC_DEFAULT_04": "The validity verification of the JSDoc tag failed. The [default] tag is not allowed to be reused, please delete the extra tags.",
17    "API_DOC_DEPRECATED_01": "The [deprecated] tag value is incorrect. Please check the usage method.",
18    "API_DOC_DEPRECATED_02": "JSDoc label order error, please adjust the order of [deprecated] labels.",
19    "API_DOC_DEPRECATED_03": "It was detected that there is an inheritable label [deprecated] in the current file, but there are child nodes without this label.",
20    "API_DOC_DEPRECATED_04": "The validity verification of the JSDoc tag failed. The [deprecated] tag is not allowed to be reused, please delete the extra tags.",
21    "API_DOC_ENUM_01": "The [enum] tag type is incorrect. Please check if the tag type is { string } or { number }.",
22    "API_DOC_ENUM_02": "JSDoc label order error, please adjust the order of [enum] labels.",
23    "API_DOC_ENUM_03": "JSDoc label validity verification failed. The [enum] label is not allowed. Please check the label usage method.",
24    "API_DOC_ENUM_04": "JSDoc tag validity verification failed. Please confirm if the [enum] tag is missing.",
25    "API_DOC_ENUM_05": "The validity verification of the JSDoc tag failed. The [enum] tag is not allowed to be reused, please delete the extra tags.",
26    "API_DOC_EXAMPLE_01": "JSDoc label order error, please adjust the order of [example] labels.",
27    "API_DOC_EXAMPLE_02": "The validity verification of the JSDoc tag failed. The [example] tag is not allowed to be reused, please delete the extra tags.",
28    "API_DOC_EXTENDS_01": "The [extends] tag value is incorrect. Please check if the tag value matches the inherited class name.",
29    "API_DOC_EXTENDS_02": "JSDoc label order error, please adjust the order of [extends] labels.",
30    "API_DOC_EXTENDS_03": "JSDoc label validity verification failed. The [extends] label is not allowed. Please check the label usage method.",
31    "API_DOC_EXTENDS_04": "JSDoc tag validity verification failed. Please confirm if the [extends] tag is missing.",
32    "API_DOC_EXTENDS_05": "The validity verification of the JSDoc tag failed. The [extends] tag is not allowed to be reused, please delete the extra tags.",
33    "API_DOC_FAMODELONLY_01": "JSDoc label order error, please adjust the order of [famodelonly] labels.",
34    "API_DOC_FAMODELONLY_02": "The validity verification of the JSDoc tag failed. The [famodelonly] tag is not allowed to be reused, please delete the extra tags.",
35    "API_DOC_FAMODELONLY_03": "It was detected that there is an inheritable label [famodelonly] in the current file, but there are child nodes without this label.",
36    "API_DOC_FIRES_01": "JSDoc label order error, please adjust the order of [fires] labels.",
37    "API_DOC_FIRES_02": "The validity verification of the JSDoc tag failed. The [fires] tag is not allowed to be reused, please delete the extra tags.",
38    "API_DOC_FORM_01": "JSDoc label order error, please adjust the order of [form] labels.",
39    "API_DOC_FORM_02": "The validity verification of the JSDoc tag failed. The [form] tag is not allowed to be reused, please delete the extra tags.",
40    "API_DOC_FORM_03": "It was detected that there is a following label [form] in the current file, but the parent nodes without this label.",
41    "API_DOC_IMPLEMENTS_01": "JSDoc label order error, please adjust the order of [implements] labels.",
42    "API_DOC_IMPLEMENTS_02": "JSDoc label validity verification failed. The [implements] label is not allowed. Please check the label usage method.",
43    "API_DOC_IMPLEMENTS_03": "JSDoc tag validity verification failed. Please confirm if the [implements] tag is missing.",
44    "API_DOC_IMPLEMENTS_04": "The validity verification of the JSDoc tag failed. The [implements] tag is not allowed to be reused, please delete the extra tags.",
45    "API_DOC_IMPLEMENTS_05": "The [implements] tag value is incorrect. Please check if the tag value matches the inherited class name.",
46    "API_DOC_INTERFACE_04": "JSDoc label order error, please adjust the order of [interface] labels.",
47    "API_DOC_INTERFACE_05": "The validity verification of the JSDoc tag failed. The [interface] tag is not allowed to be reused, please delete the extra tags.",
48    "API_DOC_NAMESPACE_01": "The [namespace] tag value is incorrect. Please check if it matches the namespace name.",
49    "API_DOC_NAMESPACE_02": "JSDoc label order error, please adjust the order of [namespace] labels.",
50    "API_DOC_NAMESPACE_03": "JSDoc tag validity verification failed. Please confirm if the [namespace] tag is missing.",
51    "API_DOC_NAMESPACE_04": "JSDoc label validity verification failed. The [namespace] label is not allowed. Please check the label usage method.",
52    "API_DOC_NAMESPACE_05": "The validity verification of the JSDoc tag failed. The [namespace] tag is not allowed to be reused, please delete the extra tags.",
53    "API_DOC_PARAM_01": "The type of the [1] [param] tag is incorrect. Please check if it matches the type of the [1] parameter.",
54    "API_DOC_PARAM_02": "The value of the [1] [param] tag is incorrect. Please check if it matches the [1] parameter name.",
55    "API_DOC_PARAM_03": "JSDoc tag validity verification failed.There are [1] redundant [param]. Please check if the tag should be deleted.",
56    "API_DOC_PARAM_04": "JSDoc tag validity verification failed. Please confirm if the [param] tag is missing.",
57    "API_DOC_PARAM_05": "JSDoc label validity verification failed. The [param] label is not allowed. Please check the label usage method.",
58    "API_DOC_PARAM_06": "JSDoc label order error, please adjust the order of [param] labels.",
59    "API_DOC_PERMISSION_01": "The [permission] tag value is incorrect. Please check if the permission field has been configured or update the configuration file.",
60    "API_DOC_PERMISSION_02": "JSDoc label order error, please adjust the order of [permission] labels.",
61    "API_DOC_PERMISSION_03": "JSDoc label validity verification failed. The [permission] label is not allowed. Please check the label usage method.",
62    "API_DOC_PERMISSION_04": "The validity verification of the JSDoc tag failed. The [permission] tag is not allowed to be reused, please delete the extra tags.",
63    "API_DOC_PERMISSION_05": "JSDoc tag validity verification failed. Please confirm if the [permission] tag is missing.",
64    "API_DOC_READONLY_01": "JSDoc label order error, please adjust the order of [readonly] labels.",
65    "API_DOC_READONLY_02": "JSDoc label validity verification failed. The [readonly] label is not allowed. Please check the label usage method.",
66    "API_DOC_READONLY_03": "The validity verification of the JSDoc tag failed. The [readonly] tag is not allowed to be reused, please delete the extra tags.",
67    "API_DOC_READONLY_04": "JSDoc tag validity verification failed. Please confirm if the [readonly] tag is missing.",
68    "API_DOC_RETURNS_01": "The [returns] tag was used incorrectly. The returns tag should not be used when the return type is void.",
69    "API_DOC_RETURNS_02": "The [returns] tag type is incorrect. Please check if the tag type is consistent with the return type.",
70    "API_DOC_RETURNS_03": "JSDoc label order error, please adjust the order of [returns] labels.",
71    "API_DOC_RETURNS_04": "JSDoc tag validity verification failed. Please confirm if the [returns] tag is missing.",
72    "API_DOC_RETURNS_05": "The validity verification of the JSDoc tag failed. The [returns] tag is not allowed to be reused, please delete the extra tags.",
73    "API_DOC_RETURNS_06": "JSDoc label validity verification failed. The [returns] label is not allowed. Please check the label usage method.",
74    "API_DOC_SINCE_01": "The [since] tag value is incorrect. Please check if the tag value is a numerical value.",
75    "API_DOC_SINCE_02": "JSDoc label order error, please adjust the order of [since] labels.",
76    "API_DOC_SINCE_03": "JSDoc tag validity verification failed. Please confirm if the [since] tag is missing.",
77    "API_DOC_SINCE_04": "The validity verification of the JSDoc tag failed. The [since] tag is not allowed to be reused, please delete the extra tags.",
78    "API_DOC_SINCE_05": "The [since] value is greater than the latest version number.",
79    "API_DOC_SINCE_06": "The [since] value for different jsdoc should not be the same.",
80    "API_DOC_SINCE_07": "The [since] value is greater than the latest version number.The [since] value for different jsdoc should not be the same.",
81    "API_DOC_SINCE_08": "The [since] tag value is incorrect. Please check if the tag value is a numerical value.The [since] value for different jsdoc should not be the same.",
82    "API_DOC_STAGEMODELONLY_01": "It was detected that there is an inheritable label [stagemodelonly] in the current file, but there are child nodes without this label.",
83    "API_DOC_STAGEMODELONLY_02": "JSDoc label order error, please adjust the order of [stagemodelonly] labels.",
84    "API_DOC_STAGEMODELONLY_03": "The validity verification of the JSDoc tag failed. The [stagemodelonly] tag is not allowed to be reused, please delete the extra tags.",
85    "API_DOC_STATIC_01": "JSDoc label order error, please adjust the order of [static] labels.",
86    "API_DOC_STATIC_02": "The validity verification of the JSDoc tag failed. The [static] tag is not allowed to be reused, please delete the extra tags.",
87    "API_DOC_STRUCT_01": "The [struct] tag value is incorrect. Please check if it matches the struct name.",
88    "API_DOC_STRUCT_02": "JSDoc label order error, please adjust the order of [struct] labels.",
89    "API_DOC_STRUCT_03": "JSDoc label validity verification failed. The [struct] label is not allowed. Please check the label usage method.",
90    "API_DOC_STRUCT_04": "JSDoc tag validity verification failed. Please confirm if the [struct] tag is missing.",
91    "API_DOC_STRUCT_05": "The validity verification of the JSDoc tag failed. The [struct] tag is not allowed to be reused, please delete the extra tags.",
92    "API_DOC_SYSCAP_01": "The [syscap] tag value is incorrect. Please check if the syscap field is configured.",
93    "API_DOC_SYSCAP_02": "JSDoc label order error, please adjust the order of [syscap] labels.",
94    "API_DOC_SYSCAP_03": "JSDoc tag validity verification failed. Please confirm if the [syscap] tag is missing.",
95    "API_DOC_SYSCAP_04": "The validity verification of the JSDoc tag failed. The [syscap] tag is not allowed to be reused, please delete the extra tags.",
96    "API_DOC_SYSTEMAPI_01": "JSDoc label order error, please adjust the order of [systemapi] labels.",
97    "API_DOC_SYSTEMAPI_02": "It was detected that there is an inheritable label [systemapi] in the current file, but there are child nodes without this label.",
98    "API_DOC_SYSTEMAPI_03": "The validity verification of the JSDoc tag failed. The [systemapi] tag is not allowed to be reused, please delete the extra tags.",
99    "API_DOC_TEST_01": "JSDoc label order error, please adjust the order of [test] labels.",
100    "API_DOC_TEST_02": "It was detected that there is an inheritable label [test] in the current file, but there are child nodes without this label.",
101    "API_DOC_TEST_03": "The validity verification of the JSDoc tag failed. The [test] tag is not allowed to be reused, please delete the extra tags.",
102    "API_DOC_THROWS_01": "The type of the [1] [throws] tag is incorrect. Please check if the tag value is a numerical value.",
103    "API_DOC_THROWS_02": "The type of the [1] [throws] tag is incorrect. Please fill in [BusinessError].",
104    "API_DOC_THROWS_03": "JSDoc label order error, please adjust the order of [throws] labels.",
105    "API_DOC_THROWS_04": "JSDoc label validity verification failed. The [throws] label is not allowed. Please check the label usage method.",
106    "API_DOC_THROWS_05": "JSDoc tag validity verification failed. Please confirm if the [throws 1] tag is missing.",
107    "API_DOC_THROWS_07": "JSDoc label validity verification failed. The [throws 1] label is not allowed. Please check the label usage method.",
108    "API_DOC_THROWS_08": "The validity verification of the JSDoc tag failed. The [throws] tag is not allowed to be reused, please delete the extra tags.",
109    "API_DOC_THROWS_09": "The generic error code does not contain the current error code.",
110    "API_DOC_THROWS_10": "The description of the [1 throws] is incorrect. please fix it according to the specification.",
111    "API_DOC_THROWS_11": "The type of the [1] [throws] tag is incorrect. Please fill in [BusinessError].The description of the [1 throws] is incorrect. please fix it according to the specification.",
112    "API_DOC_TYPE_01": "The [type] tag type is incorrect. Please check if the type matches the attribute type.",
113    "API_DOC_TYPE_02": "JSDoc label order error, please adjust the order of [type] labels.",
114    "API_DOC_TYPE_03": "JSDoc label validity verification failed. The [type] label is not allowed. Please check the label usage method.",
115    "API_DOC_TYPE_04": "JSDoc tag validity verification failed. Please confirm if the [type] tag is missing.",
116    "API_DOC_TYPE_05": "The validity verification of the JSDoc tag failed. The [type] tag is not allowed to be reused, please delete the extra tags.",
117    "API_DOC_TYPEDEF_01": "The [typedef] tag value is incorrect. Please check if it matches the interface name or type content.",
118    "API_DOC_TYPEDEF_02": "JSDoc label order error, please adjust the order of [typedef] labels.",
119    "API_DOC_TYPEDEF_03": "JSDoc label validity verification failed. The [typedef] label is not allowed. Please check the label usage method.",
120    "API_DOC_TYPEDEF_04": "JSDoc tag validity verification failed. Please confirm if the [typedef] tag is missing.",
121    "API_DOC_TYPEDEF_05": "The validity verification of the JSDoc tag failed. The [typedef] tag is not allowed to be reused, please delete the extra tags.",
122    "API_DOC_USEINSTEAD_01": "The [useinstead] tag value is incorrect. Please check the usage method.",
123    "API_DOC_USEINSTEAD_02": "JSDoc label order error, please adjust the order of [useinstead] labels.",
124    "API_DOC_USEINSTEAD_03": "JSDoc label validity verification failed. The [useinstead] label is not allowed. Please check the label usage method.",
125    "API_DOC_USEINSTEAD_04": "The validity verification of the JSDoc tag failed. The [useinstead] tag is not allowed to be reused, please delete the extra tags.",
126    "API_DOC_GLOBAL_01": "JSDoc tag validity verification failed. Please confirm if the [file] tag is missing.",
127    "API_DOC_GLOBAL_02": "JSDoc tag validity verification failed. Please confirm if the [kit] tag is missing.",
128    "API_DOC_JSDOC_01": "Jsdoc needs to be added to the current API.",
129    "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.",
130    "API_DOC_JSDOC_03": "Jsdoc has chinese.",
131    "API_DOC_UNKNOW_DECORATOR_01": "The [XXXX] tag does not exist. Please use a valid JSDoc tag.",
132    "API_DOC_JSDOC_04": "The [systemapi] and [atomicservice] cannot exist in the same doc."
133  },
134  "DEFINE": {
135    "API_DEFINE_UNALLOWABLE_01": "Illegal [any] keyword used in the API.",
136    "API_DEFINE_UNALLOWABLE_02": "Illegal [this] keyword used in the API.",
137    "API_DEFINE_UNALLOWABLE_03": "Illegal [unknown] keyword used in the API.",
138    "API_DEFINE_NAME_01": "Prohibited word in [XXXX]:{option}.The word allowed is [XXXX].",
139    "API_DEFINE_NAME_02": "Prohibited word in [XXXX]:{ability} in the [XXXX] file.",
140    "API_DEFINE_SPELLING_01": "{XXXX}. please confirm whether it needs to be corrected to a common word.",
141    "API_DEFINE_EVENT_01": "The event name should be string.",
142    "API_DEFINE_EVENT_02": "The event name cannot be Null value.",
143    "API_DEFINE_EVENT_03": "The callback parameter of off function should be optional.",
144    "API_DEFINE_EVENT_04": "The off functions of one single event should have at least one callback parameter, and the callback parameter should be the last parameter.",
145    "API_DEFINE_EVENT_05": "The on and off event subscription methods do not appear in pair.",
146    "API_DEFINE_EVENT_06": "The event subscription methods should has at least one parameter.",
147    "API_DEFINE_EVENT_07": "Please check if the changed API version number is 10.",
148    "API_DEFINE_EVENT_08": "The event name should be named by small hump. (Received [XXXX]).",
149    "API_DEFINE_HUMP_01": "This API file should be named by large hump.",
150    "API_DEFINE_HUMP_02": "This API file should be named by small hump.",
151    "API_DEFINE_HUMP_03": "This name [XXXX] should be named by large hump.",
152    "API_DEFINE_HUMP_04": "This name [XXXX] should be named by small hump.",
153    "API_DEFINE_HUMP_05": "This name [XXXX] should be named by all uppercase.",
154    "API_DEFINE_ANONYMOUS_FUNCTION_01": "Anonymous functions or anonymous object that are not allowed are used in this api."
155  },
156  "CHANEGE": {
157    "API_CHANGE_INCOMPATIBLE_01": "Forbid changes: Cannot change from public API to system API.",
158    "API_CHANGE_INCOMPATIBLE_02": "Forbid changes: Cannot reduce or permission or increase and permission.",
159    "API_CHANGE_INCOMPATIBLE_03": "Forbid changes: Cannot change permission value,cannot judge the range change.",
160    "API_CHANGE_INCOMPATIBLE_04": "Forbid changes: The number of error codes cannot be increased from 1 to multiple error codes.",
161    "API_CHANGE_INCOMPATIBLE_05": "Forbid changes: Cannot change the error code value.",
162    "API_CHANGE_INCOMPATIBLE_06": "Forbid changes: The card application cannot be changed from supported to not supported.",
163    "API_CHANGE_INCOMPATIBLE_07": "Forbid changes: Crossplatform cannot be changed from supported to not supported.",
164    "API_CHANGE_INCOMPATIBLE_08": "Forbid changes: API cannot be deleted.",
165    "API_CHANGE_INCOMPATIBLE_09": "Forbid changes: Cannot change from FAModelOnly to StageModelOnly.",
166    "API_CHANGE_INCOMPATIBLE_10": "Forbid changes: Cannot change from StageModelOnly to FAModelOnly.",
167    "API_CHANGE_INCOMPATIBLE_11": "Forbid changes: Cannot change from nothing to StageModelOnly.",
168    "API_CHANGE_INCOMPATIBLE_12": "Forbid changes: Cannot change from nothing to FAModelOnly.",
169    "API_CHANGE_INCOMPATIBLE_13": "Forbid changes: The function return value type cannot be extended.",
170    "API_CHANGE_INCOMPATIBLE_14": "Forbid changes: The function return value type cannot be reduced.",
171    "API_CHANGE_INCOMPATIBLE_15": "Forbid changes: Cannot change function return value type.",
172    "API_CHANGE_INCOMPATIBLE_16": "Forbid changes: Cannot change function param position.",
173    "API_CHANGE_INCOMPATIBLE_17": "Forbid changes: Cannot add function required param.",
174    "API_CHANGE_INCOMPATIBLE_18": "Forbid changes: Cannot delete function param.",
175    "API_CHANGE_INCOMPATIBLE_19": "Forbid changes: Cannot change form unrequired param to required param.",
176    "API_CHANGE_INCOMPATIBLE_20": "Forbid changes: Cannot change function param type.",
177    "API_CHANGE_INCOMPATIBLE_21": "Forbid changes: The function param type range is cannot be reduced.",
178    "API_CHANGE_INCOMPATIBLE_22": "Forbid changes: Read-only properties cannot be changed from optional to required.",
179    "API_CHANGE_INCOMPATIBLE_23": "Forbid changes: Writable properties cannot be changed from required to optional.",
180    "API_CHANGE_INCOMPATIBLE_24": "Forbid changes: Writable properties cannot be changed from optional to required.",
181    "API_CHANGE_INCOMPATIBLE_25": "Forbid changes: Cannot change property type.",
182    "API_CHANGE_INCOMPATIBLE_26": "Forbid changes: Cannot Expand the range of readonly property types.",
183    "API_CHANGE_INCOMPATIBLE_27": "Forbid changes: Cannot Expand the range of writable property types.",
184    "API_CHANGE_INCOMPATIBLE_28": "Forbid changes: Cannot reduce the range of writable property types.",
185    "API_CHANGE_INCOMPATIBLE_29": "Forbid changes: Decorator cannot be deleted.",
186    "API_CHANGE_INCOMPATIBLE_30": "Forbid changes: Cannot change constant value.",
187    "API_CHANGE_INCOMPATIBLE_31": "Forbid changes: Cannot change custom type value.",
188    "API_CHANGE_INCOMPATIBLE_32": "Forbid changes: Cannot expand the range of custom type.",
189    "API_CHANGE_INCOMPATIBLE_33": "Forbid changes: Cannot reduce the range of custom type.",
190    "API_CHANGE_INCOMPATIBLE_34": "Forbid changes: Cannot change Enumeration assignment.",
191    "API_CHANGE_INCOMPATIBLE_35": "Forbid changes: Historical JSDoc cannot be changed.",
192    "API_CHANGE_INCOMPATIBLE_36": "Forbid changes: API changes must add a new section of JSDoc.",
193    "API_CHANGE_INCOMPATIBLE_37": "Forbid changes: Cannot change from atomicservice to NA.",
194    "API_CHANGE_INCOMPATIBLE_38": "Forbid changes: Cannot change from NA to syscap.",
195    "API_CHANGE_INCOMPATIBLE_39": "Forbid changes: Cannot change from syscap to NA.",
196    "API_CHANGE_INCOMPATIBLE_40": "Forbid changes: Cannot change syscap value.",
197    "API_CHANGE_INCOMPATIBLE_41":"Forbid changes: Cannot add new property to interface API."
198  }
199}