nushell / nushell/nushell.github.io
Generate terminal output
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 258
- Forks
- 561
- Merge moyen
- 3 h 20 min
- PR mergées (30 j)
- 15
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner le processus de build actuel et la manière dont les exemples de sortie du terminal sont stockés dans le dépôt du site web. Lisez l’API crossnote MarkdownEngine#runCodeChunks liée et comparez son approche aux besoins décrits ici. Le travail est considéré comme terminé lorsque la sortie du terminal est générée au moment du build, y compris les tableaux imbriqués, afin que les exemples ne nécessitent plus de mises à jour manuelles lors de Breaking Changes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- build-system, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100