nushell / nushell/nushell.github.io
Generate terminal output
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 258
- Fork
- 561
- Merge medio
- 3h 20m
- PR unite (30g)
- 15
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando il processo di build attuale e il modo in cui gli esempi di output del terminale vengono archiviati nel repository del sito web. Leggi l’API collegata di crossnote MarkdownEngine#runCodeChunks e confronta il suo approccio con le esigenze descritte qui. Il lavoro è completato quando l’output del terminale viene generato in fase di build, comprese le tabelle annidate, in modo che gli esempi non richiedano più aggiornamenti manuali in caso di Breaking Changes.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- build-system, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100