winzik/docs/ide/scripts.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

34 lines
1.7 KiB
Markdown

# Scripts
The **Scripts** window (right, the ⚡; also Tools > Scripts) lists the project's own scripts and the tasks it already has.
![The Scripts window](images/scripts.png)
## Your scripts
**+ Script** (or **New Script…**): a name, an icon, a shell body (several lines), where it runs (a **Terminal** tab, the **Run**
window, or **in the background** with a notification), a working folder, environment lines, **Ask before running**, and for web sites
**Run in the site's PHP container**.
Variables: `${file}`, `${dir}`, `${project}`, `${selection}`, `${line}`, `${fileName}`, `${relativeFile}`, `${input:Label}` (asked
at each run). They are passed safely quoted: a selection holding `$(…)` or quotes is never run.
Saved in `.jumphp/scripts.json` (committed: the team shares them), or with **On this computer only** in `.jumphp/scripts.local.json`.
## Tasks found in the project
Makefile targets (with their `## help`), Castor tasks, `composer.json` and `package.json` scripts, justfile recipes, Taskfile tasks.
Right click: run, **Make a Script from It…**, open the file. A `castor.php` without castor offers **Install Castor…** (checked against
its release's checksums). **New Castor Task…** writes a task into `castor.php`.
## Make them handy
- the ☆ pins one to the tool bar;
- **Shortcut, Icon and Events…**: a keyboard shortcut; run on save of matching files (`*.scss`), when the project opens, or **before**
chosen run configurations;
- each script is an action (**Run Script: …**) in Search Everywhere and a run configuration.
## Trust
Scripts never run by themselves until you trust the project once (the banner, or ⋯ > Trust This Project…). The answer is kept on this
computer, never in the project. A click always runs.