@azanat/idlize v1.2.4

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

.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 idlize
npm i
npm run compile
node . --linter --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./<outputDir>/linter.txt if --output-dir 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 --linter-whitelist whitelist.json.

IDL generator

Tool producing set of WebIDL-compatible interface definitions from .d.ts interface definitions. Still in progress, may produce incorrect IDL.

cd idlize
npm i
npm run compile
node . --dts2idl --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./idl/ 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 idlize
npm i
npm run compile
node . --idl2h --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./headers/arkoala_api.h.

Typescript declaration files generator

Tool producing set of typescript declaration files from .idl interface definitions.

cd idlize
npm i
npm run compile
node . --idl2dts --input-dir ./test/from-idl/idl

By default, results are in ./dts.

Tests

Use the IDLIZE_SEED environment variable to set a predefined seed for the random generator used in tests. Set the IDLIZE_SEED environment variable to RANDOM to use a random seed.

Configure and run the subset fuzzing tests:

npm run configure:native-node-host-subset
npm run check:subset:fuzz

To test a specific test or method in fuzzing tests use --test-interface and --test-method options in the check:subset:fuzz task:

node . --dts2test --input-dir ./tests/subset/ets  --output-dir ./generated/fuzz --test-interface Test --test-method testBoolean