nushell / nushell/nushell.github.io
Generate terminal output
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current build process and how terminal-output examples are stored in the website repository. Read the linked crossnote MarkdownEngine#runCodeChunks API and compare its approach with the needs described here. Done means terminal output is generated at build time, including nested tables, so examples no longer require manual updates for breaking changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100