Module: Forger

Extended by:: Core

Defined in:: lib/forger/network.rb,
lib/forger.rb,
lib/forger/s3.rb,
lib/forger/ami.rb,
lib/forger/cli.rb,
lib/forger/new.rb,
lib/forger/base.rb,
lib/forger/core.rb,
lib/forger/hook.rb,
lib/forger/wait.rb,
lib/forger/clean.rb,
lib/forger/create.rb,
lib/forger/script.rb,
lib/forger/waiter.rb,
lib/forger/cleaner.rb,
lib/forger/command.rb,
lib/forger/destroy.rb,
lib/forger/profile.rb,
lib/forger/setting.rb,
lib/forger/version.rb,
lib/forger/template.rb,
lib/forger/completer.rb,
lib/forger/autoloader.rb

Overview

Code Explanation:

There are 3 types of things to auto-complete:

1. command: the command itself
2. parameters: command parameters.
3. options: command options

Here’s an example:

mycli hello name --from me

* command: hello
* parameters: name
* option: --from

When command parameters are done processing, the remaining completion words will be options. We can tell that the command params are completed based on the method arity.

## Arity

For example, say you had a method for a CLI command with the following form:

ufo scale service count --cluster development

It’s equivalent ruby method:

scale(service, count) = has an arity of 2

So typing:

ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.

So the completion should only show options, something like this:

--noop --verbose --cluster

## Splat Arguments

When the ruby method has a splat argument, it’s arity is negative. Here are some example methods and their arities.

ship(service) = 1
scale(service, count) = 2
ships(*services) = -1
foo(example, *rest) = -2

Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.

Here are some test cases, hit TAB after typing the command:

forger completion
forger completion hello
forger completion hello name
forger completion hello name --
forger completion hello name --noop

forger completion
forger completion sub:goodbye
forger completion sub:goodbye name

## Subcommands and Thor::Group Registered Commands

Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.

* regular command: ufo ship
* subcommand: ufo docker
* Thor::Group command: ufo init

Auto-completion accounts for each of these type of commands.

Defined Under Namespace

Modules: AwsServices, Cleaner, Core, Help, Template, Waiter Classes: Ami, Autoloader, Base, CLI, Clean, Command, Completer, Create, Destroy, Dotenv, Hook, Network, New, Profile, S3, Script, Sequence, Setting, Wait

Constant Summary collapse

VERSION =

"3.0.2"

Method Summary

Methods included from Core

build_root, cloudwatch_enabled?, env, root, set_aws_profile!, settings, validate_in_project!