WIP: Batch #2 #5

zph · 2021-03-18T06:21:57Z

WIP & TBD.

Context in #3 and #4 which contains Batch #1 of changes.

This PR are proposed changes subject to revision as we refine the good ergonomic concepts into what will merge and ship 🗡️ .

Current CLI output for tome --help

Each subcommand has its own targeted help: tome exec --help

Then running a subcommand: tome commands --directory ./example

List of changes:

TBD

TODO for merge:

Merge and deploy Batch 1: Github Actions, Brew recipe, linting suggestions, fish completion etc #4
Review and agree on cli interface
Verify autogenerated autocompletions
Manual regression testing
Passing CI and linting

…e for main binary

toumorokoshi · 2021-03-26T03:07:58Z

Looks like this also includes changes from #4. How about a review after #4 is merged?

toumorokoshi · 2021-04-04T21:21:32Z

@zph it looks like there's some conflicts that keep the diff from showing vs the newly-merged code, so I can a code review once that's merged in.

Regarding the UX of the CLI itself: Here are my high level design considerations and thoughts:

huge +1 to having some argparse library, to enable better help and CLI for the tome command itself.
are there any backwards-incompatible changes from the previous version of tome?
are there any backwards-incompatible changes from sub?
what sort of commands will be provided to the tome instance, vs the tome cli itself. e.g. {your-command} --help is automatically provided, as is {your command} help {foo} since I believe sub provided the same functionality.

Given these considerations, I'm wondering if we should perhaps start with a design.md-style file to start to align on these philosophical choices and strategies? If you agree, I can author one with some thoughts.

zph · 2021-04-04T21:29:31Z

A design doc together sounds great. I can reply and fill in details there later today 👍

zph

@toumorokoshi I fixed the merge conflicts but I've lost the front of mind context of these changes and this is a big PR.

We will work through the design doc, then maybe I can split out this PR into pieces to shrink the merge size.

zph · 2021-04-05T01:13:33Z

Cargo.toml

@@ -6,9 +6,9 @@ edition = "2018"
 license = "MIT"

 [dependencies]
-tui = "0.3.0"


Removed because they didn't look used.

zph · 2021-04-05T01:13:59Z

Cargo.toml

-termion = "*"
-
-
+clap = "3.0.0-beta.2"


Chose beta because of most up to date auto-generated shell completions.

I think it's fine, ultimately we produce a compiled binary so the use of beta internally is less of an issue I think.

zph · 2021-04-05T01:14:36Z

bin/tests

+
+set -eou pipefail
+
+cargo test --verbose


Convenience scripts, we can skip if you prefer.

Reasoning for them: never needing to wonder how to do an action in a given project when moving between projects or when new people contribute.

I don't have a strong opinion. I've seen Makefiles used for this purpose as well, but we can always clean up if things get unwieldy.

zph · 2021-04-05T01:15:59Z

src/commands/help.rs


 macro_rules! help_template {
    () => {
-        r#"echo -e
-'This is an instance of tome, running against the directory {}.
-\nThe commands are namespaced by the directory structure.


I simplified the escaping by printing this directly via eprintln vs trying to echo it.

zph · 2021-04-05T01:16:49Z

src/commands/init.rs

-            }
-        }
-    };
+    let shell_env = env::var("SHELL").unwrap();


TODO: move away entirely from trying to infer shell. Ask user to supply it :)

zph · 2021-04-05T01:17:54Z

src/commands/script.rs

                    consuming_help = false;
