actions/ts-ci
2
0
Fork 0
mirror of https://github.com/garronej/ts-ci.git synced 2025-11-30 21:43:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Joseph Garrone 2021-05-22 23:42:58 +02:00 • committed by GitHub
parent e4d1a3f222
commit 020b790142
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -39,16 +39,18 @@ Besides, good stuff that comes with using this template:
Reasons why you might want to use TS_CI over TSDX
- TSDX doesn't help you with publishing on NPM, creating GitHub releases and maintaining a CHANGELOG.md.
- TSDX bundle your module into a single minified `index.js` which is not what you want if you publish a module for node
- TSDX bundle your module into a single minified `index.js` which is not what you want if your module is for node.
It's not even what you want if you are targeting the web because it will prevent users from cherry-picking what
they want to import from your library. Imagine how it would impact the bundle size if `material-ui` didn't let you cherry
pick what component of the lib you want to import.
ts_ci creates bundle.js and ESM distribution for you, but it's not the default way.
That said, ts_ci do create bundle.js and ESM distribution as well.
Reasons why you might want to use TSDX
- TS_CI doesn't set up a test framework for you.
- You want to use babel plugin like [https://github.com/formium/tsdx#advanced-babel-plugin-dev-expressions](https://github.com/formium/tsdx#advanced-babel-plugin-dev-expressions)
# Examples of project using this template
- [keycloakify](https://github.com/garronej/keycloakify)