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

Fix readme usage typo #216

Merged
merged 3 commits into from Sep 4, 2022
Merged

Fix readme usage typo #216

merged 3 commits into from Sep 4, 2022

Conversation

kootoopas
Copy link
Contributor

No description provided.

@timocov
Copy link
Owner

timocov commented Jul 24, 2022

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.

@kootoopas
Copy link
Contributor Author

@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.

@timocov
Copy link
Owner

timocov commented Aug 13, 2022

@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
Copy link
Owner

timocov commented Aug 13, 2022

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

Instead of executed filename ($0) so that generated index readme usage section has non-extension binary.
@kootoopas
Copy link
Contributor Author

kootoopas commented Aug 14, 2022

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.

src/bin/dts-bundle-generator.ts Outdated Show resolved Hide resolved
src/bin/dts-bundle-generator.ts Outdated Show resolved Hide resolved
@timocov timocov merged commit c46a193 into timocov:master Sep 4, 2022
@timocov timocov added this to the 6.13 milestone Sep 4, 2022
@timocov
Copy link
Owner

timocov commented Sep 4, 2022

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

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

Successfully merging this pull request may close these issues.

None yet

2 participants