sade

Patches

• Handle equal-length aliases for sub-commands: 6a08885 Previously, a subcommand only worked correctly if its alias had fewer segments:

  sade('git')
    .command('remote add <name> <url>')
    .alias('ra', 'remote new')
    // ...
  
  // BEFORE: Only `ra` worked
  // AFTER: Both `ra` and `remote new` work
  

• (perf) Faster command parsing: 6a08885 Fewer for-loops to determine command alises.

Chores

• (CI) Move CI to GitHub Actions: 66c0912, a35149b
• (pkg): Ensure valid author.url format (#41): cf24e4f Thank you @marvinhagemeister

Patches

• Prevent prog.parse() from mutating the input array (often process.argv) (#36): 9d3fdca

  While it's strongly recommended not to access process.argv directly with action handlers, Sade no longer manipulates its values. After all, why use a CLI framework that parses and formats process.argv for you if you're reaching past it for the same values?

Patches

• Fixed regression from 1.7.1 which didn't parse opts.default commands' arguments correctly: 07645f8 Also included tests to prevent future regressions.

Patches

• Allows option flags to come before the command name: 4ccffe0

  Important: As with any CLI program, these options must come in pairs!<br>Otherwise your command name may be interpreted as the flag's value.<br><br>This is not a new limitation.<br>Previously, Sade ignored all input flags that were defined before the command.

  $ doorman greet Luke --excited 
  #=> ✓ hello Luke!
  
  $ doorman --excited greet Luke 
  #=> ✘ Unknown command: Luke
  
  $ doorman --type Howdy greet Luke
  #=> ✓ Howdy Luke!
  

  This was done so that Sade programs could be aliased/saved with common options.<br>For example, you may want to save something like ley to a custom script:

  // package.json
  {
    "scripts": {
      "migrate": "ley -r dotenv/config"
    }
  }
  

  As of this release, this is now possible! :tada:

  Developers can successfully run this script like so: yarn migrate up<br>Again, only as of this patch release, the -r dotenv/config option will still be applied.

Features

• Add support for "command aliases" (#26, #34): fb1edcc Read Command Aliases for docs and examples

Features

• Add support for "single-command mode" (#2, #25): 00d355b Read Single Command Mode for docs and example

Patches

• Rename internal name key to bin instead (#24): 65483ff

Patches

• Render "Invalid command: {input}"error message for unknown command(s): c7c7b58 This was always the intention, but regressed in https://github.com/lukeed/sade/commit/4b3a1def46eccef7f0a3ef9fda6dea809a7e68ae – oops

Chores

• Add extensive integration/usage test suite: 885d9ad

Features

• Print custom or default error message when opts.unknown finds invalid flags: 922b7e4

  Example: Custom Output

  // demo program
  
  sade('sirv')
    .command('start [dir]')
    .parse(process.argv, {
      unknown: arg => `Custom error message: ${arg}`
    });
  

  # Pass invalid "--foobar" flag
  $ sirv start --foobar
  

    ERROR
      Custom error message: --foobar
  
    Run `$ sirv --help` for more info.
  

  Example: Default Output

  // demo program
  
  sade('sirv')
    .command('start [dir]')
    .parse(process.argv, {
      // Pass function, but don't do anything
      // ~> means we just want validation
      unknown: () => false
    });
  

  # Pass invalid "--foobar" flag
  $ sirv start --foobar
  

    ERROR
      Parsed unknown option flag(s)!
  
    Run `$ sirv --help` for more info.
  

Patches

• Prevent runtime error when opts.unknown is defined: 8f0b44a

Patches

• Replaced pad-right dependency with native String.repeat method. Did not make sense to include 2 deps for a single, non-perf-critical utility function.

Patches

• Fixed an issue where multiple optional arguments were assigned incorrect values: 8904ddb Silly mistake; was using pop() instead of shift(), oops. 🙃

• Added tests to lock in the fix & prevent regressions: 9641aac

Minor Changes

• NEW: Added lazy option to parse() method, deferring handler execution: 4556ff2, 762aab8

Patches

• Specify Node environment for README's demo usage (thanks @vutran): 244d447
• Prevent missing command descriptions from throwing within --help output: d552429
• Add missing utils.help tests: 6edd1f7

Patches

• FIX: Allow flag names to contain hyphens (#9, #10): 6796849, c764aa2

  Thanks to @mrwest808 for jumping on this! 🙌

• Added util.parse tests: ccb9269, 991558d

• Added util.sentences tests: 98079db

• Updated README for hyphenated flag change: a133c1f, 54ceebc

Patches

• Fixes offset pointer after assuming/implying the default command: b787be1

  Thanks to @developit for catching this & sending a fix, too! 🎉

Minor Changes

Adds support for git-like subcommands! :tada: : 4b3a1de, 33437b5

const prog = sade('git');

// Not necessary for subcommands to work, but it's here anyway!
prog
  .command('remote')
  .describe('Manage set of tracked repositories')
  .action(opts => {
    console.log('~> Print current remotes...');
  });

prog
  .command('remote add <name> <url>', 'Demo...')
  .action((name, url, opts) => {
    console.log(`~> Adding a new remote (${name}) to ${url}`);
  });

prog
  .command('remote rename <old> <new>', 'Demo...')
  .action((old, nxt, opts) => {
    console.log(`~> Renaming from ${old} to ${nxt}~!`);
  });

Minor Changes

• Display error & exit if <required> arguments are unmet (#4): 9f0f053
• Pass [optional] arguments thru to the aciton() handler (#5): 228eb7c
  • Send undefined to parameter if no value
  • Requires that the <required> args be defined before <optional> args
  • Preserves sending all flags (opts) as the last parameter

Patches

• Updated README with documentation & examples to reflect changes: 759a945, 112349a

Minor Changes

• No longer sets 1st command definition as the default command: da418cd, 8fe618a
• Change prog.parse() arity; adds opts param: e51a7c4, 0d61d48
• Reprioritize non-specific command handling: cab109c 1. Error & exit early if invalid command 2. Apply default command if nothing else 3. Allow help & version output to run if still barren 4. Error & exit if still no command object, before exec

Patches

• Only show "Available Commands" section if valued: 6416091
• Don’t throw Error if assuming default command with flags: da418cd
• Add prettier/formatted ERROR output via utils.error: cab109c