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 repo and npm name mistmatch. #442

Open
Ethan-Arrowood opened this issue Jun 27, 2023 · 2 comments
Open

Fix repo and npm name mistmatch. #442

Ethan-Arrowood opened this issue Jun 27, 2023 · 2 comments

Comments

@Ethan-Arrowood
Copy link

It is confusing that the npm package is titled differently from the source code repo. Furthermore, since you are not publishing the CLI under the @microsoft scope, a bad-actor could publish something bad under the currently available tfs-cli name. Similarly confused users may accidentally install tfs-cli instead of tfx-cli, and run into major issues.

Since the documentation throughout this references tfx-cli, I recommend renaming the repo to tfs-cli. GitHub will handle redirects automatically.

If that is not possible for whatever reason, you should at least publish something to the tfs-cli package on npm that maybe just prints a message like "This package name is incorrect. Install tfx-cli instead". Furthermore, since the CLI is invoked as tfx you may want to consider publishing to that name too (but you'd need to reach out to its current package author to get access to the name). This matches what TypeScript does with the tsc pacakge. Since that is how you invoke the typescript command line, sometimes users will npm i -g tsc instead of npm i -g typescript.

Also, all of this is improved if you use a scope like @microsoft or @azure-devops. Just the scope alone will provide an improved layer of trust to this tool.

@Ethan-Arrowood
Copy link
Author

And to top it off the npm package has no visual readme or anything. Its very distrustful. Screenshot 2023-06-27 at 11 02 49

@max-zaytsev
Copy link

Hi @Ethan-Arrowood thanks for reporting! Currently, we're working on higher-priority issues, but we'll come back to this one soon

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

No branches or pull requests

3 participants