-                } else if let Some(rest) = line.strip_prefix("# ") {
+                } else if line.contains("# ") || line.contains("// ") {


TODO: generalize this to other common prefixes?

are you suggesting we should support other comment prefixes (e.g. '!' or ';') as well?

I think that seems reasonable. I would prefer to not get into the business of capturing multi-line comments though, since it forces us to write some level of recursive parsing or escaping.

zph · 2021-04-05T01:18:50Z

src/commands/script.rs

@@ -113,7 +121,7 @@ impl Script {
            CommandType::Execute => {
                let command_string = if self.should_source {
                    // when sourcing, just return the full body.
-                    let mut command = vec![String::from("."), self.path.clone()];
+                    let mut command = vec![String::from("source"), self.path.clone()];


For reading comprehension, source should be anbalagous to . but more self explanatory.

source is non-posix, so we should stick with dot. See the posix spec.

of course zsh and fish are not completely posix compliant, but I think we should strive to use posix semantics unless we have a strong reason not to.

zph · 2021-04-05T01:19:10Z

src/commands/script.rs

                let mut escaped_command_string = vec![];
                for mut arg in command_string {
                    arg = arg.replace("'", "\\'");
                    arg.insert(0, '\'');
                    arg.push('\'');
                    escaped_command_string.push(arg);
                }
+                // Include commandline arguments


These were left out before.

zph · 2021-04-05T01:19:46Z

src/commands/tests.rs

@@ -42,7 +42,7 @@ fn test_help() {
    ",
        )) as Box<dyn Read>,
    );
-    assert_eq!(&script.help_string, "foo bar baz\n");


🤔 should we have that newline or no?

Authoring a design goals document, to help document agreements and rationale for the design of the CLI interface. This will help further other PRs, including #5. Includes the following PRs: * Incorporate PR review discussion into design doc (#14) Co-authored-by: Zander Hill <zander@xargs.io>

toumorokoshi · 2021-04-06T06:06:43Z

thanks for the changes! I'll take a closer look at the code in the next couple days, especially now that #13 is in.

zph · 2021-04-06T06:27:26Z

@toumorokoshi Perfect. I'll tag you here when I get a chance to get back to it... likely later this week or during weekend 😄. Until then no need to spend time reviewing as it may undergo moderate change to match our spec in #13 .

zph · 2021-04-13T15:37:24Z

Update, I didn't get to work on it this weekend but will as schedule allows 🤗

toumorokoshi · 2021-04-14T15:08:33Z

Now worries, thanks for the update and staying in touch!

…

On Tue, Apr 13, 2021 at 8:37 AM Zander Hill ***@***.***> wrote: Update, I didn't get to work on it this weekend but will as schedule allows 🤗 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC7QSEIHJKYPOMN4D3RRNLTIRQMLANCNFSM4ZL7MBWQ> .

toumorokoshi · 2022-01-01T22:51:21Z

@zph happy new year! My cycles are starting to free up, so I think I want to take the step to try to get tome to 1.0 and start trying to get some buzz on it.

Is it alright with you if I move forward with the design that we discussed? If you still have the cycles to contribute you're more than welcome, but don't want to burden you if you have other things going on.

zph · 2022-01-03T17:57:01Z

@toumorokoshi I'm excited to hear that you're freeing up for more Tome! I'm in strong support of you carrying on with the design we discussed :D.

I can't offer to do much on it myself right now, but I could definitely exchange a few messages or look over code in a PR if you want me involved.

Happy New Year!

PS - I know a friend who's using this for their commandline tooling and can see if they're free to also try out an RC once it's near v1.0.

toumorokoshi · 2022-01-04T16:47:40Z

@toumorokoshi I'm excited to hear that you're freeing up for more Tome! I'm in strong support of you carrying on with the design we discussed :D.

I can't offer to do much on it myself right now, but I could definitely exchange a few messages or look over code in a PR if you want me involved.

Happy New Year!

PS - I know a friend who's using this for their commandline tooling and can see if they're free to also try out an RC once it's near v1.0.

Sounds great and thanks for all of your help! I'll send some pings once I scope the 1.0 milestone.

Nattle · 2022-01-04T16:49:56Z

Just wanted to pop in and say that I use tome all the time. I have 3 separate commands that I use for work stuff in different scopes and another tome that I used for my personal stuff.

I appreciate all the work!

toumorokoshi · 2022-04-30T17:45:42Z

Hello! I think all of the changes that would have been introduced in this PR have been incorporated in the main branch (use of clap, new reserved commands, fish support).

With that, I think we can close this PR out. Thanks for all the help!

zph added 11 commits March 18, 2021 00:06

Compiling successful after refactor, tests broken

5dcbf1b

Auto-formatting and argument changes

d5800f0

Revert to using existing pattern for init

5859173

Print errors to stderr

df9ce5f

Successfully generate basic commandline completions from clap_generat…

fa72ab6

…e for main binary

Update tests to match completion expectations

c882075

Autoformatting

572e3a0

Allow for non octothorp driven languages for help and source directives

9ba52b6

Allow for // type help lines

0d51fe9

Add about definitions for all subcommands

43a1b70

Fix incorrect dependency source for clap_generate

6d6b4fc

zph force-pushed the use-clap branch from 8fe360b to 6d6b4fc Compare March 18, 2021 07:07

zph added 2 commits March 18, 2021 18:38

Add helper scripts for testing and linting

b0360f6

Update fish completion in init_v2

8b79b32

toumorokoshi self-requested a review April 4, 2021 21:15

toumorokoshi mentioned this pull request Apr 4, 2021

docs: Adding CLI design proposal #13

Merged

Merge branch 'master' into use-clap

2c593be

zph commented Apr 5, 2021

View reviewed changes

zph added 3 commits June 1, 2021 22:01

Merge branch 'toumorokoshi:master' into use-clap

e520d97

Convert -h to help subcommand per design spec

61098dc

Extract duplicate definitions in clap init

b87073a

toumorokoshi closed this Apr 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Batch #2 #5

WIP: Batch #2 #5

zph commented Mar 18, 2021 •

edited

Loading

toumorokoshi commented Mar 26, 2021

toumorokoshi commented Apr 4, 2021

zph commented Apr 4, 2021

zph left a comment

zph Apr 5, 2021

zph Apr 5, 2021

toumorokoshi Apr 5, 2021

zph Apr 5, 2021

zph Apr 5, 2021

toumorokoshi Apr 5, 2021

zph Apr 5, 2021

zph Apr 5, 2021

zph Apr 5, 2021

toumorokoshi Apr 5, 2021

zph Apr 5, 2021

toumorokoshi Apr 5, 2021

toumorokoshi Apr 5, 2021

zph Apr 5, 2021

zph Apr 5, 2021

toumorokoshi commented Apr 6, 2021

zph commented Apr 6, 2021 •

edited

Loading

zph commented Apr 13, 2021

toumorokoshi commented Apr 14, 2021 via email

toumorokoshi commented Jan 1, 2022

zph commented Jan 3, 2022

toumorokoshi commented Jan 4, 2022

Nattle commented Jan 4, 2022

toumorokoshi commented Apr 30, 2022

WIP: Batch #2 #5

WIP: Batch #2 #5

Conversation

zph commented Mar 18, 2021 • edited Loading

toumorokoshi commented Mar 26, 2021

toumorokoshi commented Apr 4, 2021

zph commented Apr 4, 2021

zph left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

toumorokoshi commented Apr 6, 2021

zph commented Apr 6, 2021 • edited Loading

zph commented Apr 13, 2021

toumorokoshi commented Apr 14, 2021 via email

toumorokoshi commented Jan 1, 2022

zph commented Jan 3, 2022

toumorokoshi commented Jan 4, 2022

Nattle commented Jan 4, 2022

toumorokoshi commented Apr 30, 2022

zph commented Mar 18, 2021 •

edited

Loading

zph commented Apr 6, 2021 •

edited

Loading