@obsidiane/meridiane 2.0.6 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @obsidiane/meridiane
|
|
2
2
|
|
|
3
|
-
CLI pour générer un bridge Angular (
|
|
3
|
+
CLI pour générer un bridge Angular (runtime + models TypeScript) depuis une spec OpenAPI (API Platform + Mercure).
|
|
4
4
|
|
|
5
|
-
Documentation complète
|
|
5
|
+
Documentation complète du repo : `docs/guide-bridge.md`.
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
@@ -10,17 +10,11 @@ Documentation complète (repo) : `docs/guide-bridge.md`.
|
|
|
10
10
|
npm i -D @obsidiane/meridiane
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Ou en global :
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm i -g @obsidiane/meridiane
|
|
17
|
-
```
|
|
18
|
-
|
|
19
13
|
## Commandes
|
|
20
14
|
|
|
21
15
|
### `meridiane generate <packageName>`
|
|
22
16
|
|
|
23
|
-
Génère uniquement les
|
|
17
|
+
Génère uniquement les sources du bridge dans le workspace courant.
|
|
24
18
|
|
|
25
19
|
```bash
|
|
26
20
|
npx meridiane generate @acme/backend-bridge --spec ./openapi.json
|
|
@@ -30,7 +24,7 @@ Sortie par défaut : `projects/<libName>/` (modifiable via `--out`).
|
|
|
30
24
|
|
|
31
25
|
### `meridiane dev [packageName]`
|
|
32
26
|
|
|
33
|
-
|
|
27
|
+
Génération + build standalone + `npm pack` + installation locale dans `node_modules`.
|
|
34
28
|
|
|
35
29
|
```bash
|
|
36
30
|
npx meridiane dev @acme/backend-bridge --spec http://localhost:8000/api/docs.json
|
|
@@ -42,10 +36,10 @@ Sorties :
|
|
|
42
36
|
|
|
43
37
|
### `meridiane build <packageName>`
|
|
44
38
|
|
|
45
|
-
|
|
39
|
+
Génération + build standalone + `npm pack` (artefact publiable).
|
|
46
40
|
|
|
47
41
|
```bash
|
|
48
|
-
npx meridiane build @acme/backend-bridge --version
|
|
42
|
+
npx meridiane build @acme/backend-bridge --version 1.2.3 --spec https://staging.example/api/docs.json
|
|
49
43
|
```
|
|
50
44
|
|
|
51
45
|
Sorties :
|
|
@@ -54,20 +48,21 @@ Sorties :
|
|
|
54
48
|
|
|
55
49
|
## Options
|
|
56
50
|
|
|
57
|
-
- `--spec <url|file>` :
|
|
58
|
-
- `--formats <mimeTypes>` : répétable ou liste `,`
|
|
59
|
-
- `--include
|
|
60
|
-
- `--no-models` :
|
|
61
|
-
- `--version <semver>` :
|
|
62
|
-
- `--out <dir>` :
|
|
63
|
-
- `--debug` : logs détaillés
|
|
51
|
+
- `--spec <url|file>` : URL OpenAPI ou fichier JSON local (requis sauf `--no-models`)
|
|
52
|
+
- `--formats <mimeTypes>` : répétable ou liste `,` ; défaut `application/ld+json`
|
|
53
|
+
- `--include <substr>` / `--exclude <substr>` : filtres de noms de schémas (répétables, support `,`)
|
|
54
|
+
- `--no-models` : runtime only
|
|
55
|
+
- `--version <semver>` : `build` et `generate` (défaut `0.0.0`)
|
|
56
|
+
- `--out <dir>` : uniquement `generate`
|
|
57
|
+
- `--debug` : logs détaillés
|
|
64
58
|
|
|
65
59
|
## Notes importantes
|
|
66
60
|
|
|
67
|
-
-
|
|
68
|
-
-
|
|
69
|
-
-
|
|
61
|
+
- fallback automatique `.../api/docs.json` -> `.../api/docs.jsonopenapi` si nécessaire
|
|
62
|
+
- mode contract-driven : uniquement les schémas atteignables via `paths` pour les formats sélectionnés
|
|
63
|
+
- modèles `*jsonMergePatch*` non générés (`PATCH` typé `Partial<T>`)
|
|
64
|
+
- Meridiane ne publie pas : publication via `npm publish` côté CI
|
|
70
65
|
|
|
71
|
-
##
|
|
66
|
+
## Spécifique à ce repo
|
|
72
67
|
|
|
73
|
-
Dans ce
|
|
68
|
+
Dans ce monorepo, `meridiane dev` peut être exécuté sans `packageName` et cible alors `@obsidiane/bridge-sandbox` (app `apps/sandbox`).
|
package/package.json
CHANGED