Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v7.0.0 coming soon #1386

Closed
shadowspawn opened this issue Oct 25, 2020 · 11 comments
Closed

v7.0.0 coming soon #1386

shadowspawn opened this issue Oct 25, 2020 · 11 comments
Milestone

Comments

@shadowspawn
Copy link
Collaborator

shadowspawn commented Oct 25, 2020

Release Notes:

README: https://github.com/tj/commander.js/blob/release/7.x/Readme.md

You can try the prerelease with:

npm install commander@next

Open an issue or add a comment here for any problems you encounter.

@joshuapinter
Copy link

Nice work @shadowspawn to keep this repo going! 👍 🙏

@shadowspawn
Copy link
Collaborator Author

I'll do another prerelease soon to add #1387

@shadowspawn
Copy link
Collaborator Author

Prerelease v7.0.0-1 has a couple of new features, and a number of minor improvements. Release notes:

@shadowspawn
Copy link
Collaborator Author

Work underway to change the default behaviour so options are not stored as properties on the command: #1409

@shadowspawn
Copy link
Collaborator Author

#1409 has landed in v7.0.0-2 and includes multiple breaking changes! See the Release Notes and let us know if there are issues or the release notes could be improved.

@shadowspawn shadowspawn changed the title v7.0.0 pre-release available v7.0.0-2 pre-release available Dec 14, 2020
@shadowspawn
Copy link
Collaborator Author

shadowspawn commented Jan 9, 2021

The latest code for upcoming Commander 7 is now on the develop branch. There will not be another prerelease to npm, but you can try the latest code by installing from GitHub:

npm install tj/commander.js#develop

The main changes from 7.0.0-2 are:

For changes see:

@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Jan 10, 2021
@shadowspawn shadowspawn changed the title v7.0.0-2 pre-release available v7.0.0 coming soon Jan 10, 2021
@cravler
Copy link
Contributor

cravler commented Jan 12, 2021

Hi @shadowspawn,

When you plan to make a release?

@shadowspawn
Copy link
Collaborator Author

Aiming to release this Friday or over the weekend.

@shadowspawn
Copy link
Collaborator Author

7.0.0 has been released. Thanks to all who have contributed.

@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Jan 15, 2021
@shadowspawn shadowspawn unpinned this issue Jan 15, 2021
@cravler
Copy link
Contributor

cravler commented Jan 18, 2021

Hi @shadowspawn,

I wrote basic help extensions for commander.js@7, maybe will be useful for someone:

x-commander

const program = require('x-commander');

program.configureHelp({
  labels: {
    usage: '>>> Usage:\n',
    description: '>>> Description:\n',
    arguments: '>>> Arguments:\n',
    options: '>>> Options:\n',
    commands: '>>> Commands:\n',
  },
  styles: {
    label: str => '\x1b[33m' + str + '\x1b[0m', // yellow
    term: str => '\x1b[32m' + str + '\x1b[0m', // green
    description: str => '\x1b[36m' + str + '\x1b[0m', // cyan
  },
  formatParams: {
    newLineUsage: true,
    baseIndentWidth: 2,
    itemIndentWidth: 4,
  },
  formatHelp(cmd, helper) {
    return ['', helper.renderHelpTemplate(cmd, helper), ''].join('\n');
  }
});

program
  .command('test <cmd> [env] [val]')
  .description('long description '.repeat(100), {
    cmd: 'cmd description '.repeat(50),
    env: 'env description '.repeat(50),
    val: 'val description '.repeat(50)
  })
  .action((cmd, env, options) => {});

program.parse(process.argv);

@shadowspawn
Copy link
Collaborator Author

Nice. I like the styles especially.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants