Add quicli post by killercup · Pull Request #14 · killercup/scribbles

killercup · 2018-01-29T20:06:44Z

No description provided.

killercup · 2018-01-29T20:13:33Z

Thanks so much for offering to review this, @jamesmunns! :)

killercup · 2018-01-29T20:48:20Z

@mgattozzi pong! :)

jamesmunns

👍

A few grammar/spelling comments, but other than that thanks for sharing!

jamesmunns · 2018-01-29T21:34:31Z

+[#19]: https://github.com/killercup/quicli/issues/19
+
+That sounded pretty awesome and made me really proud:
+Did me library


s/Did me/Did my

jamesmunns · 2018-01-29T21:35:05Z

+
+But, before blindly agreeing to this,
+I needed to take a step back
+and evaluate what I want quicli to be.


want => wanted (consistent past tense)

jamesmunns · 2018-01-29T21:35:50Z

+I just wanted a small framework-like thing
+that made writing CLI apps less of a pain.
+But how exactly do I want to to this?
+Thanks to Garretts' questions and comments


jamesmunns · 2018-01-29T21:37:37Z

+
+In its implementation,
+you get what I'd call
+"a small framework around you main function":


jamesmunns · 2018-01-29T21:38:00Z

+In its implementation,
+you get what I'd call
+"a small framework around you main function":
+quicly's `main!` macro set up some basic things,


This is embarrassing

jamesmunns · 2018-01-29T21:46:23Z

+Sadly, for newcomers/forgetful people/drunk programmers/etc.
+they are also _wonderfully complex._
+
+So, instead of offering the user "everything,"


"everything",

Oh, I went with the American style here, as I'm also using American spelling everywhere (I think)

You are. What @jamesmunns put is how I always spell everything. I really don't see it split up often but both are valid!

You know what: You're both right and I actually like the ", version more because it makes way more sense when parsing a sentence. It's just that I really like typography and the hanging quotes look so pretty. Oh well, I'm rendering everything in shitty monospace markdown style anyway :)

jamesmunns · 2018-01-29T21:46:41Z

+So, instead of offering the user "everything,"
+I want to introduce some abstractions that are simple to use,
+and have simple but useful examples.
+Not not get stuck,


"not to get stuck"

jamesmunns · 2018-01-29T21:48:06Z

+Since then, I've written two more guides,
+and for both I added features to the framework,
+exposed new functionality,
+and thought more about how I want quicly-based code to feel.


quicly => quicli

This is sooo embarrassing

jamesmunns · 2018-01-29T21:50:27Z

+and for both I added features to the framework,
+exposed new functionality,
+and thought more about how I want quicly-based code to feel.
+(More on the aspect of hosting and testing these docs in a future post!)


The whole sentence is in parentheses

jamesmunns · 2018-01-29T21:51:26Z

+It gives you a way of quickly writing CLI programs in Rust.
+(Hence the name.)
+In this post,
+I want to present the ideas and underlaying philosophies of this project.


@jamesmunns

found by @jamesmunns --Thanks!

killercup

Thanks so much! Pushed an update that addressed everything I didn't explicitly comment on :)

killercup · 2018-01-29T21:58:27Z

+In its implementation,
+you get what I'd call
+"a small framework around you main function":
+quicly's `main!` macro set up some basic things,


This is embarrassing

killercup · 2018-01-29T21:59:17Z

+(as well as my ergonomic requirements).
+
+What I want you to end up with is code that is
+concise,


Well-structured and boilerplate-free and part of the same point! See below

killercup · 2018-01-29T22:00:44Z

+Sadly, for newcomers/forgetful people/drunk programmers/etc.
+they are also _wonderfully complex._
+
+So, instead of offering the user "everything,"


Oh, I went with the American style here, as I'm also using American spelling everywhere (I think)

killercup · 2018-01-29T22:01:22Z

+Since then, I've written two more guides,
+and for both I added features to the framework,
+exposed new functionality,
+and thought more about how I want quicly-based code to feel.


This is sooo embarrassing

killercup · 2018-01-29T22:01:58Z

+and for both I added features to the framework,
+exposed new functionality,
+and thought more about how I want quicly-based code to feel.
+(More on the aspect of hosting and testing these docs in a future post!)


The whole sentence is in parentheses

killercup · 2018-01-29T22:18:56Z

@skade pong! :)

