-
Notifications
You must be signed in to change notification settings - Fork 1
Consolidate JS SDK packages #1
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
Conversation
…urce code, tests, CI, docs)
aec23b7
to
e30219f
Compare
e30219f
to
07e52d6
Compare
c321755
to
40f7279
Compare
40f7279
to
9c34929
Compare
…dd dependabot, update README.md
e271055
to
754307e
Compare
fd27332
to
5318552
Compare
5318552
to
801be47
Compare
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just 2 small suggestions, but overall, it looks good to me!
README.md
Outdated
@@ -1,38 +1,244 @@ | |||
# ConfigCat Common library for JavaScript | |||
# ConfigCat SDK for JavaScript | |||
https://configcat.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd remove this link from the top of the README (it'll be in the About section of the repo anyway)
README.md
Outdated
ConfigCat SDK for JavaScript provides easy integration for your application to ConfigCat. | ||
|
||
ConfigCat Common library for JavaScript is a shared package that provides the common ConfigCat SDK logic for [ConfigCat SDK for Node.js](https://github.com/configcat/node-sdk) and [ConfigCat SDK for JavaScript](https://github.com/configcat/js-sdk). | ||
## About |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd move this to the end of the readme under an About ConfigCat
section. IMO this part of the README should be about the repo's content.
|
Describe the purpose of your pull request
The initial state of this repo is a copy of https://github.com/configcat/common-js. This PR merges the following repos containing platform-specific JS SDKs into that code base:
The goal is to end up with a single NPM package that can be used as a drop-in replacement for the listed packages.
This will allow us to eliminate a lot of redundancy (especially w.r.t. build configuration and documentation), improve development velocity and, thus, significantly reduce maintenance costs. As a side effect, the unified package will also provide a better support for SSR applications.
Additional benefits and improvements:
axios
dependency as it is not needed anymore. The platform-specific targeting is already handled via themain
/browser
andexports
package.json fields.common-js
have only been run on Node.js so far. Now we can run them on all the target platforms, which increases reliability.tslib
dependency, which in turn can also reduce application bundle sizes.Requirement checklist (only if applicable)