Commitf37ee6f

authored

fix: copy the description of the option to its alias in completion (#2269)

1 parent1fd530a commitf37ee6fCopy full SHA for f37ee6f

File tree

+28

-1

lines changed

+28

-1

lines changed

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,12 @@ export class Completion implements CompletionInstance {`
`258`	`258`	`if(!this.zshShell){`
`259`	`259`	`completions.push(dashes+key);`
`260`	`260`	`}else{`
`261`		`-constdesc=descs[key]\|\|'';`
	`261`	`+constaliasKey=this?.aliases?.[key].find(alias=>{`
	`262`	`+constdesc=descs[alias];`
	`263`	`+returntypeofdesc==='string'&&desc.length>0;`
	`264`	`+});`
	`265`	`+constdescFromAlias=aliasKey ?descs[aliasKey] :undefined;`
	`266`	`+constdesc=descs[key]??descFromAlias??'';`
`262`	`267`	`completions.push(`
`263`	`268`	`dashes+`
`264`	`269`	`${key.replace(/:/g,'\\:')}:${desc.replace('__yargsString__:','')}`

Lines changed: 22 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1055,6 +1055,28 @@ describe('Completion', () => {`
`1055`	`1055`	`r.logs.should.include('--help:Show help');`
`1056`	`1056`	`});`
`1057`	`1057`
	`1058`	`+it('completes options and aliases with the same description',()=>{`
	`1059`	`+process.env.SHELL='/bin/zsh';`
	`1060`	`+constr=checkUsage(`
	`1061`	`+()=>`
	`1062`	`+yargs(['./completion','--get-yargs-completions','-'])`
	`1063`	`+.options({`
	`1064`	`+foo:{describe:'Foo option',alias:'f',type:'string'},`
	`1065`	`+bar:{describe:'Bar option',alias:['b','B'],type:'string'},`
	`1066`	`+})`
	`1067`	`+.help(false)`
	`1068`	`+.version(false)`
	`1069`	`+.completion().argv`
	`1070`	`+);`
	`1071`	`+`
	`1072`	`+r.logs.should.have.length(5);`
	`1073`	`+r.logs.should.include('--foo:Foo option');`
	`1074`	`+r.logs.should.include('-f:Foo option');`
	`1075`	`+r.logs.should.include('--bar:Bar option');`
	`1076`	`+r.logs.should.include('-b:Bar option');`
	`1077`	`+r.logs.should.include('-B:Bar option');`
	`1078`	`+});`
	`1079`	`+`
`1058`	`1080`	`it('replaces application variable with $0 in script',()=>{`
`1059`	`1081`	`process.env.SHELL='/bin/zsh';`
`1060`	`1082`	`constr=checkUsage(()=>yargs([]).showCompletionScript(),['ndm']);`

Comments

(0)