mgattozzi · 2018-01-30T01:28:26Z

@killercup ping! :D

mgattozzi

Not bad! Mostly some grammatical, formatting, and spelling nit picks :D

mgattozzi · 2018-01-30T01:29:08Z

+
+I've been writing CLI tools in Rust for a while now.
+It really surprised me how this language
+that works really well for system programming


system -> systems

mgattozzi · 2018-01-30T01:29:45Z

+["5 Tips for Writing Small CLI Tools in Rust"][cli-tips]
+at the end of August 2017
+that you may have read,
+where I describes some of my take-aways from that


describes -> describe

mgattozzi · 2018-01-30T01:30:33Z

+that you may have read,
+where I describes some of my take-aways from that
+in the form of short tips.
+I've got some great feedback to that post,


I've got -> I've gotten
to -> from

mgattozzi · 2018-01-30T01:31:22Z

+I didn't have the time or concentration
+to sit down and really do this.
+And here's the good news:
+For some reason[^9e-talk],


Does this link render funny?

Yes: It renders a footnote :)

mgattozzi · 2018-01-30T01:32:03Z

+
+[cli-tips]: {% post_url 2017-08-31-rust-cli-tips %}
+
+[^9e-talk]: Okay, I admit, I promised to give a talk about Rust, and I wanted to present some nice, clean example code. (Of course, in the end I didn't show quicli in the talk.)


Since you've made these two separate sentences rather than an aside you can remove the ( and )

yeah, the create-react-app setup tools famously has this feature

mgattozzi · 2018-01-30T01:52:32Z

+So, instead of offering the user "everything,"
+I want to introduce some abstractions that are simple to use,
+and have simple but useful examples.
+Not to get stuck,


Were you intending this to be part of the previous sentence? Otherwise I have no idea what you were trying to convey here with this sentence or what you mean by Not to get stuck

Messed up the fix, should've been "To not get stuck"

mgattozzi · 2018-01-30T01:52:56Z

+Indeed, instead of adding any feature flags to this crate
+(that enable additional components to be loaded/exposed),
+I want to have a clear line
+where a user is supposed to stop relying on quicli.


mgattozzi · 2018-01-30T01:53:18Z

+(that enable additional components to be loaded/exposed),
+I want to have a clear line
+where a user is supposed to stop relying on quicli.
+I'd rather have an "eject" option


react-cli (I think) does this and it's nice.

mgattozzi · 2018-01-30T01:53:43Z

+but another important aspect to me is to prove that it is useful
+for writing small tools
+-- even if you've only just started with Rust.
+This is why I initially wrote the Readme file


Readme -> README

but but… my file is Readme.md :O

mgattozzi · 2018-01-30T01:53:56Z

+for writing small tools
+-- even if you've only just started with Rust.
+This is why I initially wrote the Readme file
+in form of a How To:


in -> in the

mgattozzi · 2018-01-30T01:55:13Z

I say a few but there were like 34 there lol woops

killercup · 2018-01-30T07:48:03Z

There is no such thing as too many nits! Thanks a lot, @mgattozzi, will edit this tonight! Michael Gattozzi <notifications@github.com> schrieb am Di. 30. Jan. 2018 um 02:55:

…

I say a few but there were like 34 there lol woops — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#14 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABOX3MrRd0N9O2JKzN1qHW_Z3OkpX51ks5tPnaBgaJpZM4RxRlg> .

skade · 2018-01-30T08:03:53Z

I like it. I'd reread the introduction and see if you could make it a little shorter.

I haven't quite gotten out of it if you will merge stdcli and quicli now?

@mgattozzi

As suggested by @mgattozzi --Thanks!

killercup

Addressed a bunch of comments :)

