Deciding on package names
See original GitHub issueRelated to release we want to improve package naming in the name of consistency!
There are basically two levels of changes.
-
We will remove “type of package” from the name. So no
provider
ormodule
in the name. That allows for freedom to make a provider a module and a module a provider, bumping its major version -
We can move to a scope type of packages. From NPM docs scoped packages is a way to group related packages and give you full freedom in naming the actual package
The two comments below shows each level of change, where we most certainly will do 1… but will need to vote on 2.
Issue Analytics
- State:
- Created 6 years ago
- Comments:52 (48 by maintainers)
Top Results From Across the Web
Naming a Package (The Java™ Tutorials > Learning the Java ...
Naming Conventions Package names are written in all lower case to avoid conflict with the names of classes or interfaces. Companies use their...
Read more >Package names - The Go Programming Language
Good package names are short and clear. They are lower case, with no under_scores or mixedCaps . They are often simple nouns, such...
Read more >Choosing a package name - DJ Bernstein's
If you have a new package, please take some time to figure out a good name for it. Use Google to see whether...
Read more >What package naming convention do you use for personal ...
A separate, distinct package naming convention for hobby projects (in my mind, at least) would serve as a good way to keep personal...
Read more >Package name guidelines - npm Docs
Package name guidelines. When choosing a name for your package, choose a name that. is unique; is descriptive; meets npm policy guidelines.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
About client/server, I do not think it needs to be reflected in naming.
function-tree
andcerebral
can both be used on client and server. The important thing is thatfunction-tree-firebase
does not crash withcerebral-firebase
. It is very clear and precise not using scopes. Where the specific package is to be used is in the docs of the package.So I want to conclude on this now, summarizing all package names for release:
cerebral cerebral-firebase cerebral-forms (cerebral-provider-forms) cerebral-http cerebral-storage cerebral-router cerebral-shortcuts cerebral-useragent
function-tree function-tree-firebase-admin
Remove type from name
cerebral cerebral-forms cerebral-useragent cerebral-router cerebral-firebase cerebral-http
function-tree function-tree-firebase-admin