@nowline/cli 0.2.0 → 0.2.2

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.
@@ -1,4 +1,4 @@
1
- export declare const CLI_VERSION = "0.2.0";
1
+ export declare const CLI_VERSION = "0.2.2";
2
2
  export interface CliBuild {
3
3
  /** Short git SHA at build time, or empty when not in a git checkout. */
4
4
  readonly sha: string;
@@ -1,7 +1,7 @@
1
1
  // Auto-generated by scripts/bundle-templates.mjs. Do not edit by hand.
2
- export const CLI_VERSION = "0.2.0";
2
+ export const CLI_VERSION = "0.2.2";
3
3
  export const CLI_BUILD = {
4
- "sha": "c51e2a4",
4
+ "sha": "df3ebcc",
5
5
  "isRelease": true,
6
6
  "isDirty": false
7
7
  };
package/man/fr/nowline.1 CHANGED
@@ -6,7 +6,7 @@
6
6
  .Os
7
7
  .Sh NOM
8
8
  .Nm nowline
9
- .Nd produire, valider et servir des fichiers de feuille de route .nowline
9
+ .Nd créer des feuilles de route à partir d'un fichier texte lisible .nowline
10
10
  .Sh SYNOPSIS
11
11
  .Nm
12
12
  .Op Fl f Ar format
@@ -33,46 +33,17 @@
33
33
  .Op Fl h | Fl -help
34
34
  .Sh DESCRIPTION
35
35
  .Nm
36
- analyse un fichier de feuille de route
36
+ est une CLI qui traite des fichiers
37
37
  .Pa .nowline
38
- (ou sa forme JSON AST) et écrit le résultat produit dans un fichier ou
39
- sur la sortie standard.
40
- La production est le mode par défaut\ ; les autres modes sont
41
- sélectionnés par des indicateurs mutuellement exclusifs plutôt que par
42
- des sous-commandes
43
- .Pq sans verbe, comme mmdc, dot, d2, prettier et tsc .
38
+ simples et lisibles qui définissent une feuille de route, et non un
39
+ diagramme de Gantt.
40
+ L'artefact principal est un SVG, mais elle génère aussi de nombreux
41
+ autres artefacts dont PNG, PDF, HTML, Markdown+Mermaid, XLSX,
42
+ MS Project XML.
44
43
  .Pp
45
- Le pipeline de production est
46
- .Sy analyse
47
- \(->
48
- .Sy validation
49
- \(->
50
- .Sy mise en page
51
- \(->
52
- .Sy exportateur spécifique au format .
53
- La sortie est déterministe octet pour octet pour une entrée,
54
- .Fl -theme
55
- et
56
- .Fl -now
57
- donnés.
58
- .Pp
59
- Un seul binaire
60
- .Nm
61
- fournit tous les formats d'export\ : SVG, PNG, PDF, HTML,
62
- Markdown+Mermaid, XLSX, MS Project XML, et l'aller-retour AST
63
- .Pq json , nowline .
64
- .Pp
65
- .Ar entrée
66
- est obligatoire pour le mode de production par défaut, pour
67
- .Fl -serve
68
- et pour
69
- .Fl -dry-run .
70
- Indiquez
71
- .Sq -
72
- pour lire l'entrée standard.
73
- Sans argument,
74
- .Nm
75
- affiche l'aide et termine avec le code 0.
44
+ Cette page documente la CLI.
45
+ Pour le format de fichier, voir
46
+ .Xr nowline 5 .
76
47
  .Sh ENTRÉE
77
48
  Le format d'entrée est détecté à partir de l'extension du fichier\ :
78
49
  .Pa .nowline
@@ -84,6 +55,74 @@ L'entrée standard est traitée par défaut comme
84
55
  Utilisez
85
56
  .Fl -input-format
86
57
  pour les noms de fichiers inhabituels.
58
+ .Sh LANGAGE
59
+ Un fichier
60
+ .Pa .nowline
61
+ est une esquisse à indentation significative.
62
+ L'indentation canonique est de deux espaces\ ; les tabulations sont
63
+ acceptées mais ne doivent pas être mélangées avec des espaces dans un
64
+ même fichier.
65
+ Les chaînes sont entre guillemets doubles\ ; les propriétés sont des
66
+ paires
67
+ .Sy key:value .
68
+ Les commentaires utilisent
69
+ .Sq //
70
+ ou
71
+ .Sq /* */ .
72
+ .Pp
73
+ Mots-clés principaux\ :
74
+ .Bl -tag -width "person, team" -compact
75
+ .It Sy roadmap
76
+ La déclaration de feuille de route de plus haut niveau\ ; une seule
77
+ par fichier.
78
+ .It Sy swimlane
79
+ Une voie horizontale de travail (équipe, domaine, flux).
80
+ .It Sy item
81
+ Une unité de travail, indentée sous un
82
+ .Sy swimlane .
83
+ .It Sy parallel
84
+ Un bloc dont les enfants s'exécutent en simultané.
85
+ .It Sy group
86
+ Un regroupement logique d'éléments, rendus ensemble.
87
+ .It Sy anchor
88
+ Une date nommée sur la chronologie.
89
+ .It Sy milestone
90
+ Un repère ponctuel qui dépend d'un travail.
91
+ .It Sy person , team
92
+ Vocabulaire d'organisation référencé par
93
+ .Sy owner: .
94
+ .It Sy label
95
+ Étiquette réutilisable référencée par
96
+ .Sy labels: .
97
+ .El
98
+ .Pp
99
+ Chaque entité suit une forme universelle\ :
100
+ .Bd -literal -offset indent
101
+ keyword [id] ["title"] [key:value ...]
102
+ .Ed
103
+ .Pp
104
+ Au moins un identifiant
105
+ .Ar id
106
+ ou un titre
107
+ .Qq Ar title
108
+ est requis \(em l'analyseur les distingue par les guillemets.
109
+ .Pp
110
+ Exemple minimal\ :
111
+ .Bd -literal -offset indent
112
+ nowline v1
113
+ roadmap r "Demo" start:2026-01-06
114
+ swimlane platform
115
+ item research "Research" duration:3w
116
+ item build "Build" duration:2w
117
+ .Ed
118
+ .Pp
119
+ Voir
120
+ .Xr nowline 5
121
+ .Pq Sy man 5 nowline
122
+ pour la grammaire complète, toutes les propriétés, les règles de
123
+ validation et les déclarations
124
+ .Sy include
125
+ / config / style.
87
126
  .Sh INDICATEURS DE MODE
88
127
  Les indicateurs de mode ci-dessous sont mutuellement exclusifs.
89
128
  .Bl -tag -width Fl
@@ -421,4 +460,4 @@ les jalons libres
421
460
  et le modèle de localisation
422
461
  .Pq Pa specs/localization.md .
423
462
  .Sh AUTEURS
424
- .An Lolay Aq Mt packages@lolay.com
463
+ .An Les Auteurs de Nowline Aq Mt maintainers@nowline.io
package/man/fr/nowline.5 CHANGED
@@ -20,7 +20,7 @@
20
20
  Un fichier
21
21
  .Pa .nowline
22
22
  est une esquisse à indentation significative qui définit une feuille
23
- de route.
23
+ de route, et non un diagramme de Gantt.
24
24
  Le fichier lui-même est le produit\ ; tout autre artefact (SVG, PNG,
25
25
  PDF, HTML, Markdown+Mermaid, XLSX, MS Project XML) est une vue
26
26
  produite à partir de lui par
@@ -1861,4 +1861,4 @@ le modèle de localisation
1861
1861
  et les jalons libres
1862
1862
  .Pq Pa specs/milestones.md .
1863
1863
  .Sh AUTEURS
1864
- .An Lolay Aq Mt packages@lolay.com
1864
+ .An Les Auteurs de Nowline Aq Mt maintainers@nowline.io
package/man/nowline.1 CHANGED
@@ -3,7 +3,7 @@
3
3
  .Os
4
4
  .Sh NAME
5
5
  .Nm nowline
6
- .Nd render, validate, and serve .nowline roadmap files
6
+ .Nd create roadmaps using a human readable text file .nowline
7
7
  .Sh SYNOPSIS
8
8
  .Nm
9
9
  .Op Fl f Ar format
@@ -30,44 +30,16 @@
30
30
  .Op Fl h | Fl -help
31
31
  .Sh DESCRIPTION
32
32
  .Nm
33
- parses a
33
+ is a CLI that processes simple human readable
34
34
  .Pa .nowline
35
- roadmap file (or its JSON AST form) and writes the rendered output to a
36
- file or to standard output.
37
- Rendering is the default; other modes are selected by mutually-exclusive
38
- mode flags rather than subcommands
39
- .Pq verbless, matching mmdc, dot, d2, prettier, and tsc .
35
+ files that define a roadmap, not a Gantt chart.
36
+ The primary artifact is an SVG, but it also generates many other
37
+ artifacts including PNG, PDF, HTML, Markdown+Mermaid, XLSX, MS Project
38
+ XML.
40
39
  .Pp
41
- The render pipeline is
42
- .Sy parse
43
- \(->
44
- .Sy validate
45
- \(->
46
- .Sy layout
47
- \(->
48
- .Sy format-specific exporter .
49
- Output is byte-for-byte deterministic for a given input,
50
- .Fl -theme ,
51
- and
52
- .Fl -now .
53
- .Pp
54
- A single
55
- .Nm
56
- binary ships every export format: SVG, PNG, PDF, HTML,
57
- Markdown+Mermaid, XLSX, MS Project XML, plus AST round-trip
58
- .Pq json , nowline .
59
- .Pp
60
- .Ar input
61
- is required for the default render mode,
62
- .Fl -serve ,
63
- and
64
- .Fl -dry-run .
65
- Pass
66
- .Sq -
67
- to read from standard input.
68
- With zero arguments,
69
- .Nm
70
- prints help and exits 0.
40
+ This page documents the CLI.
41
+ For the file format, see
42
+ .Xr nowline 5 .
71
43
  .Sh INPUT
72
44
  The input format is detected from the file extension:
73
45
  .Pa .nowline
@@ -93,61 +65,28 @@ Comments use
93
65
  or
94
66
  .Sq /* */ .
95
67
  .Pp
96
- File structure has up to four sections in strict order:
97
- .Bl -enum -offset indent -compact
98
- .It
99
- .Sy nowline v1
100
- directive (optional, must be the first non-comment line; accepts
101
- .Sy locale:<bcp47> ) .
102
- .It
103
- .Sy include
104
- declarations (optional).
105
- .It
106
- .Sy config
107
- section (optional): styles, defaults, scale, calendar, symbols.
108
- .It
109
- .Sy roadmap
110
- section (required): the content.
111
- .El
112
- .Pp
113
- Keyword summary:
114
- .Bl -tag -width "person/team" -compact
115
- .It Sy nowline
116
- DSL version directive (currently
117
- .Sy v1 ) .
118
- .It Sy include
119
- Pull in another
120
- .Pa .nowline
121
- file;
122
- .Sy config:
123
- and
124
- .Sy roadmap:
125
- modes
126
- .Pq Sy merge | ignore | isolate
127
- control merge behavior.
128
- .It Sy config , roadmap
129
- Section markers; one
130
- .Sy roadmap
131
- per file.
132
- .It Sy style , symbol , default , scale , calendar
133
- Config keywords (presentation, defaults, axis, day arithmetic).
68
+ Core keywords:
69
+ .Bl -tag -width "person, team" -compact
70
+ .It Sy roadmap
71
+ The top-level roadmap declaration; one per file.
72
+ .It Sy swimlane
73
+ A horizontal lane of work (team, area, stream).
74
+ .It Sy item
75
+ A unit of work, indented under a swimlane.
76
+ .It Sy parallel
77
+ A block whose children run concurrently.
78
+ .It Sy group
79
+ A logical bundle of items, rendered together.
80
+ .It Sy anchor
81
+ A named date on the timeline.
82
+ .It Sy milestone
83
+ A point-in-time marker that depends on work.
134
84
  .It Sy person , team
135
85
  Org vocabulary referenced by
136
86
  .Sy owner: .
137
- .It Sy anchor , milestone
138
- Named dates and achievement markers on the timeline.
139
- .It Sy label , size , status
140
- Reusable vocabulary referenced by
141
- .Sy labels: , size: , status: .
142
- .It Sy swimlane
143
- Groups items by team / area / stream.
144
- .It Sy item
145
- Work item, indented under a swimlane (or parallel / group).
146
- .It Sy parallel , group
147
- Parallel block and sequential bundle; nestable.
148
- .It Sy footnote
149
- Annotation attached to one or more entities via
150
- .Sy on: .
87
+ .It Sy label
88
+ Reusable tag referenced by
89
+ .Sy labels: .
151
90
  .El
152
91
  .Pp
153
92
  Every entity follows a universal shape:
@@ -160,30 +99,22 @@ At least one of
160
99
  or
161
100
  .Qq Ar title
162
101
  is required \(em the parser distinguishes them by quoting.
163
- Lists use bracket notation
164
- .Pq Sy labels:[a, b] ;
165
- a trailing
166
- .Sq \e
167
- continues a line.
168
102
  .Pp
169
103
  Minimal example:
170
104
  .Bd -literal -offset indent
171
105
  nowline v1
172
-
173
106
  roadmap r "Demo" start:2026-01-06
174
-
175
- size m effort:1w
176
-
177
107
  swimlane platform
178
- item auth "Auth refactor" size:m
108
+ item research "Research" duration:3w
109
+ item build "Build" duration:2w
179
110
  .Ed
180
111
  .Pp
181
112
  See
182
113
  .Xr nowline 5
183
114
  .Pq Sy man 5 nowline
184
- for the full grammar, every property, validation rules, and the
115
+ for the full grammar, every property, validation rules, and
185
116
  .Sy include
186
- collision model.
117
+ / config / style declarations.
187
118
  .Sh MODE FLAGS
188
119
  The mode flags below are mutually exclusive.
189
120
  .Bl -tag -width Fl
@@ -514,4 +445,4 @@ the CLI surface
514
445
  and OSS milestones
515
446
  .Pq Pa specs/milestones.md .
516
447
  .Sh AUTHORS
517
- .An Lolay Aq Mt packages@lolay.com
448
+ .An The Nowline Authors Aq Mt maintainers@nowline.io
package/man/nowline.5 CHANGED
@@ -7,8 +7,9 @@
7
7
  .Sh DESCRIPTION
8
8
  A
9
9
  .Pa .nowline
10
- file is an indentation-significant outline that defines a roadmap.
11
- The file itself is the product; every other artefact (SVG, PNG, PDF,
10
+ file is an indentation-significant outline that defines a roadmap, not
11
+ a Gantt chart.
12
+ The file itself is the product; every other artifact (SVG, PNG, PDF,
12
13
  HTML, Markdown+Mermaid, XLSX, MS Project XML) is a view of it produced
13
14
  by
14
15
  .Xr nowline 1 .
@@ -670,7 +671,7 @@ plus a small title chiclet.
670
671
  A
671
672
  .Sy group
672
673
  with no styling is purely structural \(em it only governs
673
- sequencing and inner row growth, with no visible artefact.
674
+ sequencing and inner row growth, with no visible artifact.
674
675
  .Ss anchor \(em named date on the timeline
675
676
  .Bd -literal -offset indent
676
677
  anchor kickoff date:2026-01-06
@@ -1781,4 +1782,4 @@ the localization model
1781
1782
  and OSS milestones
1782
1783
  .Pq Pa specs/milestones.md .
1783
1784
  .Sh AUTHORS
1784
- .An Lolay Aq Mt packages@lolay.com
1785
+ .An The Nowline Authors Aq Mt maintainers@nowline.io
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nowline/cli",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "Nowline command-line interface — validate, convert, init",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
@@ -33,17 +33,17 @@
33
33
  "consola": "^3.4.0",
34
34
  "js-yaml": "^4.1.0",
35
35
  "langium": "~4.2.2",
36
- "@nowline/config": "0.2.0",
37
- "@nowline/core": "0.2.0",
38
- "@nowline/export-core": "0.2.0",
39
- "@nowline/export-html": "0.2.0",
40
- "@nowline/export-mermaid": "0.2.0",
41
- "@nowline/export-msproj": "0.2.0",
42
- "@nowline/export-png": "0.2.0",
43
- "@nowline/layout": "0.2.0",
44
- "@nowline/export-pdf": "0.2.0",
45
- "@nowline/renderer": "0.2.0",
46
- "@nowline/export-xlsx": "0.2.0"
36
+ "@nowline/config": "0.2.2",
37
+ "@nowline/export-core": "0.2.2",
38
+ "@nowline/export-html": "0.2.2",
39
+ "@nowline/export-mermaid": "0.2.2",
40
+ "@nowline/core": "0.2.2",
41
+ "@nowline/export-msproj": "0.2.2",
42
+ "@nowline/export-png": "0.2.2",
43
+ "@nowline/export-xlsx": "0.2.2",
44
+ "@nowline/layout": "0.2.2",
45
+ "@nowline/renderer": "0.2.2",
46
+ "@nowline/export-pdf": "0.2.2"
47
47
  },
48
48
  "devDependencies": {
49
49
  "@types/babel__code-frame": "^7.0.6",
@@ -1,6 +1,6 @@
1
1
  // Auto-generated by scripts/bundle-templates.mjs. Do not edit by hand.
2
2
 
3
- export const CLI_VERSION = "0.2.0";
3
+ export const CLI_VERSION = "0.2.2";
4
4
 
5
5
  export interface CliBuild {
6
6
  /** Short git SHA at build time, or empty when not in a git checkout. */
@@ -12,7 +12,7 @@ export interface CliBuild {
12
12
  }
13
13
 
14
14
  export const CLI_BUILD: CliBuild = {
15
- "sha": "c51e2a4",
15
+ "sha": "df3ebcc",
16
16
  "isRelease": true,
17
17
  "isDirty": false
18
18
  };