killercup · 2018-01-30T19:40:44Z

+Sadly, for newcomers/forgetful people/drunk programmers/etc.
+they are also _wonderfully complex._
+
+So, instead of offering the user "everything,"


You know what: You're both right and I actually like the ", version more because it makes way more sense when parsing a sentence. It's just that I really like typography and the hanging quotes look so pretty. Oh well, I'm rendering everything in shitty monospace markdown style anyway :)

killercup · 2018-01-30T19:41:59Z

+I didn't have the time or concentration
+to sit down and really do this.
+And here's the good news:
+For some reason[^9e-talk],


Yes: It renders a footnote :)

killercup · 2018-01-30T19:42:10Z

+	it is very concise.
+
+	Another aspect of conciseness:
+	Instead of using `.unwrap` to deal with errors,


Hm, I actually added the dot to note that it is a method and not a free function. But you're right, they're all the same :)

killercup · 2018-01-30T19:42:21Z

+	and good error messages.
+	Similarly, you get logging for free,
+	and if you add two more lines,
+	you also get a `--verbose`/`-v` CLI argument to control the log level


I <3 consistency and will go with 'flag'

killercup · 2018-01-30T19:42:42Z

+So, instead of offering the user "everything,"
+I want to introduce some abstractions that are simple to use,
+and have simple but useful examples.
+Not to get stuck,


Messed up the fix, should've been "To not get stuck"

killercup · 2018-01-30T19:42:51Z

+
+[cli-tips]: {% post_url 2017-08-31-rust-cli-tips %}
+
+[^9e-talk]: Okay, I admit, I promised to give a talk about Rust, and I wanted to present some nice, clean example code. (Of course, in the end I didn't show quicli in the talk.)


yeah, the create-react-app setup tools famously has this feature

killercup · 2018-01-30T19:42:59Z

+but another important aspect to me is to prove that it is useful
+for writing small tools
+-- even if you've only just started with Rust.
+This is why I initially wrote the Readme file


but but… my file is Readme.md :O

Almost forgot that!

killercup · 2018-01-30T21:02:04Z

Thank you three! The post is now live at https://deterministic.space/quicli.html :)

Add quicli post

a2fa632

jamesmunns reviewed Jan 29, 2018

View reviewed changes

Quicli post: Fix typos

006ca0c

found by @jamesmunns --Thanks!

killercup commented Jan 29, 2018

View reviewed changes

mgattozzi reviewed Jan 30, 2018

View reviewed changes

Quicli post: Fix typos (and content)

49c72cd

As suggested by @mgattozzi --Thanks!

killercup commented Jan 30, 2018

View reviewed changes

killercup added 4 commits January 30, 2018 21:51

Quicli post: Rewrite intro, link to website

2013e93

Quicli post: Thank you dear reviewers <3

11b4531

Quicli post: Fix indentation

f78d3aa

Almost forgot that!

Quicli post: Longer title

ca3e238

killercup merged commit 7391dde into gh-pages Jan 30, 2018

killercup deleted the post/quicli branch May 31, 2018 19:17


		[cli-tips]: {% post_url 2017-08-31-rust-cli-tips %}

		[^9e-talk]: Okay, I admit, I promised to give a talk about Rust, and I wanted to present some nice, clean example code. (Of course, in the end I didn't show quicli in the talk.)

Conversation

killercup commented Jan 29, 2018

Uh oh!

killercup commented Jan 29, 2018

Uh oh!

killercup commented Jan 29, 2018

Uh oh!

jamesmunns left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

killercup left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

killercup Jan 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

killercup commented Jan 29, 2018

Uh oh!

mgattozzi commented Jan 30, 2018

Uh oh!

mgattozzi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

killercup left a comment •

edited

Loading

killercup Jan 29, 2018 •

edited

Loading

skade commented Jan 30, 2018 •

edited

Loading