nushell / nushell/nushell.github.io
Generate terminal output
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 258
- Forks
- 561
- Ø Merge
- 3 Std. 20 Min.
- Gemergte PRs (30 T.)
- 15
Beschreibung
The current output isn't up to date. Tables aren't nested (#917). It's also a maintenance burden to identify examples to update (#774) for breaking changes. My proposal is to generate the output at build time.
I use the Markdown Preview Enhanced VS Code extension that provides this exact feature. Its author also provides a library called https://github.com/shd101wyy/crossnote. The API we're looking for (whether dependency or inspiration) is MarkdownEngine#runCodeChunks.
Also shout out to @shd101wyy for an amazing tool 👏🏼 I'm happy to attempt implementation when I have time.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, den aktuellen Build-Prozess und die Speicherung der Beispiele für Terminalausgaben im Website-Repository zu überprüfen. Lies die verlinkte crossnote MarkdownEngine#runCodeChunks API und vergleiche ihren Ansatz mit den hier beschriebenen Anforderungen. Als abgeschlossen gilt die Aufgabe, wenn die Terminalausgabe zur Build-Zeit generiert wird, einschließlich verschachtelter Tabellen, sodass Beispiele bei Breaking Changes keine manuellen Aktualisierungen mehr erfordern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- build-system, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100