# arkts-compiler

**Repository Path**: gorshenevalexander/arkts-compiler

## Basic Information

- **Project Name**: arkts-compiler
- **Description**: A multiplatform ArkTS compiler
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-23
- **Last Updated**: 2026-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# arkts-compiler

An ArkTS compiler written in a restricted subset of TypeScript.

The target language is ArkTS 1.2, the static, nominally typed version of the language.
The reference workload is the arkui3 UI framework, and the reference compiler is es2panda from the arkcompiler runtime core.

Status: the JS backend works and compiles real arkui3 packages.
Language coverage is tracked in `NEXT_FEATURES.md`.

## Quick start

```
npm install
git submodule update --init
npm run build
npm run test:js
npm run demo:run
```

`npm run demo:run` compiles and runs the sample programs in `input/example.ets` end to end.

## What is here

| Path | What it is |
|---|---|
| `src/` | compiler sources: scanner, parser, binder, typechecker, transforms, JS generator |
| `stdlib/` | the standard library written in ArkTS |
| `test/` | golden tests, runners, quarantine snapshots |
| `runtime/` | JS runtime for the stdlib, memo harness and demo scripts |
| `koalaui/` | the `@koalaui/common` client library |
| `integration/` | client submodules, including arkui3 and the es2panda reference |
| `arkui3/` | per package compile configs for the reference workload |
| `designs/` | design documents for features |
| `state/` | the in repo issue tracker |
| `input/`, `lib/` | sample programs and libraries |

## Documentation

- `CLAUDE.md` is the entry point for coding agents and holds the project rules.
- `TESTING.md` is the test contract and the full command table.
- `NEXT_FEATURES.md` tracks language coverage.
- `designs/` holds design documents, indexed by `designs/_index.md`.
- `state/` is the issue tracker: open issues in the root, fixed ones in `state/completed/`.

The `igelhaus_arkts_spec/` symlink, created by `npm install` through postinstall, points into the runtime core submodule at the ArkTS language specification.
If the symlink is dangling, run `git submodule update --init`.