• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用方法
2
3## 1. get_subsystem_with_component.py
4
5### 功能
6获取子系统,部件,部件路径之间关系的脚本。
7输出示例:
8```json
9{
10    "arkui": [
11        {  "ace_engine_lite": "foundation/arkui/ace_engine_lite"  },
12        {  "napi": "foundation/arkui/napi"  },
13        {  "ace_engine": "foundation/arkui/ace_engine" }
14    ],
15    "ai": [
16        {  "ai_engine": "foundation/ai/engine"  },
17        {  "os_account": "base/account/os_account"  }
18    ]
19}
20```
21
22### 使用
23`python get_subsystem_with_component.py project_path [-o output_path]`
24
25其中 `project_path` 为要分析的工程路径,为必选选项,
26`-o output_path` 指定 `output_path` 为输出 json 文件所在目录,省略时默认为脚本所在目录。
27
28使用示例:
29```shell
30python get_subsystem_with_component.py project/path -o out/path
31```
32执行后会打印输出的 json 文件的路径。
33```
34Output path: out/path/subsystem_component_path.json
35```
36
37## 2. bundle_json_check.py
38
39### 功能
40检查 bundle.json 文件的准确性。遵循规则为 OpenHarmony 部件构建规范的**规则 2.1 部件描述文件中字段须准确。**
41默认输出 xlsx 文件格式示例:
42|子系统|部件|文件|违反规则|详细|说明|
43|---|---|---|---|---|---|
44|arkui|ace_engine_lite|founation/arkui/ace_engine_lite/bundle.json|规则2.1 部件描述文件中字段须准确|component:name|no such field.|
45
46### 使用
47```shell
48usage: bundle_json_check.py [-h] [--xls | --json] [-P PROJECT | -p PATH [PATH ...]] [-o OUTPUT]
49```
50`--xlsx 或 --json` 为可选参数。指定输出结果的格式,默认为 xlsx 格式。
51`-P PROJECT 与 -p PATH [PATH ...]` 为二选一的必选参数。其中 `-P`(大写)指定源码工程的根目录,`-p`(小写)指定一个或一组 bundle.json 文件路径。
52`-o` 为可选参数。指定输出文件的路径,默认为当前目录。
53
54### 注意
55- 使用 `-p`(小写)时,脚本直接打印 json 格式字符串在控制台(标准输出)。无法指定格式和路径。
56- 如果输出的 line (行号)为 0 时,表示没有找到该行。
57
58使用示例:
59```shell
60python bundle_json_check.py -P /path/to/project
61python bundle_josn_check.py -p a/bundle.json b/bundle.json
62```