search

infinitered / gluegun

A delightful toolkit for building TypeScript-powered command-line apps.
MIT License
2.93k stars 147 forks source link

Add the `description` field in the toolbox doc to describe the function in the help listing #790

Open luizbp opened 3 months ago

luizbp commented 3 months ago

I verified through a test that if you pass the description object when creating a new command, it appears in the help command listing, it would be nice to include this in the documentation!

Example: 

module.exports = {
  name: 'teste',
  alias: ['t'],
  description: 'teste', // HERE
  run: async (toolbox: GluegunToolbox) => {

  }
}
jamonholmgren commented 3 months ago

Want to do the PR @luizbp ? Good call