V1

[crookse]

Closes #11
Closes #5

Notes

• Introduces v1
• Code is exercised via integration tests (there aren't any unit tests). Should we add unit tests or do the integration tests suffice so far?
• New readme to match Drash: https://github.com/drashland/line/tree/v1

How to create a CLI

• See https://github.com/drashland/line/blob/5-main-command/tests/integration/file_manager/cli.ts
• See https://github.com/drashland/line/blob/5-main-command/tests/integration/file_manager_with_everything/cli.ts
• See https://github.com/drashland/line/blob/5-main-command/tests/integration/file_manager_with_options/cli.ts
• See https://github.com/drashland/line/blob/5-main-command/tests/integration/file_manager_with_too_many_options/cli.ts

There is something that is bothering me. Right now, to describe an argument, you have to provide an arguments object. For example:

class MyCommand extends Line.MainCommand {
  public signature = "line [arg]";

+  public arguments = {
+    "arg": "Some description.",
+  };

  public async handle(): Promise<void> {
    console.log("sup");
  }
}

const cli = new Line.Cli({
  name: "My Cool CLI",
  description: "My cool description",
  version: "v1.0.0",
  command: MyCommand,
});

cli.run();

And when you run it, it outputs the following:

My Cool CLI - My cool description

USAGE

    line [option]
    line [arg: arg]

ARGUMENTS

    arg
+        Some description.

OPTIONS

    -h, --help
        Show this menu.
    -v, --version
        Show this CLI's version.

I feel like arguments is a weird property name. Maybe argument_descriptions? I wouldn't say descriptions, because the options property also contains descriptions (the value is the description of the option(s)), so it's kind of confusing in that regard. Thoughts though?

TODO

• Change arguments description object?
• Documentation

[ebebbington]

Beautiful