autocomplete icon indicating copy to clipboard operation
autocomplete copied to clipboard

feat: add completion spec for tmuxinator

Open christianmeier opened this issue 3 years ago • 4 comments

added spec for tmuxinator

christianmeier avatar Jan 27 '22 08:01 christianmeier

Overview

src/tmuxinator.ts:

Info:

withfig-bot avatar Jan 27 '22 08:01 withfig-bot

Hello @christianmeier, thank you very much for creating a Pull Request! Here is a small checklist to get this PR merged as quickly as possible:

  • [ ] Do all subcommands / options which take arguments include the args property (args: {})?
  • [ ] Are all options modular? E.g. -a -u -x instead of -aux
  • [ ] Have all other checks passed?

Please add a 👍 as a reaction to this comment to show that you read this.

withfig-bot avatar Jan 27 '22 08:01 withfig-bot

👍

christianmeier avatar Jan 27 '22 08:01 christianmeier

Hi Fred, thank you for your comments. I’ll solve them 😊

BR C

From: Federico Ciardi @.> Reply to: withfig/autocomplete @.> Date: Thursday, 27 January 2022 at 18:06 To: withfig/autocomplete @.> Cc: christianmeier @.>, Mention @.***> Subject: Re: [withfig/autocomplete] feat: add completion spec for tmuxinator (PR #881)

@fedeci requested changes on this pull request.

Thanks for your contribution! There are a couple of thinks to merge as well as linting, then we are ready to merge this in!

In src/tmuxinator.ts:

+    {

+      name: "local",

+      description:

+        "Start a tmux session using ./.tmuxinator.y[a]ml",

+    },

We could also add file suggestion for this arg, see the filepaths generator sugar: #794

In src/tmuxinator.ts:

+      name: "start",

+      description:

+        "Start a tmux session using a project's name (with an optional [ALIAS] for project reuse) or a path to a project config file",

+      args: [{

+        name: "PROJECT",

+        description: "Project name 1",

+        isOptional: true,

+      },

+      {

+        name: "ARGS",

+        description: "Argument",

+        isOptional: true,

+      },

+      ],

There are some options missing for the start command https://github.com/tmuxinator/tmuxinator#starting-a-session, could you add them please?

In src/tmuxinator.ts:

+const completionSpec: Fig.Spec = {

+  name: "tmuxinator",

+  description: "Tmuxinator is a ruby gem that allows you to easily manage tmux sessions by using yaml files to describe the layout of a tmux session, and open up that session with a single command",

+  subcommands: [

+    {

+      name: "commands",

+      description:

+        "Lists commands available in tmuxinator",

+    },

+    {

+      name: "completions",

+      description:

+        "Used for shell completion",

+    },

+    {

+      name: "copy",

There are other subcommands missing aliases, could you add them?

⬇️ Suggested change -      name: "copy",

+      name: ["copy", "c", "cp"],

In src/tmuxinator.ts:

+      args: [{

+        name: "EXISTING",

+        description: "The existing project",

+        isOptional: true,

+      },

+      {

+        name: "NEW",

+        description: "Name new project",

+        isOptional: true,

+      },

+      ],

I am not sure whether these are optional 🤔, what happens if you do not provide them?

In src/tmuxinator.ts:

+      args: [{

+        name: "PROJECT1",

+        description: "Project name 1",

+        isOptional: true,

+      },

+      {

+        name: "PROJECT1",

+        description: "Project name 1",

+        isOptional: true,

+      },

+      ],

Why this takes two identical args?

— Reply to this email directly, view it on GitHub, or unsubscribe. Triage notifications on the go with GitHub Mobile for iOS or Android. You are receiving this because you were mentioned.Message ID: @.***>

christianmeier avatar Jan 27 '22 17:01 christianmeier

Closing as someone has already merged this

brendanfalk avatar Sep 28 '23 23:09 brendanfalk