TypeScript lib starter
Enjoying/Using TypeScript lib starter ?
đŞ â
⨠Features
- creates package for both Node and Browser
- build will creates 4 standard "package" formats:
-
umdđ UMD bundle for Node and Browsermainfield in package.json -
esm5đ transpiled files to ES5 + es2015 modules for tree shakingmodulefield in package.json -
esm2015đ raw javascript files transpiled from typescript to latest ES standard ( es2018 )es2015field in package.jsonthis is useful if you wanna transpile everything or just wanna ship untranspiled esNext code for evergreen browsers)
-
fesmđ experimental bundle type introduced by Angular team (TL;DR: it's an es2015 flattened bundle, like UMD but with latest ECMAscript and JS modules)
-
- type definitions are automatically generated and shipped with your package
-
typesfield in package.json
-
-
sideEffectsđ support proper tree-shaking for whole library ( Webpack >= 4). Turn this off or adjust as needed if your modules are not pure!
âď¸ start coding in 2 steps
-
git clone https://github.com/jincdream/typescript-lib-starter <your-libary-folder-name> && cd $_ -
yarn
Yes that's it. Happy coding !
đ Consumption of published library:
- install it
đ¤
yarn add my-new-library
# OR
npm install my-new-library- use it
đŞ
Webpack
NOTE:
Don't forget to turn off ES modules transpilation to enable tree-shaking!
- babel:
{"modules": false}- typescript:
{"module": "esnext"}
// main.ts or main.js
import { Greeter } from 'my-new-library'
const mountPoint = document.getElementById('app')
const App = () => {
const greeter = new Greeter('Stranger')
return `<h1>${greeter.greet()}</h1>`
}
const render = (Root: Function, where: HTMLElement) => {
where.innerHTML = Root()
}
render(App, mountPoint)<!-- index.htm -->
<html>
<head>
<script src="bundle.js" async></script>
</head>
<body>
<div id="app"></div>
</body>
</html>UMD/ES2015 module aware browsers (no bundler)
<html>
<head>
<script type="module">
import { Greeter } from './node_modules/my-lib/esm2015/index.js'
const mountPoint = document.querySelector('#root')
const App = () => {
const greeter = new Greeter('Stranger')
return `<h1>${greeter.greet()}</h1>`
}
const render = (Root, where) => {
where.innerHTML = Root()
}
render(App, mountPoint)
</script>
<script
nomodule
src="node_modules/my-lib/bundles/my-new-library.umd.min.js"
></script>
<script nomodule async>
var Greeter = MyLib.Greeter
var mountPoint = document.querySelector('#root')
var App = function() {
var greeter = new Greeter('Stranger')
return '<h1>' + greeter.greet() + '</h1>'
}
var render = function(Root, where) {
where.innerHTML = Root()
}
render(App, mountPoint)
</script>
</head>
<body>
<div id="root"></div>
</body>
</html>
đ¨âđ§ Technical overview
đ
Style guides
đ Publishing
đľď¸ââď¸ Troubleshooting
dynamic import()
This starter uses latest TypeScript >=3.x which has support for lazy loading chunks/modules via import() and also definition acquisition via import('../path-to-module').TypeFoo
Before TS 2.9, it wasn't possible to properly generate ambient definitions if you used dynamic import(). This works now as expected without any hacks
Before TS 2.9
Please note that if you wanna use that feature, compiler will complain because declaration generation is turned on, and currently TS can't handle type generation with types that will be loaded in the future ( lazily )
How to solve this:
- turn of type checking and don't generate types for that lazy import:
import('./components/button') as any- or you can use this temporary workaround
đĽ License
MIT as always
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)