8ceda4d12f
- Describe complete Fig archive, conversion, instance, and metadata ownership\n- Refresh contributor paths across localized development guides\n- Mark Track D complete in the local master plan
97 lines
4.4 KiB
Markdown
97 lines
4.4 KiB
Markdown
# Contribuer
|
|
|
|
## Structure du projet
|
|
|
|
```
|
|
packages/
|
|
core/ @open-pencil/core — moteur (zéro dépendance DOM)
|
|
src/ Graphe de scène, renderer, layout, codec, kiwi, types
|
|
cli/ @open-pencil/cli — CLI headless pour opérations .fig
|
|
src/commands/ info, tree, find, export, eval, analyze
|
|
mcp/ @open-pencil/mcp — serveur MCP pour outils IA
|
|
src/ Transports stdio + HTTP (Hono), 87 outils
|
|
src/
|
|
components/ Vue SFCs (canevas, panneaux, barre d'outils, sélecteur de couleur)
|
|
properties/ Sections du panneau de propriétés (Apparence, Remplissage, Contour, etc.)
|
|
composables/ Entrée canevas, raccourcis clavier, hooks de rendu
|
|
stores/ État de l'éditeur (réactivité Vue)
|
|
engine/ Shims de ré-exportation depuis @open-pencil/core
|
|
kiwi/ Shims de ré-exportation depuis @open-pencil/core
|
|
types.ts Types partagés (ré-exportés depuis core)
|
|
constants.ts Couleurs UI, défauts, seuils
|
|
desktop/ Tauri v2 (Rust + config)
|
|
tests/
|
|
e2e/ Régression visuelle Playwright
|
|
engine/ Tests unitaires (bun:test)
|
|
docs/ Site de documentation VitePress
|
|
specs/ Spécifications de capacités (source de vérité)
|
|
changes/ Changements actifs et archivés
|
|
```
|
|
|
|
## Configuration du développement
|
|
|
|
```sh
|
|
bun install
|
|
bun run dev # Éditeur sur localhost:1420
|
|
bun run docs:dev # Docs sur localhost:5173
|
|
```
|
|
|
|
## Style de code
|
|
|
|
### Outils
|
|
|
|
| Outil | Commande | Objectif |
|
|
|-------|----------|----------|
|
|
| oxlint | `bun run lint` | Linting (basé sur Rust, rapide) |
|
|
| oxfmt | `bun run format` | Formatage du code |
|
|
| tsgo | `bun run typecheck` | Vérification de types (checker TypeScript basé sur Go) |
|
|
|
|
Exécuter toutes les vérifications :
|
|
|
|
```sh
|
|
bun run check
|
|
```
|
|
|
|
### Conventions
|
|
|
|
- **Noms de fichiers** — kebab-case (`scene-graph.ts`, `use-canvas-input.ts`)
|
|
- **Composants** — PascalCase Vue SFCs (`EditorCanvas.vue`, `NumberField.vue`)
|
|
- **Constantes** — SCREAMING_SNAKE_CASE
|
|
- **Fonctions/variables** — camelCase
|
|
- **Types/interfaces** — PascalCase
|
|
|
|
### Conventions pour agents IA
|
|
|
|
Les développeurs et agents IA doivent lire `AGENTS.md` à la racine du repo ([voir sur GitHub](https://github.com/open-pencil/open-pencil/blob/master/AGENTS.md)). Couvre le rendu, le graphe de scène, les composants et instances, le layout, l'UI, le format de fichier, les conventions Tauri et les problèmes connus.
|
|
|
|
## Apporter des changements
|
|
|
|
3. Implémenter le changement
|
|
4. Exécuter `bun run check` et `bun run test`
|
|
5. Soumettre une pull request
|
|
|
|
## Fichiers clés
|
|
|
|
Le code source du moteur core se trouve dans `packages/core/src/`. Le code propre à l'app pour l'éditeur, les documents, l'IA, la collaboration, le shell, les démos et l'automatisation vit sous `src/app/*`; le SDK Vue contient le code canvas et composable réutilisable dans `packages/vue/src/`.
|
|
|
|
| Fichier | Objectif |
|
|
|---------|----------|
|
|
| `packages/scene-graph/src/` | Graphe de scène : nœuds, variables, instances, hit testing et annulation |
|
|
| `packages/core/src/canvas/renderer.ts` | Pipeline de rendu CanvasKit |
|
|
| `packages/core/src/layout/` | Adaptateur layout Yoga |
|
|
| `packages/core/src/clipboard.ts` | Presse-papiers compatible Figma |
|
|
| `packages/core/src/vector/` | Modèle de réseau vectoriel |
|
|
| `packages/core/src/io/formats/raster/render.ts` | Export d'image hors-écran (PNG/JPG/WEBP) |
|
|
| `packages/kiwi/src/schema-runtime/` | Runtime de schéma et codec binaire Kiwi |
|
|
| `packages/fig/src/node-change/` | Conversion entre SceneGraph et Figma NodeChange |
|
|
| `packages/core/src/io/formats/fig/` | Orchestration de lecture/écriture .fig pour l'application |
|
|
| `packages/cli/src/index.ts` | Point d'entrée du CLI |
|
|
| `packages/core/src/tools/` | Définitions d'outils unifiées (IA, MCP, CLI) |
|
|
| `packages/core/src/figma-api/` | Implémentation de Figma Plugin API |
|
|
| `packages/mcp/src/server.ts` | Factory du serveur MCP |
|
|
| `packages/cli/src/commands/` | Commandes CLI (info, tree, find, export, eval, analyze) |
|
|
| `src/app/editor/session/create.ts` | Editor session assembly |
|
|
| `packages/vue/src/canvas/CanvasRoot.vue` | Composable de rendu du canevas |
|
|
| `packages/vue/src/canvas/useCanvasInput.ts` | Gestion des entrées souris/touch |
|
|
| `src/app/shell/keyboard/use.ts` | Gestion des raccourcis clavier |
|