winzik/docs/ide/run.md
David Nurdin 7de153fc14 IDE documentation: one page per feature (docs/ide/, French in docs/ide/fr/) and a Doc browser inside the IDE
- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases,
  Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list;
  15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them.
- The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool
  window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables,
  links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback.
- ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked);
  the packaged copy ui/docs first, else the repository's docs/ide.
- Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php
  puts them in code updates, bin/jumphp ide syncs them.
- Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest
  (path traversal refused), the i18n test covers the new texts in 14 languages.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 00:08:42 +01:00

32 lines
1.3 KiB
Markdown

# Run
## Run configurations
The run widget of the tool bar lists the project's configurations: for each game or app `bin/jumphp run / test / shot / build /
webshot / serve / export / lint`, for a web site **Serve the site**, plus your own in `.jumphp/run.json`
(`[{"label": "…", "command": ["…"]}]`) and the [scripts](scripts.md) you pinned. **Run Configurations…** (`Alt+Shift+F10`) chooses one.
| Action | Shortcut |
|---|---|
| Run | `Shift+F10` |
| Debug | `Shift+F9` ([Debugger](debugger.md)) |
| Run tests | `Ctrl+Shift+F10` |
| Rerun | `Ctrl+F5` |
| Stop | `Ctrl+F2` |
| Run Anything (a `bin/jumphp` command) | Ctrl twice |
| Take a Screenshot | Run menu |
## The Run window
`Alt+4`. The output as it comes, coloured; `file:line` are links; PHPUnit results as a tree; screenshots (`shot`, `webshot`) open in
a tab. Each run has its tab; Stop ends it.
## Play
The green ▶ of the editor's and the Project view's menus: a `src/Scene/*.php` starts the game in that scene, a `tests/*Test.php` runs
its tests, else the whole game. **Play the Game** (the game button of the tool bar) shows it in the **Game** window ([Games](games.md)).
## Docker
`bin/jumphp` runs everything in Docker: the IDE starts Docker Desktop if needed. On Windows without Docker Desktop it uses Docker
inside WSL.