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

24 lines
915 B
Markdown

# JavaScript and TypeScript
`.js`, `.mjs`, `.ts` files use Monaco's JavaScript / TypeScript service (the one of VS Code): completion, hover, go to definition,
errors.
## Completion that knows the project
The IDE gives the service the files your code uses:
- the modules a file imports (relative paths);
- Symfony AssetMapper: the `importmap.php` entries map to their files, and `assets/vendor/` copies are read
(`import { Controller } from '@hotwired/stimulus'`, then `this.` completes);
- `node_modules` types (`package.json` `types`, `@types/`).
It stays bounded (150 files, 6 MB) and is refreshed when the imports change.
## Paths
`import` / `import()` / `require` / `new URL` paths are completed (folders first; bare names from importmap.php, package.json and
`node_modules`) and are links (`Ctrl+click`).
## Tests
`*.test.mjs` run with `node --test`, Vitest or Jest in the [Tests](tests.md) window.