dts-bundle-generator icon indicating copy to clipboard operation
dts-bundle-generator copied to clipboard

Fix readme usage typo

Open 2007heaven opened this issue 3 years ago • 2 comments

2007heaven avatar Jul 23 '22 18:07 2007heaven

Hi @kootoopas,

Thanks for contributing to the project.

This codeblock contains a generated by running a command dts-bundle-generator --help command. Do you know if it possible to fix it there in the first place? So the next time we'll add or change a command we won't discard this change accidentally.

timocov avatar Jul 24 '22 12:07 timocov

@timocov Hey,

Help option output is valid on v6.12.0 when run from command line. (npx dts-bundle-generator --help)

Extension exists solely on readme.

2007heaven avatar Jul 24 '22 17:07 2007heaven

@kootoopas it looks like it depends on the system where you're running the command. On windows it has the extension:

$ npx dts-bundle-generator --help
Usage: dts-bundle-generator.js [options] <file(s)>

Probably we need to adjust yargs usage command to address this. But I'm not too sure how it should be though.

timocov avatar Aug 13 '22 11:08 timocov

Probably we can just remove that line from readme and leave yargs options as is (since they are accurate).

timocov avatar Aug 13 '22 11:08 timocov

Given that the command can execute without the extension on windows, using the package name does produce constant output across OSs: c9037b7

If npx & the node_modules/.bin link use package name and not specified executable filename (binary in package.json) then it should be accurate.

2007heaven avatar Aug 14 '22 22:08 2007heaven

Thanks @kootoopas! I think changes in the source code weren't necessary to I reverted them and left only changes in readme file.

timocov avatar Sep 04 '22 11:09 timocov