目录

Configuring arkOptions in build-profile.json5

Overview

arkOptions mainly provides ArkTS compilation-related configurations. This document describes the types configuration type and the maxFlowDepth configuration for the maximum control flow analysis depth in arkOptions. For other configuration items in arkOptions, see build-profile.json5.

types

[h2]Description

Field types in arkOptions

Name Description Configuration Scope Data Type Optional
types Specifies type declaration files to be globally imported, avoiding the need to import them individually in each source file. Module-level Array Optional, defaults to an empty array

[h2]Example

Below provides an example configuration of the types Field in arkOptions.

Add the types field to the arkOptions property in the buildOption section of the module-level build-profile.json5 file.

// In /entry/build-profile.json5
"arkOptions": {
  "types": ["pako", "./oh_modules/@types/mime", "./src/main/ets/pages/global"]
}

The types field supports specifying a package name, a relative path to a package, or a relative path to a declaration file. The type search scope is limited to the current module. If files with the same name (different extensions) exist in a directory, the default loading order is .d.ets > .d.ts, that is, files with the .d.ets extension are loaded first.

  1. Package name method: search for the declaration file defined by the package name in the oh_modules/@types/ directory, for example, "pako".

  2. Relative path to a package method: supports searching for the declaration file defined in a relative path based on build-profile.json5, for example, "./oh_modules/@types/mime".

  3. Relative path to a declaration file method: supports searching for the declaration file in a relative path, for example, "./src/main/ets/pages/global".

[h2]Precautions

If you specify a package name or a relative path to a package in the types field, configure the dependencies field in the oh-package.json5 file under the entry module as follows:

"dependencies": {
  "@types/pako": "latest",
  "@types/mime": "latest"
}

If you specify a relative path to a declaration file in the types field, ensure the corresponding declaration file exists in the module. Below is the content of a declaration file named global.d.ts in src/main/ets/pages:

declare namespace Global {
  type ObjectType = string | number;
}

After configuring types, you can use these global types in your code:

// In entry/src/main/ets/pages/Index.ets
let testPako: pako.constants = 0;
let testMime: mime.TypeMap = {};
let testGlobal: Global.ObjectType = 'test';

maxFlowDepth

[h2]Description

Configuration file tag description of the maxFlowDepth field in tscConfig under arkOptions:

Name Description Configuration Scope Data Type Optional
maxFlowDepth Developers use the maxFlowDepth field to customize the maximum depth of tsc control flow analysis during tsc compilation, avoiding compilation errors caused by a fixed maximum depth. The minimum configurable value of this configuration item is 2000, and the maximum configurable value is 65535. Project-level Numeric This tag can be omitted. When omitted, the default maximum depth of tsc control flow analysis, 2000, is used.

[h2]Example

Display of the maxFlowDepth field in arkOptions/tscConfig.

Add the maxFlowDepth field to the arkOptions/tscConfig property in the buildOption tag of the build-profile.json5 configuration file in the project-level directory.

// In projectName/build-profile.json5
"arkOptions": {
  "tscConfig": {
    "maxFlowDepth": 2222
  }
}

[h2]Precautions

transformLib

[h2]Description

Field transformLib in arkOptions

Name Description Configuration Scope Data Type Optional
transformLib Specifies the bytecode instrumentation plugin configuration, allowing you to modify bytecode during compilation. This field is supported only in the stage model. The format is a relative path to the dynamic library that does the instrumentation. The dynamic library must be generated on the corresponding platform and cannot be copied or renamed across platforms. Module-level String Optional, defaults to not using this feature

[h2]Example

Below provides an example configuration of the transformLib Field in arkOptions.

Add the transformLib field to the arkOptions property in the buildOption section of the module-level build-profile.json5 file.

{
  "buildOption": {
    "arkOptions": {
      "transformLib": "./dll/example.dll"
    }
  }
}

For details about how to modify Ark bytecode, see Customizing Ark Bytecode During Compilation.

[h2]Precautions