Build system

The build system is designed to compile ArkTS1.2 source files. It takes source files and build configurations as input, compiles the source files, invokes plugins for transformation, and generates a merged bytecode file.

env

USE_KOALA_LIBARKTS - use libarkts from koala_mirror USE_KOALA_UI_PLUGIN - use ui-plugin from koala_mirror USE_KOALA_MEMO_PLUGIN - use memo-plugin from koala_mirror

How to Run

The build system has two usage scenarios:

1. Compiling the Deveco Project: The build system is initiated by hvigor, which calls the build method in the entry.js file, passing in the projectConfig object to perform the compilation.

2. Compiling the Local Test Project: The build system is initiated by executing node entry.js, where the build_config.json file is passed as a compilation parameter to perform the compilation. The build_config.json is a mock to the projectConfig for scenario 1.

Below are the steps for compiling the local test project:

step 1

Mock sdk There are 2 methods to mock sdk locally.
Method 1: use soft links

mkdir -p test/mock_sdk/build-tools/ets2panda
cd test/mock_sdk/build-tools/ets2panda
ln -s ${path_to_ets2panda_lib} lib
ln -s ${path_to_ets2panda_stdlib} lib/stdlib
ln -s ${path_to_ets2panda_bin} bin

Method 2: specify pandaSdkPath and pandaStdlibPath in build_config.json

step 2

Mock koala-wrapper Modify initKoalaModules method in src/init/init_koala_modules.ts, set the libarktsPath to the actual path in your environment. In OpenHarmony repo, it is now resides in ${path_to_oh_root}/developtools/ace_ets2bundle/ets1.2/libarkts

step 3

Build build system source code

npm install
npm run build

step 4

Build specify local test project.
In test directory, there are some demo projects. Each project has its own build_config.json.
Replace the path to your own path before running. For example, use sed command in linux:

sed -i 's|${absolute_path_to_build_system}|'"$(pwd)"'|g' test/*/build_config.json

Then run the following command to build

npm run mixed_hap:gen_abc  # build demo_mix_hap
npm run demo_hap:gen_abc   # build demo_hap

step 5

Run tests (using Jest) Jest is almost ready to use out of the box. The test file path has been configured through jest.config.js. In the build_system/test directory, scan for test files with the suffix .test.ts Install Jest and its TypeScript support libraries. If execute npm run test:all, must first install npm-run-all, and enabling concurrency is a necessary condition

npm install --save-dev jest ts-jest @types/jest

To run tests:

npm run ut_test
npm run plugin_test

Performance Analysis

The switch of performance analysis is located in the file arkcompiler/ets_frontend/ets2panda/driver/build_system/src/utils/record_time_mem.ts To open the switch, change recordType to ON_TYPE.

this.recordType = recordType ?? RECORD_TYPE.ON_TYPE

And the report, named bs_record_perf.csv, is located in the project root directory.

How to use build system without plugins

Target:

  ninja ts_bindings ark_link dependency_analyzer

ENVIRONMENT:

export LD_LIBRARY_PATH=/build/lib

Build ts-bindings:

  cd ets2panda/bindings
  npm i
  npm run run

Build build system source code

cd ets2panda/driver/build_system
npm install
npm run build

Usage

$(which node) ets2panda/driver/build_system/dist/entry.js [build config json file]