jurassiscripts / velociraptor

The npm-style script runner for Deno

Home Page:https://velociraptor.run

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Support description for composite scripts

paambaati opened this issue · comments

commented

Take this script.yaml for example –

scripts:
  onething:
    desc: Do a simple thing
    cmd: echo "simple"
  manythings:
    - desc: Do some thing first
      cmd: echo "thing number 1"
    - desc: Do another thing next
      cmd: echo "thing number 2"

vr outputs this –

$ vr

  🦖 Available scripts

    • onething
    Do a simple thing
    $ echo "simple"

    • manythings
    $ echo "thing number 1", echo "thing number 2"

You'll notice that composite scripts don't have a description. I understand we can't have a top-level field for description because composite scripts are an array. Perhaps we could just print the descriptions of each script? Something like this –

$ vr

  🦖 Available scripts

    • onething
    Do a simple thing
    $ echo "simple"

    • manythings
    Do some thing first
    Do another thing next
    $ echo "thing number 1", echo "thing number 2"

@paambaati absolutely! Would you like to open a PR for this? 🙂

Thank you so much @paambaati, your changes are live in 1.1.0! 😊 🎉