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

Shorten the package name #7

Open
tomalec opened this issue May 26, 2022 · 0 comments
Open

Shorten the package name #7

tomalec opened this issue May 26, 2022 · 0 comments
Labels
priority: low The issue/PR is low priority—not many people are affected or there’s a workaround, etc. type: enhancement The issue is a request for an enhancement.

Comments

@tomalec
Copy link
Member

tomalec commented May 26, 2022

This is kind of a follow up from #6 (comment)

User story

It's rather a cosmetic 💅 problem, but I think it'd be nice to settle on good names, as later it could be hard to ever them.

As a user of Grow tools, I'd like to write less code/configs/ etc. and avoid repetition.
Also when it comes to the package name.

Is your feature request related to a problem?

Currently, we use a format of woocommerce-grow-{package-name} for our tools here. (As it was introduced in the very first package)

It has a set of benefits:

  • states the full product name, probably good for recognition
  • states the team name, so it's distinct from Woo-wide tools
  • does not use shorthand which makes it kind of disambiguous, and readable out loud 1:1 in plain English

But I have a doubt, whether it's not too long. Especially, when the package name adds up, and the name is used not only in package.json's devDependencies, but also in some other files, like configs, like:

Describe the solution you'd like

I see a few ways to go:

  1. Don't make any hard rule and decide ad hoc for every case separately, the package name, the config references, the binaries' names, element names etc.
  2. Make woocommerce-grow-{package-name} for every package reference
  3. Use something shorter, like woo-grow-{package-name}
    1. Use it everywhere
    2. Use a long name for packages, a short name for any references

For woo-grow- I could list a few benefits

  • shorter
  • is well-coined shorthand
  • Does not necessarily reference the WooCommerce product, but rather the Woo division. And we may have some tools not just for WooCommerce per see, but for some other needs. I cannot think of a good example now - maybe something like woo-grow-ping-porter CLI/slack command. Also Grow is not a part of WooCommerce plugin, but rather Woo as an organization.
  • States a clear distinction between those packages and woocommerce packages. - "Is woocommerce-grow-up a WooCommerce's "grow-up" package, or WooCommerce Grow's up package?"

Unknowns

Out of bounds/rabbit holes

@tomalec tomalec added priority: low The issue/PR is low priority—not many people are affected or there’s a workaround, etc. type: enhancement The issue is a request for an enhancement. labels May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low The issue/PR is low priority—not many people are affected or there’s a workaround, etc. type: enhancement The issue is a request for an enhancement.
Projects
None yet
Development

No branches or pull requests

1 participant