idlize
IDLizer
Description
This folder contains collection of tools for analyzing and transformation of .d.ts files, with aim of exposing ArkUI interfaces to more languages and runtimes.
Tools available
Peer generator
Prerequisites:
cd idlizenpm inpm run compile
Generating libace interface files:
Given interface definitions it will produce for libace
- For libace interface
- arkoala_api.h header
- api discovery code
- component modifiers
- etc
node . --dts2peer --input-dir sdk/component --generator-target libace --api-version 140
Generating high level language peer files:
Given interface definitions it will produce for Arkoala
- For high language bindings (arkoala)
- C++ glue code
- high level language peer classes (TS, ArkTS, Java, etc)
- etc
node . --dts2peer --input-dir sdk/component --generator-target arkoala --api-version 140
To test for full sdk
cd idlizenpm inpm run check:peers:run
The output is in
directory
To test with a simple subset sdk
cd idlizenpm inpm run check:subset:run
The output is in
directory
.d.ts linter
Tool checking that given folder (ArkUI interface declarations downloaded by Arkoala build by default) only contains reasonable set of TypeScript features allowed for usage in public interfaces.
To run
cd idlizenpm inpm run compilenode . --linter --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component
Results are in
if
parameter specified, otherwise printed to stdout.
If there are no unsuppressed errors - exit code is 1, otherwise it is 0.
Linter support whitelist files in JSON:
{ "suppressErrors": ["TYPE_ELEMENT_TYPE", "INDEX_SIGNATURE"], "suppressIdentifiers": { "cursorControl": ["NAMESPACE"] }}
can be passed with
.
IDL generator
Tool producing set of WebIDL-compatible interface definitions from .d.ts interface definitions. Still in progress, may produce incorrect IDL.
cd idlizenpm inpm run compilenode . --dts2idl --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component
Results are in
folder.
C headers generator
Tool producing set of C interface definitions from .d.ts interface definitions. Still in progress, will produce incorrect C now.
cd idlizenpm inpm run compilenode . --idl2h --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component
Results are in
.
Typescript declaration files generator
Tool producing set of typescript declaration files from .idl interface definitions.
cd idlizenpm inpm run compilenode . --idl2dts --input-dir ./test/from-idl/idl
By default, results are in
.
Tests
Use the
environment variable to set a predefined seed for the random generator used in tests.
Set the
environment variable to
to use a random seed.
Configure and run the subset fuzzing tests:
npm run configure:native-node-host-subsetnpm run check:subset:fuzz
To test a specific test or method in fuzzing tests use
and
options in the
task:
node . --dts2test --input-dir ./tests/subset/ets --output-dir ./generated/fuzz --test-interface Test --test-method testBoolean