wyriwyd / wyriwyd Goto Github PK

Currently, the tool doesn't deal with programs writing to stderr

The command the user runs and wants to document, might request input from the user. Have to accommodate this!

Extend the testing tool by having it run a markdown file and insert each command blocks output into an output block. If one exists, it should be replaced, if nothing exists it should be created (or perhaps optionally ommitted, if that's what the user intended originally). Makes the testing tool even more like an org-mode / notebook tool for markdown and bash, and useful as a way to update docs automatically when a command has been changed.

Not quite working yet...
Also need to deal with special characters at the end of output lines.

As the code is structured at the moment the program will hang if trying to cat a file without an ending blank line.

The tutorial material generated, should not depend on resources (mainly input files) not in the repo. This would make the tutorial useless for a user of the package, and will (correctly) fail the wyriwyd tests.
How to fix:

• When wizard is run, should enforce the tutorial generated is self-contained.
• Other ideas?

The executor module maintains a bash shell and sends commands in, capturing each command's output. Since it's the same shell if you change directory and modify environment variables this is all available to the next commands. Perhaps the wizard's code could make use of this, but adding a command-line reader which sends the commands it receives to the executor and prints what the executor produces back out.

Would be good to auto-deploy this from the CI pipeline.

Improve open-access by helping people to cite this package.