-
Notifications
You must be signed in to change notification settings - Fork 2
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
Common package refactor #237
Conversation
Great work! I am very happy with For What I really struggle with in this repo (previous to this rework) is to know what the public API is and I still struggle a little bit with that in the current state of
This brings me the conclusion that I think we should try to structure |- src
|- index.js (exposes the public API)
|- get-defaults.js
|- config-store.js
|- eik-config.js
|- classes
|- read-file.js
|- file-mapping.js
|- local-file-location.js
|- remote-file-location.js
|- resolved-files.js
|- errors
|- custom-error.js
|- invalid-config-error.js
|- missing-config-error.js
|- multiple-config-sources-error.js
|- no-files-matched-error.js
|- single-dest-multiple-source-error.js
|- utils
|- resolve-files.js Then there is a wild card in here: |
Thanks for great feedback 🚀 I've changed two of the package names and updated the structure for I'm not sure if it's worth creating a whole new repo just for |
PR is ready for review before merging into next, @trygve-lie. |
I think this looks great for now. Happy to have Lets do a merge to |
🎉 This PR is included in version 4.0.0-next.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This pull request introduces NPM workspaces to the repository. The list of packages are as follows:
@eik/common-classes
,@eik/common-helpers
,@eik/common-schemas
and@eik/common-validators
.What you must do
ReadFile
orEikConfig
, you must now install this from@eik/common-classes
addTrailingSlash
,removeTrailingSlash
,addLeadingSlash
,removeLeadingSlash
,isStream
,isReadableStream
,typeSlug
ortypeTitle
, you must now install this from@eik/common-helpers
schema
,validate
,assert
orValidationError
, you must now install this from@eik/common-schemas
origin
,org
,name
,type
, etc.), you must now install this from@eik/common-validators
Thoughts
I'd say before we go ahead and merge this, we should attempt a publish and try and port over some logic from other internal packages using
common
to see if it's working as expected.