@flatkit/compiler 0.19.11 → 0.19.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -0
  2. package/package.json +6 -6
package/README.md ADDED
@@ -0,0 +1,34 @@
1
+ # @flatkit/compiler
2
+
3
+ The [FlatInk](http://flatink.zwyk-studio.com/) language (parser + AST) and compiler: turn readable
4
+ `.flatink` text into a single self-contained `.flatpack`. Ships the **`flatc`** CLI. Lives in build/CLI
5
+ tooling — the [player](https://www.npmjs.com/package/@flatkit/player) stays tiny and never pulls it in.
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ pnpm add -D @flatkit/compiler
11
+ ```
12
+
13
+ ## CLI
14
+
15
+ ```sh
16
+ flatc scene.flatink -o scene.flatpack # text sources -> one playable file
17
+ flatc scene.flatink --render -o frame.png # headless PNG preview
18
+ flatc scene.flatink --play --script gestures.json # headless replay + assertions (CI)
19
+ ```
20
+
21
+ ## Programmatic
22
+
23
+ ```ts
24
+ import { compileFlatpack } from '@flatkit/compiler/compile'
25
+
26
+ const doc = compileFlatpack(programSrc, assetSrcs, media) // -> Doc (the .flatpack)
27
+ ```
28
+
29
+ Static analysis (lint, manifest, LLM context) lives under `@flatkit/compiler/analysis`.
30
+
31
+ ## License
32
+
33
+ [MIT](https://github.com/flatink/flatkit/blob/main/LICENSE) (c) Zwyk Studio — part of
34
+ [flatkit](https://github.com/flatink/flatkit).
package/package.json CHANGED
@@ -1,16 +1,16 @@
1
1
  {
2
2
  "name": "@flatkit/compiler",
3
- "version": "0.19.11",
3
+ "version": "0.19.12",
4
4
  "description": "The FlatInk language (parser + AST) and compiler (.flatink → .flatpack). Ships the flatc CLI.",
5
5
  "license": "MIT",
6
6
  "author": "Zwyk Studio",
7
7
  "homepage": "http://flatink.zwyk-studio.com/",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "git+https://github.com/zwykstudio/flatkit.git",
10
+ "url": "git+https://github.com/flatink/flatkit.git",
11
11
  "directory": "packages/compiler"
12
12
  },
13
- "bugs": "https://github.com/zwykstudio/flatkit/issues",
13
+ "bugs": "https://github.com/flatink/flatkit/issues",
14
14
  "keywords": [
15
15
  "flatink",
16
16
  "flatpack",
@@ -45,9 +45,9 @@
45
45
  "bin"
46
46
  ],
47
47
  "dependencies": {
48
- "@flatkit/engine": "0.19.11",
49
- "@flatkit/player": "0.19.11",
50
- "@flatkit/types": "0.19.11"
48
+ "@flatkit/player": "0.19.12",
49
+ "@flatkit/types": "0.19.12",
50
+ "@flatkit/engine": "0.19.12"
51
51
  },
52
52
  "peerDependencies": {
53
53
  "skia-canvas": "^3.0.8"