• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2025 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
16import * as arkts from '@koalaui/libarkts';
17
18export type FixSuggestion = {
19  range: [start: arkts.SourcePosition, end: arkts.SourcePosition];
20  code: string;
21};
22
23export type ReportOptions = {
24  node: arkts.AstNode;
25  message: string;
26  data?: Record<string, string>;
27  fix?: (node: arkts.AstNode) => FixSuggestion;
28};
29
30export type UISyntaxRuleContext = {
31  report(options: ReportOptions): void;
32  containerComponents?: Set<string> | undefined;
33};
34
35export type UISyntaxRuleHandler = (node: arkts.AstNode) => void;
36
37export type UISyntaxRule = {
38  name: string;
39  messages: Record<string, string>;
40  setup(context: UISyntaxRuleContext): {
41    parsed?: UISyntaxRuleHandler;
42  };
43};
44