fix(examples): create example for cli#31
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new CLI-managed example project (examples/basic-kirie-cli) and aligns build/docs tooling to support both legacy web/-based examples and the new CLI layout.
Changes:
- Introduce
examples/basic-kirie-cli(Godot project + Vite web app + Kirie CLI config) demonstrating the CLI workflow and text IPC round-trip. - Update example build runner logic to handle both legacy
examples/*/webpackages and CLI-root example packages. - Standardize pnpm filtering syntax to
pnpm -F ...in scripts and documentation; expand GDScript lint/format coverage and add gdtoolkit exclude configs.
Reviewed changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/build-shared.ts | Switch pnpm invocation to -F filter shorthand for web builds. |
| scripts/build-examples.ts | Detect whether an example’s web build is the root package or web/ subpackage before building. |
| README.md | Document the new basic-kirie-cli example in the repo layout list. |
| pnpm-workspace.yaml | Add the new CLI example to the pnpm workspace. |
| pnpm-lock.yaml | Add lockfile entries for the new example package. |
| packages/kirie/addon/addons/kirie/gd_kirie.gd | Clarify the Godot CEF missing-install error message (native_extensions registration). |
| mise.toml | Expand GDScript format/lint scope to all examples. |
| gdlintrc | Add excluded directories for gdlint runs. |
| gdformatrc | Add excluded directories and formatting defaults for gdformat runs. |
| examples/eventa-csharp/README.md | Update pnpm filter usage to -F. |
| examples/basic-kirie-cli/src-web/tsconfig.json | Add strict TS config for the example web app. |
| examples/basic-kirie-cli/src-web/src/style.css | Add minimal styles for the example page. |
| examples/basic-kirie-cli/src-web/src/main.ts | Implement simple text IPC send/receive logging in the web page. |
| examples/basic-kirie-cli/src-web/index.html | Add the example page UI skeleton. |
| examples/basic-kirie-cli/src-godot/theme.tres | Define a basic UI theme for the Godot side. |
| examples/basic-kirie-cli/src-godot/scripts/main.gd.uid | Add Godot UID for the main script. |
| examples/basic-kirie-cli/src-godot/scripts/main.gd | Implement WebView creation + environment-driven dev URL selection + IPC logging. |
| examples/basic-kirie-cli/src-godot/main.tscn | Add the main scene wiring for the example UI. |
| examples/basic-kirie-cli/src-godot/icon.svg.import | Add Godot import metadata for the icon. |
| examples/basic-kirie-cli/src-godot/icon.svg | Add the example icon asset. |
| examples/basic-kirie-cli/README.md | Document how to run the example via CLI dev/build and mobile export runner. |
| examples/basic-kirie-cli/project.godot | Configure the new Godot project (scene, plugin, CEF extension path). |
| examples/basic-kirie-cli/package.json | Define the CLI example workspace package and scripts (kirie dev/build). |
| examples/basic-kirie-cli/kirie.config.ts | Provide Kirie CLI config (Vite build sourcemaps). |
| examples/basic-kirie-cli/export_presets.cfg | Add Android/iOS export presets including web dist include filters. |
| examples/basic-ipc/README.md | Update pnpm filter usage to -F. |
| docs/references.md | Expand Godot CLI reference notes and add named-class registration reference. |
| docs/architecture.md | Document the CLI’s headless --import prepare step rationale. |
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.