Add helpInformation to typings by jharrilim · Pull Request #992 · tj/commander.js

jharrilim · 2019-07-07T17:40:38Z

Missing type for Commander.prototype.helpInformation:

Lines 1085 to 1129 in 1c1ffca

    
           Command.prototype.helpInformation = function() { 
        
             var desc = []; 
        
             if (this._description) { 
        
               desc = [ 
        
                 this._description, 
        
                 '' 
        
               ]; 
        
               var argsDescription = this._argsDescription; 
        
               if (argsDescription && this._args.length) { 
        
                 var width = this.padWidth(); 
        
                 desc.push('Arguments:'); 
        
                 desc.push(''); 
        
                 this._args.forEach(function(arg) { 
        
                   desc.push('  ' + pad(arg.name, width) + '  ' + argsDescription[arg.name]); 
        
                 }); 
        
                 desc.push(''); 
        
               } 
        
             } 
        
             var cmdName = this._name; 
        
             if (this._alias) { 
        
               cmdName = cmdName + '|' + this._alias; 
        
             } 
        
             var usage = [ 
        
               'Usage: ' + cmdName + ' ' + this.usage(), 
        
               '' 
        
             ]; 
        
             var cmds = []; 
        
             var commandHelp = this.commandHelp(); 
        
             if (commandHelp) cmds = [commandHelp]; 
        
             var options = [ 
        
               'Options:', 
        
               '' + this.optionHelp().replace(/^/gm, '  '), 
        
               '' 
        
             ]; 
        
             return usage 
        
               .concat(desc) 
        
               .concat(options) 
        
               .concat(cmds) 
        
               .join('\n'); 
        
           };

shadowspawn · 2019-07-07T23:30:41Z

This is as intended since helpInformation is marked in the JSDoc with @api private. We do not document the private api calls in the TypeScript.

jharrilim · 2019-07-14T15:58:00Z

Ok makes sense. I was thinking maybe it should be declared as public so that I may get the string and not always write to stdout (perhaps another stream), but maybe I am designing my program wrong.

Add helpInformation to typings

daa36bc

shadowspawn added the waiting for feedback label Jul 11, 2019

jharrilim closed this Jul 14, 2019

shadowspawn removed the waiting for feedback label Jan 9, 2020

shadowspawn mentioned this pull request Jan 24, 2020

Could have error() output to stderr? #997

Closed

shadowspawn mentioned this pull request Feb 6, 2020

Make .helpInformation public and update help sections in README #1169

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add helpInformation to typings#992

Add helpInformation to typings#992
jharrilim wants to merge 1 commit intotj:masterfrom
jharrilim:master

jharrilim commented Jul 7, 2019

Uh oh!

shadowspawn commented Jul 7, 2019

Uh oh!

jharrilim commented Jul 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Command.prototype.helpInformation = function() {
	var desc = [];
	if (this._description) {
	desc = [
	this._description,
	''
	];

	var argsDescription = this._argsDescription;
	if (argsDescription && this._args.length) {
	var width = this.padWidth();
	desc.push('Arguments:');
	desc.push('');
	this._args.forEach(function(arg) {
	desc.push(' ' + pad(arg.name, width) + ' ' + argsDescription[arg.name]);
	});
	desc.push('');
	}
	}

	var cmdName = this._name;
	if (this._alias) {
	cmdName = cmdName + '\|' + this._alias;
	}
	var usage = [
	'Usage: ' + cmdName + ' ' + this.usage(),
	''
	];

	var cmds = [];
	var commandHelp = this.commandHelp();
	if (commandHelp) cmds = [commandHelp];

	var options = [
	'Options:',
	'' + this.optionHelp().replace(/^/gm, ' '),
	''
	];

	return usage
	.concat(desc)
	.concat(options)
	.concat(cmds)
	.join('\n');
	};

Uh oh!

Conversation

jharrilim commented Jul 7, 2019

Uh oh!

shadowspawn commented Jul 7, 2019

Uh oh!

jharrilim commented Jul 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants