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

aliases aren't CLI firendly #23

Closed
bnb opened this issue Feb 4, 2022 · 8 comments
Closed

aliases aren't CLI firendly #23

bnb opened this issue Feb 4, 2022 · 8 comments

Comments

@bnb
Copy link

bnb commented Feb 4, 2022

I'm currently working on a CLI that's building off of this work, and I've found that the aliases are relatively unfriendly to CLIs. I've never seen a Node.js native command line tool that uses underscores, and am finding myself having to alias them which provides a less cohesive experience than I'd like.

I'd like to request that more CLI-friendly aliasing be introduced for the lts variants.

@wesleytodd
Copy link
Member

Those aliases were defined by the package maintenance working group, not this tool. I do agree that the aliases keys are not super friendly, maybe we could change how they are defined in the spec and then release v2?

@bnb
Copy link
Author

bnb commented Feb 7, 2022

+1 I'm happy to change how they're defined in the spec and release an update.

@shadowspawn
Copy link

Are you talking about changing the node namespace aliases in https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md ?

They are being used in package-support.json files and in code outside the node organisation (e.g. https://github.com/tj/n/blob/392f9ab7d8434f9a73386a6cea055fafb7b37f86/bin/n#L305). Changing the node namespace aliases for a little more CLI friendliness seems expensive.

Perhaps you are weighing all of that, or perhaps it is some other definition you are talking about. I wanted to clarify because it seemed very casually discussed. 🤭

@bnb
Copy link
Author

bnb commented Feb 7, 2022

They are being used in package-support.json files and in code outside the node organisation (e.g. https://github.com/tj/n/blob/392f9ab7d8434f9a73386a6cea055fafb7b37f86/bin/n#L305). Changing the node namespace aliases for a little more CLI friendliness seems expensive.

I am talking about those. I'll be frank, I don't think that they're a good API and should not be used in end-user APIs that module maintainers are presented, as this module does. If changing them is not something that is possible, I'll strongly recommend we abandon using them.

@dominykas
Copy link
Member

We should add this to the PM WG meeting agenda.

@wesleytodd wesleytodd mentioned this issue Jun 13, 2022
@wesleytodd
Copy link
Member

Do we still think this is an issue? I can probably make the next PMWG meeting on the 24th if we want to discuss?

@bnb
Copy link
Author

bnb commented Oct 25, 2023

IMO yes. Having non-CLI-friendly names is borderline a non-starter.

@wesleytodd
Copy link
Member

Going to close this and point to your PR in the PMWG: nodejs/package-maintenance#581

Once that is resolved I can update the package and release a new major with the new aliases.

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

No branches or pull requests

4 participants