Nicolas
e2d7207237
- Outillage complet : pnpm workspaces (catalog), Biome, TypeScript (project references, CommonJS/Node10), Vitest, TypeDoc (validation bloquante en CI), Changesets. - Organisation des packages en catégories client/common/server. - Migration de @lightweight-sdk/web-component (packages/client/) depuis l'ancien repo lightweight-sdk-web-component : code source copié à l'identique, aucune modification. package.json/tsconfig.json/README.md adaptés autour. Exclu de la validation TypeDoc stricte et de quelques règles Biome (formatage, noShadowRestrictedNames) puisque le code ne peut pas être édité pour s'y conformer - détails dans spec/packages.md. - Workflows Forgejo Actions (.forgejo/workflows/) : ci.yml (lint, build, test, docs:check) et release.yml (publication sur le registre npm privé via Changesets). - Script pnpm create-package <client|common|server> <nom> pour scaffolder les futurs packages. - Documentation dans /spec (architecture, conventions, ci-cd, packages). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# lightweight-sdk
|
|
|
|
Bibliothèque personnelle de packages TypeScript, organisée en monorepo pnpm et publiée sur le registre npm privé hébergé sur [git.dev.kyuno.fr](https://git.dev.kyuno.fr/kyuno).
|
|
|
|
## Structure
|
|
|
|
Les packages sont répartis en trois catégories sous `packages/` :
|
|
|
|
- `client/` — packages destinés au navigateur (DOM, composants UI).
|
|
- `common/` — code isomorphe partagé entre client et server.
|
|
- `server/` — packages Node/backend, structurés en services modulaires autonomes.
|
|
|
|
Voir [`spec/architecture.md`](./spec/architecture.md) pour le détail des choix d'outillage, et [`spec/packages.md`](./spec/packages.md) pour la liste des packages existants.
|
|
|
|
## Démarrage
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm build
|
|
pnpm lint
|
|
pnpm test
|
|
pnpm docs:check
|
|
```
|
|
|
|
## Créer un nouveau package
|
|
|
|
```bash
|
|
pnpm create-package <client|common|server> <nom-du-package>
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [`spec/architecture.md`](./spec/architecture.md) — vue d'ensemble et choix techniques.
|
|
- [`spec/conventions.md`](./spec/conventions.md) — conventions de code et traçabilité avec les directives du projet.
|
|
- [`spec/ci-cd.md`](./spec/ci-cd.md) — CI, versioning (Changesets) et publication sur le registre.
|
|
- [`spec/packages.md`](./spec/packages.md) — registre des packages du monorepo.
|