search

peardeck / peardeck-uikit

Pear Deck UI Kit
https://peardeck.github.io/peardeck-uikit
Other
0 stars 0 forks source link

Package naming conventions #6

Open joekrill opened 5 years ago

joekrill commented 5 years ago

It looks like we're going to have at least 2 "types" of packages within the repo: "utility" packages mainly used for internal use (i.e. eslint-config, build-tools) and actual UI packages that expose components for external consumption (i.e. core, icons). I'm not sure where storybook falls here, it's mostly internal but could eventually fall into a 3rd category if we publish it somewhere for reference.

So right now we end up with something like this:

.
|-- packages
|   |-- build-tools
|   |-- core
|   |-- eslint-config
|   |-- icons
|   `-- storybook

Should we consider prefixing either all, or certain types of these packages? For example, rename core and icons to ui-core and ui-icons (or some similar prefix)? 

.
|-- packages
|   |-- build-tools
|   |-- eslint-config
|   |-- storybook
|   |-- ui-core
|   `-- ui-icons
laurapear commented 5 years ago

I like that idea. Another option (if this is a possibility) would be to put UI and utilities in their respective subfolders.