プロジェクト構造¶
概略です。正本かつ常時更新される構造リファレンスは docs/repository-structure.md(日本語)にあります。
トップレベル構造¶
rescript-tauri/
├── packages/ # @rescript-tauri/core, plugin-*, schema
├── examples/ # hello-world / window-management / ipc-typed / streaming-ipc / plugin-fs-demo / plugin-dialog-demo / ipc-typed-with-schema
├── docs/ # Internal design docs (PRD, functional design, architecture, ...)
│ └── ideas/ # Drafts / RFCs (input only; not edited after acceptance)
├── sphinx-docs/ # External-facing docs (this site; English base + Japanese via Sphinx i18n)
├── .steering/ # Per-task steering documents (requirements / design / tasklist)
├── .claude/ # Claude Code configuration (rules / skills / agents / commands)
├── .github/ # GitHub Actions / templates
├── CLAUDE.md # Mandatory project instructions for Claude Code (Japanese)
├── CONTRIBUTING.md # External contributor guide (English)
├── README.md # Project README (English)
└── LICENSE # MIT
どこに何があるか¶
..... したい |
..... を見る |
|---|---|
プロジェクトが何を約束するかを読む |
|
モジュール別 API 仕様を読む |
|
横断設計(エラー / lifetime / JSON / variants)を読む |
|
Claude Code が強制する規約を読む |
|
コントリビュート方法(外部向け)を読む |
|
ローカル開発手順(内部向け)を読む |
|
ステアリングドキュメントの形を見る |
|
今読んでいるドキュメントを変更する |
|
サブシステムマップ¶
packages/core/ が中心ハブで、その周りに add-on パッケージの packages/schema/、packages/plugin-fs/、packages/plugin-dialog/、packages/plugin-shell/、packages/plugin-notification/、packages/plugin-log/、packages/plugin-os/、packages/plugin-clipboard-manager/ が並んでいます。core の配置は次のとおりです:
packages/core/
├── src/
│ ├── Core.res / .resi # invoke / convertFileSrc / Channel / Command / Resource / PluginListener / permissions / isTauri / LowLevel
│ ├── Event.res / .resi # listen / once / emit / TauriEvent enum
│ ├── Window.res / .resi
│ ├── Webview.res / .resi
│ ├── WebviewWindow.res / .resi
│ ├── Path.res / .resi
│ ├── App.res / .resi
│ ├── Dpi.res / .resi
│ ├── Menu.res / .resi
│ ├── Tray.res / .resi
│ ├── Image.res / .resi
│ ├── Mocks.res / .resi
│ └── Tauri.res / .resi # top-level re-export
├── tests/
│ ├── (型レベルテスト, *.res) # compile success = pass
│ └── runtime/ # vitest tests
├── rescript.json
├── package.json
└── README.md
すべての .res には対応する .resi インターフェイスファイルが必須で、これが API 表面の正本です(プロジェクトの絶対ルールの 1 つ。docs/repository-structure.md §2.1 参照)。