M0: import starter package (rules, roadmap, progress docs)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
commit
1fc46daa8e
22 changed files with 790 additions and 0 deletions
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
/plan/
|
||||
/target/
|
||||
/target-*/
|
||||
node_modules/
|
||||
dist/
|
||||
.DS_Store
|
||||
*.log
|
||||
.idea/
|
||||
.vscode/
|
||||
87
AGENTS.md
Normal file
87
AGENTS.md
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
# Lutra — instructions for agents
|
||||
|
||||
Lutra ("An otterly perfect IDE") is a clean-room, open-source PHP IDE targeting the workflow of JetBrains PhpStorm (and beyond). The core is Rust; the desktop app is Tauri 2 with a Vue 3 + TypeScript frontend. It runs on macOS, Windows and Linux. The name is the Latin genus of the otter (*Lutra lutra*); sea otters use tools, and that is our motif.
|
||||
|
||||
## Start every session here
|
||||
1. Read [`ROADMAP.md`](ROADMAP.md) (stage, numbers by dimension, what's next) and the ranked work list in [`docs/gaps.md`](docs/gaps.md). Unless the user gives you a task, pick work from that list.
|
||||
2. Read `plan/STATUS.md` (local session notes, may lag the ROADMAP), then the task in `plan/execution-plan.md` §3 and the relevant section of [`docs/architecture.md`](docs/architecture.md). Behaviour reference: public documentation only (see Clean-room below); `plan/phpstorm/*.md` holds notes from it, each with source URLs.
|
||||
3. Follow the autonomous operation protocol (`plan/execution-plan.md` §7): orient → plan → implement + test → verify → record → commit. Don't stop to ask unless §4 of the execution plan lists the decision as the owner's.
|
||||
|
||||
`plan/` is gitignored (local only).
|
||||
|
||||
## Non-negotiables
|
||||
|
||||
### Clean-room: never use JetBrains software as a reference (absolute rule, from the project owner)
|
||||
- Never launch, run, script, automate, screenshot or measure PhpStorm, IntelliJ IDEA or any other JetBrains IDE, and never compare Lutra's output against one. Don't create test files or fixtures with them.
|
||||
- Never read, decompile or copy anything inside a JetBrains install (JARs, plugins, bundled schemes, keymap XML, inspection descriptions, templates, icons, fonts shipped inside the IDE, help files).
|
||||
- Never copy JetBrains-authored code or text into this repo, tests included. This also covers JetBrains' open-source code (intellij-community, its plugins, its inspection texts): we stay clean-room even where a licence would allow copying.
|
||||
- Behaviour comes only from public documentation (jetbrains.com/help, public blog posts, public issue trackers and forum posts), cited by URL in `plan/phpstorm/`, and from the PHP language itself (php.net, the PHP RFCs, PSR specifications).
|
||||
- Feature names may be used to describe behaviour ("Go to Class", "Find Usages"). Wording, icons, colour schemes and default keymaps are not copied; Lutra ships its own.
|
||||
- If a task seems to need any of this, stop and say so instead. `cargo xtask cleanroom` (run by `cargo xtask ci`) fails on JetBrains copyright notices and on files that look like exported JetBrains configuration.
|
||||
- Never copy GPL/AGPL/LGPL code. Dependencies must be under a permissive licence (MIT, Apache-2.0, BSD, ISC, Zlib, MPL-2.0 as a separate crate/package only). `cargo deny` and the frontend licence check enforce it.
|
||||
|
||||
### Assets: no JetBrains iconography or images, ever (absolute rule, from the project owner)
|
||||
- Never add, copy, trace, redraw from, embed or ship any icon, image, cursor, colour scheme, keymap, live template, file template or screenshot from JetBrains products or from any source whose licence doesn't allow it.
|
||||
- Every image, icon, font or other asset must be one of:
|
||||
- original work created for Lutra by a contributor (who licenses it MIT OR Apache-2.0);
|
||||
- OSI open source;
|
||||
- public domain / CC0;
|
||||
- Creative Commons with redistribution allowed.
|
||||
- **Every asset file must have a row in [`ASSETS.md`](ASSETS.md)** (path, author, source URL, licence, notes). Put licence texts next to the assets and summarise them in `NOTICE`. `cargo xtask assets` (run by `cargo xtask ci`) fails on any unattributed asset.
|
||||
- UI icons come from Lucide (`lucide-vue-next`, ISC). Icons Lutra needs that Lucide lacks (PHP class, interface, trait, enum, attribute…) are drawn for Lutra, live in `assets/icons/` with the prefix `lt-`, and get an `ASSETS.md` row.
|
||||
- Fonts come from npm packages (`@fontsource/inter`, `@fontsource/jetbrains-mono`, OFL-1.1); never commit font files.
|
||||
- Prefer art generated in code for defaults (colour schemes, file-type badges). If the provenance of an asset is unclear, don't add it.
|
||||
- The app icon (an otter holding a stone) is the owner's to commission or approve. Until then the build uses a placeholder generated in code.
|
||||
|
||||
### Never crash: no panics in shipped code
|
||||
A crash loses the user's unsaved work. Files on disk, project contents, LSP and DAP messages, terminal output, control and MCP messages, and command params are all untrusted input.
|
||||
- Fallible work returns `Result` (or `Option`); callers handle it or propagate it with `?`. Failures reach the user as an error message (`EngineError` for commands, the crate's own error type below the engine), never as an abort.
|
||||
- Workspace clippy lints ban these outside tests, so `cargo xtask ci` fails on them: `unwrap()`, `expect()`, `panic!`, `unreachable!`, `todo!`, `unimplemented!`. Use `?`, `.ok_or(…)?`, `let … else { return … }`, `if let`, `unwrap_or*`, `.first()` / `.last()` / `.get()`, and a real error for a match arm you believe is impossible.
|
||||
- Don't panic implicitly either: use `.get(i)` instead of `v[i]` or `&s[a..b]` when the index comes from data. Text offsets are byte offsets on UTF-8 boundaries; convert through the text crate's helpers, never by hand. Cap sizes and counts read from input (file sizes, LSP payloads, search results).
|
||||
- Don't silence errors just to satisfy the lint. Where ignoring a failure is right (`let _ =`, `.ok()`), say why in the doc comment of the enclosing function.
|
||||
- Tests may unwrap and panic (`#[test]`, `#[cfg(test)]`, `tests/`, `testkit`).
|
||||
- `lutra_engine::guard` is the last line of defence: every entry point (commands, IPC from the frontend, control and MCP requests, LSP/DAP callbacks) catches a panic, keeps open buffers intact and reports an internal error. It exists for bugs and doesn't replace `Result`.
|
||||
- Unsaved buffers are written to a crash-recovery journal; a restart offers to restore them.
|
||||
- Frontend: TypeScript `strict`, no `any` without a reason in the doc comment, no unhandled promise rejections (lint rule), every IPC call handles its error.
|
||||
- Untrusted input is fuzzed or property-tested (file decoding, the control protocol, LSP message parsing, command params). Extend those tests when you add a parser or a protocol method.
|
||||
|
||||
### Everything is a command
|
||||
User-visible behaviour = a command in `crates/engine/src/cmd/*` (id, label, menu path, default shortcut, params doc, `enabled`, `run`) + tests. Menus, the command palette, shortcuts, the `lutra` CLI, the control channel and MCP all reach the same commands. UI-only commands (focus a tool window, toggle a panel) are registered by the frontend in `ui/src/commands/` and are still listed in the registry so the palette, keymap editor and agents see them.
|
||||
|
||||
### Layering
|
||||
Enforced by `cargo xtask layers`. Nothing below L6 depends on Tauri or the frontend. See [`docs/architecture.md`](docs/architecture.md).
|
||||
|
||||
### The UI is thin
|
||||
Vue components read engine state (pushed as events) and act through `run(commandId, params)`. Colours come from theme tokens (CSS variables generated from the Rust theme definition), never hard-coded.
|
||||
|
||||
### Code style
|
||||
- Code, identifiers, commits and docs in English.
|
||||
- **No inline comments in code.** Explain intent with doc comment blocks above modules, functions, structs, enums and their fields: purpose, parameters, return value, errors (`///` and `//!` in Rust, TSDoc `/** … */` in TypeScript and Vue `<script setup>`).
|
||||
- Rust: edition 2024, `rustfmt` defaults. Vue: Composition API with `<script setup lang="ts">`, Pinia for state, pnpm as package manager.
|
||||
|
||||
### Quality gates before every commit
|
||||
`cargo xtask ci` runs: `cargo fmt --check`, `cargo clippy --workspace -- -D warnings` (including the no-panic lints), `cargo test --workspace`, `cargo xtask layers`, `cargo xtask assets`, `cargo xtask cleanroom`, `cargo deny check licenses`, and in `ui/`: `pnpm lint`, `pnpm typecheck` (vue-tsc), `pnpm test` (Vitest). One task id per commit (`M1.3: project tree`).
|
||||
|
||||
## Running and looking at the app
|
||||
- `cargo xtask dev` starts the desktop app in development mode (Vite + Tauri).
|
||||
- `cargo run -p lutra-desktop -- --control 7979 [path]` starts it with the JSON control channel. If the port is taken, the app exits with an error; pick another port.
|
||||
- Drive it with JSON lines on `127.0.0.1:7979`, e.g. `{"id":1,"method":"engine.execute","params":{"command":"project.open","params":{"path":"/tmp/demo"}}}` then `{"id":2,"method":"ui.screenshot","params":{"path":"/tmp/shot.png"}}`. Methods: `crates/control/src/methods.rs`.
|
||||
- **For UI work, look at the result**: take `ui.screenshot`, read the PNG, and compare it with the public documentation notes in `plan/phpstorm/`. If no frame can be presented (headless machine), cover the component with a Vitest + Vue Test Utils test.
|
||||
- **Performance:** `lutra perf` checks the budgets (cold start, open a 1 MB file, keystroke to highlight, find in files, index a reference project) on generated and reference projects; `lutra bench PATH` times one project. Run them before and after editor, index or search changes, on an idle machine.
|
||||
- MCP: `lutra mcp` (stdio). Register with Claude Code: `claude mcp add lutra -- lutra mcp`.
|
||||
- Reference projects for tests and perf: fresh Symfony and Laravel skeletons, created by `cargo xtask fixtures` into `target/fixtures/` (never committed).
|
||||
- Parallel agents: separate `CARGO_TARGET_DIR` per agent; edit only the crates you own; delete your target dir when you finish.
|
||||
|
||||
## Roadmap and progress docs
|
||||
- [`ROADMAP.md`](ROADMAP.md): stage, headline numbers, dimensions, features, upcoming, progress log.
|
||||
- [`docs/target-app-parity.md`](docs/target-app-parity.md): the authoritative parity assessment (area table, methodology, evidence of what ships).
|
||||
- [`docs/gaps.md`](docs/gaps.md): every known shortfall, ranked; the work list. [`docs/roadmap.md`](docs/roadmap.md): milestones and current focus.
|
||||
- Checklists: [`ui-parity.md`](docs/ui-parity.md), [`language-parity.md`](docs/language-parity.md), [`framework-parity.md`](docs/framework-parity.md), [`tooling-parity.md`](docs/tooling-parity.md), [`localization-parity.md`](docs/localization-parity.md); [`architecture.md`](docs/architecture.md), [`development.md`](docs/development.md).
|
||||
|
||||
When a task lands, update in the same commit: the area row in `docs/target-app-parity.md` (score, missing items, hours) and its evidence, the gap entry in `docs/gaps.md` if it closed or shrank, the checklist it belongs to, the milestone row in `docs/roadmap.md`, and the ROADMAP's tables and progress log when a headline number moves. Update each touched doc's status line and revision history.
|
||||
- Grade by behaviour against the public documentation, not by whether a menu item exists. Scores are self-assessed, so err low; mark each number measured or estimated.
|
||||
- Keep the README's Status section in step with the ROADMAP headline.
|
||||
|
||||
## Contributor credits (About window)
|
||||
- About ▸ Contributors is compiled from `contributors/people.toml` (names people chose for themselves) and git history.
|
||||
- When you prepare a PR for a human contributor whose username has no entry, ask them once whether they want to be credited by more than their username. If yes, add **only their own** entry. Never add, edit, guess or copy anyone else's name.
|
||||
12
ASSETS.md
Normal file
12
ASSETS.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# Asset attribution
|
||||
|
||||
Every non-code asset in this repository (icons, images, example projects, colour schemes, templates) is listed here with its author, source and licence. `cargo xtask assets` (part of `cargo xtask ci`) fails if an asset file is missing from this table.
|
||||
|
||||
**Policy (mandatory):** Lutra contains **no JetBrains iconography, images, colour schemes, keymaps, live or file templates, inspection texts or screenshots**. Every asset is either original work by Lutra contributors, or third-party material under an open licence (OSI open source, public domain / CC0, or Creative Commons that allows redistribution), and it is attributed below. Screenshots of JetBrains software are never committed.
|
||||
|
||||
Generated-in-code art is original and has no file to list (default colour schemes, file-type badges, the placeholder app icon).
|
||||
|
||||
**Font files are never committed.** Inter and JetBrains Mono (both SIL OFL 1.1) come from the `@fontsource` npm packages and are listed in `NOTICE`. **Lucide icons** come from the `lucide-vue-next` npm package (ISC) and are listed in `NOTICE`; only icons drawn for Lutra live in `assets/icons/` with the prefix `lt-`.
|
||||
|
||||
| Asset | Author | Source | Licence | Notes |
|
||||
|---|---|---|---|---|
|
||||
3
CLAUDE.md
Normal file
3
CLAUDE.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Lutra
|
||||
|
||||
All agent instructions live in [`AGENTS.md`](AGENTS.md). Read it first, every session, and follow it. Do not duplicate its content here.
|
||||
176
LICENSE-APACHE
Normal file
176
LICENSE-APACHE
Normal file
|
|
@ -0,0 +1,176 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
21
LICENSE-MIT
Normal file
21
LICENSE-MIT
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2026 Daniel Diekert and the Lutra contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
27
NOTICE
Normal file
27
NOTICE
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
Lutra — An otterly perfect IDE
|
||||
Copyright (c) 2026 Daniel Diekert and the Lutra contributors
|
||||
|
||||
Licensed under either of
|
||||
* Apache License, Version 2.0 (LICENSE-APACHE)
|
||||
* MIT License (LICENSE-MIT)
|
||||
at your option.
|
||||
|
||||
Third-party material bundled with Lutra keeps its own licence. Every asset
|
||||
file in this repository is listed in ASSETS.md. Third-party components that
|
||||
are compiled or bundled into release builds are summarised below and must be
|
||||
kept up to date when one is added or removed.
|
||||
|
||||
Bundled components (planned; update when added):
|
||||
* Lucide icons (lucide-vue-next) — ISC License, https://lucide.dev
|
||||
* Inter typeface (@fontsource/inter) — SIL Open Font License 1.1
|
||||
* JetBrains Mono typeface (@fontsource/jetbrains-mono) — SIL Open Font License 1.1
|
||||
* CodeMirror 6 — MIT License
|
||||
* tree-sitter and tree-sitter-php — MIT License
|
||||
* Tauri — MIT OR Apache-2.0
|
||||
|
||||
External tools Lutra talks to but does not bundle:
|
||||
* Phpactor (language server) — MIT License
|
||||
|
||||
PhpStorm, IntelliJ IDEA and JetBrains are trademarks or registered trademarks
|
||||
of JetBrains s.r.o. Lutra is an independent open-source project and is not
|
||||
affiliated with, sponsored by or endorsed by JetBrains s.r.o.
|
||||
80
README.md
Normal file
80
README.md
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<h1 align="center">🦦 Lutra</h1>
|
||||
|
||||
<p align="center">
|
||||
<b>An otterly perfect IDE.</b>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
A fast, open-source, clean-room PHP IDE in the spirit of the PhpStorm workflow.
|
||||
Rust core, Vue interface, native on macOS, Windows and Linux.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Status: pre-alpha" src="https://img.shields.io/badge/status-pre--alpha-8a6a4f">
|
||||
<img alt="Core in Rust" src="https://img.shields.io/badge/core-Rust-b83a24?logo=rust&logoColor=white">
|
||||
<img alt="UI in Vue" src="https://img.shields.io/badge/UI-Vue%203-42b883?logo=vuedotjs&logoColor=white">
|
||||
<img alt="Runs on macOS, Windows and Linux" src="https://img.shields.io/badge/runs%20on-macOS%20%C2%B7%20Windows%20%C2%B7%20Linux-555555">
|
||||
<img alt="MCP server for agents" src="https://img.shields.io/badge/agents-MCP%20server-555555">
|
||||
<img alt="License: MIT OR Apache-2.0" src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-555555">
|
||||
</p>
|
||||
|
||||
> *Lutra* is the Latin name of the otter. Sea otters are among the few animals that use tools:
|
||||
> they crack shells open with a stone. Lutra is that stone for your PHP code.
|
||||
|
||||
## Why Lutra
|
||||
|
||||
- **Familiar.** Project view, tool windows, Search Everywhere-style navigation, Go to Class, Find Usages, refactorings: the workflow PHP developers already know.
|
||||
- **Fast.** A Rust core with an incremental index, search off the UI thread and a lightweight Tauri shell.
|
||||
- **Robust.** No panics in shipped code, a crash-recovery journal for unsaved buffers, property-tested protocols.
|
||||
- **Open.** MIT OR Apache-2.0, no account, no telemetry.
|
||||
- **Agent-native.** Every action is a command that a JSON control channel and an MCP server expose, so Claude and other agents can work in the IDE the way a person does.
|
||||
- **PHP-first.** Symfony, Laravel, Shopware and WordPress support are on the roadmap from the start.
|
||||
|
||||
## Quick start
|
||||
|
||||
> Nothing is built yet. These commands describe the target of milestone M0–M3.
|
||||
|
||||
```sh
|
||||
git clone <repo-url> lutra
|
||||
cd lutra
|
||||
|
||||
cargo xtask dev # desktop app in development mode
|
||||
cargo run -p lutra-desktop -- --control 7979 . # + JSON control channel
|
||||
cargo xtask ci # fmt, clippy, tests, layers, assets, clean-room, frontend checks
|
||||
```
|
||||
|
||||
### The `lutra` command
|
||||
|
||||
```sh
|
||||
lutra . # open the current folder as a project
|
||||
lutra src/Kernel.php:42 # open a file at a line
|
||||
lutra diff a.php b.php # open the diff viewer
|
||||
lutra --wait FILE # wait until the tab is closed (git config core.editor "lutra --wait")
|
||||
lutra mcp # MCP server on stdio
|
||||
lutra perf # check the performance budgets
|
||||
```
|
||||
|
||||
### Use it from Claude Code
|
||||
|
||||
```sh
|
||||
claude mcp add lutra -- lutra mcp
|
||||
```
|
||||
|
||||
## Status
|
||||
|
||||
**Pre-alpha (2026-10-13): planning.** Nothing ships yet. [**ROADMAP.md**](ROADMAP.md) has the stage and what's next,
|
||||
[`docs/target-app-parity.md`](docs/target-app-parity.md) the parity assessment and [`docs/gaps.md`](docs/gaps.md) the ranked work list.
|
||||
|
||||
**First target (MVP, M1–M3):** open a project, project tree, tabs, editor with highlighting, find in files,
|
||||
go to definition, completion and diagnostics via a language server, command palette, integrated terminal,
|
||||
the `lutra` CLI, light and dark themes.
|
||||
|
||||
Agent and contributor rules (clean-room, asset policy, no panics, quality gates) are in [`AGENTS.md`](AGENTS.md).
|
||||
Every bundled asset is listed with its licence in [`ASSETS.md`](ASSETS.md).
|
||||
|
||||
## License
|
||||
|
||||
Lutra is dual-licensed under [MIT](LICENSE-MIT) or [Apache-2.0](LICENSE-APACHE), at your option.
|
||||
Copyright (c) 2026 Daniel Diekert and the Lutra contributors. Required notices are in [NOTICE](NOTICE).
|
||||
|
||||
<sub>PhpStorm, IntelliJ IDEA and JetBrains are trademarks or registered trademarks of JetBrains s.r.o. Lutra is an independent, open-source project and is not affiliated with, sponsored by or endorsed by JetBrains s.r.o.; these names are used only to describe the workflows it is compatible with.</sub>
|
||||
83
ROADMAP.md
Normal file
83
ROADMAP.md
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
# Lutra Roadmap
|
||||
|
||||
**Stage: pre-alpha (planning)** · next: alpha, when the six core workflows work end to end (see [docs/roadmap.md › Alpha gate](docs/roadmap.md#alpha-gate))
|
||||
|
||||
> **Last reviewed:** 2026-10-13 · **Last updated:** 2026-10-13 · **Change:** major (initial roadmap) · **Target:** JetBrains PhpStorm 2026.x, described from public documentation only
|
||||
|
||||
Lutra is a clean-room, open-source PHP IDE with a Rust core and a Tauri + Vue interface, targeting the PhpStorm workflow. Agents can drive all of it over MCP, the `lutra` CLI and a JSON control channel. This page is the summary; the evidence is in [`docs/target-app-parity.md`](docs/target-app-parity.md) and the work list in [`docs/gaps.md`](docs/gaps.md).
|
||||
|
||||
**Why pre-alpha:** nothing is built yet. Milestone M0 creates the workspace, the quality gate and an empty window; M1–M3 deliver the MVP.
|
||||
|
||||
## Headline numbers
|
||||
|
||||
| | Value | Kind |
|
||||
|---|---|---|
|
||||
| **Feature breadth** (PhpStorm's actions, tool windows, languages, integrations exist) | **0%** | measured |
|
||||
| **Feature depth** (weighted by use, scored by behaviour) | **0%** | measured |
|
||||
| **To MVP (M3)** | to be estimated after M0 | — |
|
||||
| **To full parity** | to be estimated after M0 | — |
|
||||
|
||||
Hours are agent wall-clock hours. They are first estimated at the end of M0 and calibrated from merged-commit timestamps after that. PhpStorm is **not** inspected: the clean-room rule in [`AGENTS.md`](AGENTS.md) forbids it, so everything is measured from our code against public documentation.
|
||||
|
||||
## By dimension
|
||||
|
||||
| Dimension | % | One agent (h) | Doc |
|
||||
|---|---:|---:|---|
|
||||
| Features (depth) | 0% | — | [target-app-parity.md](docs/target-app-parity.md) |
|
||||
| UI/UX fidelity | 0% | — | [ui-parity.md](docs/ui-parity.md) |
|
||||
| PHP language support | 0% | — | [language-parity.md](docs/language-parity.md) |
|
||||
| Frameworks (Symfony, Laravel, Shopware, WordPress) | 0% | — | [framework-parity.md](docs/framework-parity.md) |
|
||||
| Tooling (Git, terminal, debugger, tests, Composer, DB) | 0% | — | [tooling-parity.md](docs/tooling-parity.md) |
|
||||
| Localization (en, de) | 0% | — | [localization-parity.md](docs/localization-parity.md) |
|
||||
| Performance | 0% | — | [gaps.md › G12](docs/gaps.md) |
|
||||
| Stability | 0% | — | [gaps.md › G11](docs/gaps.md) |
|
||||
| Agent automation | 0% | — | AGENTS.md |
|
||||
|
||||
## Features
|
||||
|
||||
| Area | % | One agent (h) |
|
||||
|---|---:|---:|
|
||||
| Editor core (buffers, undo, multi-caret, folding, soft wrap) | 0% | — |
|
||||
| Project view, VFS, file watching | 0% | — |
|
||||
| Navigation (go to class/file/symbol, recent files, structure) | 0% | — |
|
||||
| Search and replace (in file, in project, structural) | 0% | — |
|
||||
| Code completion | 0% | — |
|
||||
| Inspections and quick-fixes | 0% | — |
|
||||
| Refactoring | 0% | — |
|
||||
| Code style and formatting | 0% | — |
|
||||
| Version control (Git) | 0% | — |
|
||||
| Terminal | 0% | — |
|
||||
| Run configurations | 0% | — |
|
||||
| Debugger (Xdebug) | 0% | — |
|
||||
| Testing (PHPUnit, Pest) | 0% | — |
|
||||
| Composer and PHP interpreters | 0% | — |
|
||||
| Frameworks | 0% | — |
|
||||
| Database tools | 0% | — |
|
||||
| HTTP client | 0% | — |
|
||||
| Web languages (JS/TS, Vue, CSS, Twig, Blade) | 0% | — |
|
||||
| Docker and remote | 0% | — |
|
||||
| Settings, keymaps, themes | 0% | — |
|
||||
| Plug-ins and ecosystem | 0% | — |
|
||||
| AI features | 0% | — |
|
||||
|
||||
Weights, evidence and the missing items per area: [target-app-parity.md](docs/target-app-parity.md).
|
||||
|
||||
## Upcoming
|
||||
|
||||
1. **M0 foundation:** workspace, lints, quality gate, command registry, control channel, empty window.
|
||||
2. **M1 editor and project:** open folder, project tree, tabs, editor, save and recovery, command palette, themes.
|
||||
3. **M2 syntax and search:** highlighting, file structure, find in files, go to file/class/symbol.
|
||||
4. **M3 language server, terminal and CLI:** completion, diagnostics, go to definition via Phpactor; terminal; `lutra` CLI. **MVP.**
|
||||
5. **Then:** Git (M4), debugger, tests and Composer (M5), own indexer and frameworks (M6).
|
||||
|
||||
## Progress log
|
||||
|
||||
| Date | What landed |
|
||||
|---|---|
|
||||
| 2026-10-13 | Project started: name, conventions, agent rules and progress docs. |
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Initial roadmap |
|
||||
0
assets/app-icon/.gitkeep
Normal file
0
assets/app-icon/.gitkeep
Normal file
0
assets/icons/.gitkeep
Normal file
0
assets/icons/.gitkeep
Normal file
6
contributors/people.toml
Normal file
6
contributors/people.toml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Names contributors chose for themselves, shown in About > Contributors.
|
||||
# Add only your own entry. Never add or edit anyone else's.
|
||||
#
|
||||
# [people.<username>]
|
||||
# real_name = "Daniel Diekert"
|
||||
# display_name = "Tyrveil"
|
||||
44
docs/architecture.md
Normal file
44
docs/architecture.md
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# Architecture
|
||||
|
||||
> **Status:** draft, to be completed in M0 · **Last updated:** 2026-10-13
|
||||
|
||||
## Overview
|
||||
|
||||
```
|
||||
apps/lutra-desktop (L6) Tauri 2 shell: windows, menus, IPC bridge to the engine
|
||||
ui/ (L6) Vue 3 + TypeScript + Vite frontend, Pinia, CodeMirror 6
|
||||
apps/lutra-cli (L5) the `lutra` command: open, diff, --wait, mcp, perf, bench
|
||||
crates/control (L5) JSON-lines control channel (--control PORT)
|
||||
crates/mcp (L5) MCP server over stdio
|
||||
crates/engine (L4) command registry, workspace state, guard, recovery journal
|
||||
crates/lsp (L3) LSP client (Phpactor first), later DAP client
|
||||
crates/index (L2) symbol index, usages, later type inference
|
||||
crates/vfs (L2) project model, file watching, ignore rules, encodings
|
||||
crates/search (L2) find in files (ignore + grep-searcher crates)
|
||||
crates/syntax (L1) tree-sitter parsing (PHP first), outlines, highlight tokens
|
||||
crates/text (L0) rope buffer, positions, UTF-8/UTF-16 conversion, edits
|
||||
crates/testkit (—) test helpers and fixtures, tests only
|
||||
xtask (—) ci, layers, assets, cleanroom, dev, fixtures
|
||||
```
|
||||
|
||||
A crate may depend only on crates of a lower layer. `cargo xtask layers` checks it. Nothing below L6 depends on Tauri or the frontend.
|
||||
|
||||
## Commands
|
||||
|
||||
Every user-visible action is a command: `id`, `label`, `menu_path`, `default_shortcut`, `params` (documented schema), `enabled(&State) -> bool`, `run(&mut State, Params) -> Result<Output, EngineError>`. Menus, the palette, keymaps, the CLI, the control channel and MCP all call the registry. Long-running commands report progress and can be cancelled.
|
||||
|
||||
## Frontend ↔ engine
|
||||
|
||||
The frontend calls `run(id, params)` over Tauri IPC and subscribes to state events (open buffers, diagnostics, tree changes). Buffer contents live in the engine; CodeMirror sends edits as transactions and receives authoritative changes back. Theme tokens are defined in Rust and exported as CSS variables.
|
||||
|
||||
## Open questions for M0
|
||||
|
||||
- Highlighting: tree-sitter tokens from the core vs. a Lezer grammar in CodeMirror for instant highlighting (tree-sitter stays the structural source either way).
|
||||
- Git library: `gix` (preferred, MIT/Apache) vs. alternatives.
|
||||
- Terminal: `portable-pty` in the core, xterm.js in the frontend.
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Initial draft |
|
||||
32
docs/development.md
Normal file
32
docs/development.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Development
|
||||
|
||||
> **Status:** draft · **Last updated:** 2026-10-13
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Rust stable (via rustup), edition 2024
|
||||
- Node.js 20 or newer and pnpm
|
||||
- Tauri 2 system prerequisites for your platform (WebView2 on Windows, WebKitGTK on Linux)
|
||||
- Optional: Phpactor on the PATH for language features, PHP 8.2+ and Composer for reference projects
|
||||
|
||||
## Everyday commands
|
||||
|
||||
```sh
|
||||
cargo xtask dev # run the app in development mode
|
||||
cargo xtask ci # the full quality gate, run before every commit
|
||||
cargo xtask fixtures # create Symfony and Laravel reference projects in target/fixtures/
|
||||
```
|
||||
|
||||
## Robustness: Lutra never crashes
|
||||
|
||||
Shipped code returns errors instead of panicking (see AGENTS.md › Never crash). The engine guard catches panics at every entry point, keeps buffers intact and reports an internal error. Unsaved buffers are journaled so a restart can restore them.
|
||||
|
||||
## Code style
|
||||
|
||||
No inline comments. Doc comment blocks above modules, functions, types and fields explain purpose, parameters, return values and errors.
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Initial draft |
|
||||
28
docs/framework-parity.md
Normal file
28
docs/framework-parity.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# Framework checklist
|
||||
|
||||
> **Status:** baseline · **Last updated:** 2026-10-13
|
||||
|
||||
## Symfony
|
||||
- [ ] Routes, services and container navigation
|
||||
- [ ] Twig templates: highlighting, navigation, completion
|
||||
- [ ] Console commands as run configurations
|
||||
|
||||
## Laravel
|
||||
- [ ] Routes, facades, Eloquent model completion
|
||||
- [ ] Blade templates
|
||||
- [ ] Artisan commands
|
||||
|
||||
## Shopware 6
|
||||
- [ ] Plugin structure, services.xml navigation
|
||||
- [ ] Twig storefront templates with block inheritance
|
||||
- [ ] Administration (Vue) snippets
|
||||
|
||||
## WordPress
|
||||
- [ ] Hooks (actions and filters) navigation
|
||||
- [ ] Plugin and theme scaffolding
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
30
docs/gaps.md
Normal file
30
docs/gaps.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Gaps
|
||||
|
||||
> **Status:** initial list · **Last updated:** 2026-10-13
|
||||
|
||||
Every known shortfall, ranked. This is the work list: unless the owner gives a task, take the highest open gap.
|
||||
|
||||
| # | Gap | Milestone | Estimate (one agent) |
|
||||
|---|---|---|---|
|
||||
| G1 | Foundation: workspace, quality gate, command registry, guard, control channel | M0 | after M0 planning |
|
||||
| G2 | Editor core: buffers, undo, multi-caret, save, recovery journal | M1 | — |
|
||||
| G3 | Project model: VFS, file watching, project tree, tabs | M1 | — |
|
||||
| G4 | Syntax and structure: tree-sitter PHP, highlighting, file structure | M2 | — |
|
||||
| G5 | Search and navigation: find in files, go to file/class/symbol | M2 | — |
|
||||
| G6 | Language server: completion, diagnostics, definition, hover, rename via Phpactor | M3 | — |
|
||||
| G7 | Terminal and `lutra` CLI | M3 | — |
|
||||
| G8 | Git integration | M4 | — |
|
||||
| G9 | Debugger, test runner, Composer, run configurations | M5 | — |
|
||||
| G10 | Own indexer, inspections, refactorings | M6 | — |
|
||||
| G11 | Stability: crash-free operation on real projects and machines | ongoing | — |
|
||||
| G12 | Performance budgets: start, open, type, search, index | ongoing | — |
|
||||
| G13 | Frameworks: Symfony, Laravel, Shopware, WordPress | M6 | — |
|
||||
| G14 | Localization: English and German interface | later | — |
|
||||
| G15 | Database tools, HTTP client, Docker and remote | later | — |
|
||||
| G16 | Plug-ins and ecosystem | later | — |
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Initial gap list |
|
||||
21
docs/language-parity.md
Normal file
21
docs/language-parity.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# PHP language checklist
|
||||
|
||||
> **Status:** baseline · **Last updated:** 2026-10-13 · Reference: php.net and the PHP RFCs
|
||||
|
||||
- [ ] Parsing of PHP 8.0–8.4 syntax (attributes, match, enums, readonly, first-class callables, property hooks, asymmetric visibility)
|
||||
- [ ] Highlighting, including heredoc/nowdoc and embedded HTML
|
||||
- [ ] File structure: namespaces, classes, interfaces, traits, enums, functions, constants
|
||||
- [ ] Go to declaration and implementation
|
||||
- [ ] Find usages
|
||||
- [ ] Completion: members, functions, classes with auto-import, keywords
|
||||
- [ ] Type inference from declarations, PHPDoc, generics in PHPDoc
|
||||
- [ ] Diagnostics: syntax errors, undefined symbols, type mismatches
|
||||
- [ ] Refactorings: rename, extract variable/method, move class, change signature
|
||||
- [ ] Formatting to PSR-12 / PER coding style
|
||||
- [ ] PHPDoc generation and completion
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
16
docs/localization-parity.md
Normal file
16
docs/localization-parity.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# Localization checklist
|
||||
|
||||
> **Status:** baseline · **Last updated:** 2026-10-13
|
||||
|
||||
| Language | Code | Status | Translated |
|
||||
|---|---|---|---:|
|
||||
| English | `en` | source | 0% |
|
||||
| German | `de` | planned | 0% |
|
||||
|
||||
All interface strings go through the message catalog from the first UI task on; no hard-coded labels.
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
30
docs/roadmap.md
Normal file
30
docs/roadmap.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# Milestones
|
||||
|
||||
> **Status:** current focus M0 · **Last updated:** 2026-10-13
|
||||
|
||||
| Milestone | Goal | State |
|
||||
|---|---|---|
|
||||
| M0 | Foundation: workspace, lints, quality gate, command registry, control channel, empty window | not started |
|
||||
| M1 | Editor and project: open folder, tree, tabs, editor, save, recovery, palette, settings, themes | not started |
|
||||
| M2 | Syntax and search: highlighting, structure, find in files, go to file/class/symbol | not started |
|
||||
| M3 | LSP, terminal, CLI: completion, diagnostics, go to definition, hover, rename; terminal; `lutra` CLI — **MVP** | not started |
|
||||
| M4 | Git: status, diff, commit, branches, log, blame, conflicts | not started |
|
||||
| M5 | Debugger (Xdebug via DAP), PHPUnit/Pest runner, Composer, run configurations | not started |
|
||||
| M6 | Own indexer and inspections; Symfony, Laravel, Shopware, WordPress support | not started |
|
||||
|
||||
## Alpha gate
|
||||
|
||||
Alpha is reached when these six core workflows work end to end on macOS, Windows and Linux, with save and reopen:
|
||||
|
||||
1. Open a project, browse and edit files, save, recover after a crash.
|
||||
2. Navigate: go to file, class, symbol and definition; find in files.
|
||||
3. Write code with completion and diagnostics.
|
||||
4. Run commands in the integrated terminal.
|
||||
5. Commit, diff and switch branches with Git.
|
||||
6. Drive all of the above from the CLI, the control channel and MCP.
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Initial milestones |
|
||||
42
docs/target-app-parity.md
Normal file
42
docs/target-app-parity.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Target-app parity
|
||||
|
||||
> **Status:** baseline, nothing ships · **Last updated:** 2026-10-13 · **Target:** PhpStorm 2026.x
|
||||
|
||||
## How this is measured
|
||||
|
||||
Each feature area gets a weight (how much a typical PHP developer uses it) and a score (how much of the documented behaviour Lutra has, judged by behaviour, not by menu items). The headline depth is the weighted sum. Every score is marked measured or estimated and must point to evidence (tests, commands, screenshots of Lutra). Behaviour references come from public PhpStorm documentation only, noted with URLs in `plan/phpstorm/`.
|
||||
|
||||
## Feature areas
|
||||
|
||||
| Area | Weight | Score | Missing | Hours (one agent) | Evidence |
|
||||
|---|---:|---:|---|---:|---|
|
||||
| Editor core | 12 | 0% | everything | — | — |
|
||||
| Project view, VFS | 6 | 0% | everything | — | — |
|
||||
| Navigation | 10 | 0% | everything | — | — |
|
||||
| Search and replace | 6 | 0% | everything | — | — |
|
||||
| Code completion | 10 | 0% | everything | — | — |
|
||||
| Inspections and quick-fixes | 8 | 0% | everything | — | — |
|
||||
| Refactoring | 7 | 0% | everything | — | — |
|
||||
| Code style and formatting | 4 | 0% | everything | — | — |
|
||||
| Git | 8 | 0% | everything | — | — |
|
||||
| Terminal | 3 | 0% | everything | — | — |
|
||||
| Run configurations | 2 | 0% | everything | — | — |
|
||||
| Debugger | 5 | 0% | everything | — | — |
|
||||
| Testing | 4 | 0% | everything | — | — |
|
||||
| Composer and interpreters | 2 | 0% | everything | — | — |
|
||||
| Frameworks | 5 | 0% | everything | — | — |
|
||||
| Database tools | 3 | 0% | everything | — | — |
|
||||
| HTTP client | 1 | 0% | everything | — | — |
|
||||
| Web languages | 2 | 0% | everything | — | — |
|
||||
| Docker and remote | 1 | 0% | everything | — | — |
|
||||
| Settings, keymaps, themes | 1 | 0% | everything | — | — |
|
||||
| Plug-ins | 0.5 | 0% | everything | — | — |
|
||||
| AI features | 0.5 | 0% | everything | — | — |
|
||||
|
||||
Weights are a first estimate and are reviewed at the end of M0.
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
20
docs/tooling-parity.md
Normal file
20
docs/tooling-parity.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Tooling checklist
|
||||
|
||||
> **Status:** baseline · **Last updated:** 2026-10-13
|
||||
|
||||
- [ ] Integrated terminal with tabs
|
||||
- [ ] Git: status, diff, commit, push/pull, branches, log, blame, conflict resolution
|
||||
- [ ] Composer: install, update, require, scripts
|
||||
- [ ] PHP interpreters: local, Docker
|
||||
- [ ] Xdebug via DAP: breakpoints, stepping, variables, watches
|
||||
- [ ] PHPUnit and Pest: run, rerun failed, coverage
|
||||
- [ ] PHPStan, Psalm, PHP-CS-Fixer integration
|
||||
- [ ] Run configurations
|
||||
- [ ] Database tools: connect, browse, query console
|
||||
- [ ] HTTP client
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
23
docs/ui-parity.md
Normal file
23
docs/ui-parity.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# UI parity checklist
|
||||
|
||||
> **Status:** baseline · **Last updated:** 2026-10-13
|
||||
|
||||
- [ ] Main window: tool window stripes, editor area, status bar, navigation bar
|
||||
- [ ] Project tool window (tree, scroll from source, file operations)
|
||||
- [ ] Editor tabs (pin, split, reorder, close others)
|
||||
- [ ] Command palette / search everywhere
|
||||
- [ ] Settings dialog with search
|
||||
- [ ] Keymap editor (Lutra's own default keymap; no copied keymaps)
|
||||
- [ ] Light and dark themes from theme tokens
|
||||
- [ ] Notifications and background task indicator
|
||||
- [ ] Structure tool window
|
||||
- [ ] Problems tool window
|
||||
- [ ] Find tool window
|
||||
- [ ] Terminal tool window
|
||||
- [ ] Git tool window
|
||||
|
||||
## Revision history
|
||||
|
||||
| Date | Change | Summary |
|
||||
|---|---|---|
|
||||
| 2026-10-13 | major | Baseline |
|
||||
Loading…
Add table
Add a link
Reference in a new issue