Comments (10)
here is the initial release of ergo_fs. Check it out!
from quicli.
Another idea: this library would be a great addition to use in the cookbook once it's API is nailed down. It could answer all sorts of "how do I do X for a CLI" with an ultra-simple example.
from quicli.
we could also write examples in an examples/
module which literally only contains //! doc comments
containing examples. This way the examples can be displayed offline easily through cargo doc
(and the rust testrunner automatically tests them)
from quicli.
Yeah, I was thinking of cookbook style examples. I'd rather keep this separate from the Real Rust Cookbook, though, because a) this crate is fresh off the press and nowhere near stable and b) it's way easier to iterate here.
The reason I don't want to write these as doc comments for rustdoc to parse is simple: I need to test that the recipes work in external crates. I didn't even notice #9 until I tried using quicli as a real, external dependency.
Running the recipes as tests should not be a problem. waltz can extract arbitrary files from markdown source (you just have to annotate the file name), and we can trivially add a target like for d in */; { (echo "testing $d"; cd "$d"; ls | cargo test); }
.
from quicli.
Those all sound like good reasons to me! Waltz looks awesome also.
from quicli.
The reason I don't want to write these as doc comments for rustdoc to parse is simple: I need to test that the recipes work in external crates.
mdbook had a recent release announcement, used for official Rust book and Rust by Example
projects. In the reddit thread they mention a related crate for performing tests that can use external crates from crates.io performing tests better than rustdoc
. May be of interest to you :)
Some gif animations showing a CLI project would be nice to see too(on this repo README and any docs as small examples of features? There is also an embeddable type of animation specifically for showing of CLI projects ASCIInema that might appeal :)
from quicli.
Thanks for the link, @polarathene! I don't think mdbook-test is helpful to me here, though (or maybe I misunderstood it). Have a look at #24 to see what kind of literate programming I want to use for the guides :)
from quicli.
@alexcrichton sorry that I accidentally sent you an invite to ergo! Know that you are totally welcome to join if you would like, but I didn't mean to spam you 😄
from quicli.
Oh no, don't invite Alex! I want him to work on tokio instead! :P
from quicli.
💥 https://killercup.github.io/quicli/ 💥
from quicli.
Related Issues (20)
- Quicli in the wild HOT 2
- Testing, examples, docs, CI
- Move Result type out of the prelude HOT 2
- Update failure to 1.0.0 on March 15
- docs and crates to support re-parsing the command line (readline style)
- export clap macros HOT 2
- Unix pipes support out of the box HOT 1
- Switch to globwalk
- human-panic
- Readme example doesn't compile HOT 2
- StructOpt not found in scope HOT 3
- "methods are not allowed for flattened entry" HOT 1
- Expose remove_dir_all crate HOT 1
- main! macro emits warning
- Turn on logging in all subcrates? HOT 2
- use of deprecated item 'failure::Error::causes' HOT 2
- issue in 'getting started' HOT 2
- Issue with glob in thumbnail tutorial HOT 2
- Include `read_input`?
- bail!() no longer works with quicli 0.4 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from quicli.