Typescript library starter
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.vscode feat: revamp whole starter and make it up to date (#46) Jun 13, 2018
config
scripts feat(scripts): provide migration script from v3 to v4 Jul 30, 2018
src style: apply new lint rules Aug 27, 2018
.editorconfig chore: bump deps and update config types (#58) Jun 27, 2018
.gitignore
.npmignore fix(build): don't compile test files Jul 23, 2018
.npmrc fix: always set strict versions via npm or yarn Mar 31, 2017
.prettierignore build: ignore generated build stuff Aug 14, 2018
.travis.yml feat: revamp whole starter and make it up to date (#46) Jun 13, 2018
.yarnrc
CHANGELOG.md chore(release): 4.0.0 Aug 14, 2018
LICENSE.md
README.md feat(build): ditch webpack and use rollup for bundling Jul 30, 2018
package.json
tsconfig.json fix(ts): remove test files from exclude field Aug 2, 2018
tslint.json feat(tslint): revamp tslint rules Aug 27, 2018
yarn.lock

README.md

Typescript lib starter

Greenkeeper badge

Build Status NPM version Downloads Standard Version styled with prettier Conventional Commits

This npm library starter:

  • creates package for both Node and Browser
  • build will creates 4 standard "package" formats:
    • umd πŸ‘‰ UMD bundle for Node and Browser

      main field in package.json

    • esm5 πŸ‘‰ transpiled files to ES5 + es2015 modules for tree shaking

      module field in package.json

    • esm2015 πŸ‘‰ raw javascript files transpiled from typescript to latest ES standard ( es2018 )

      es2015 field in package.json

      this 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
    • types field 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 4 steps !

  1. git clone https://github.com/Hotell/typescript-lib-starter <your-libary-folder-name> && cd $_

  2. rm -rf .git && git init

  3. in package.json reset following fields:

{
- "name": "@next-gen/typescript-lib-starter",
+ "name": "{yourLibraryPackageName}",
- "version": "1.7.0",
+ "version": "1.0.0",
- "description": "TypeScript library setup for multiple compilation targets using tsc and webpack",
+ "description": "What is your library all about...",
- "author": "Martin Hochel",
+ "author": "{yourName}",
- "license": "MIT",
+ "license": "{yourLicense}",
  "repository": {
    "type": "git",
-   "url": "https://www.github.com/Hotell/typescript-lib-starter"
+   "url": "https://www.github.com/{yourAccountName}/{yourLibraryPackageName}"
  }
}
  1. Install all dependencies yarn install

Happy coding ! πŸ––

Consumption of published library:

  1. install it πŸ€–
yarn add my-new-library
# OR
npm install my-new-library
  1. 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 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 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="app"></div>
  </body>
</html>

Publish your library

NOTE:

you have to create npm account and register token on your machine πŸ‘‰ npm adduser

If you are using scope ( you definitely should πŸ‘Œ) don't forget to --scope

Execute yarn release which will handle following tasks:

  • bump package version and git tag
  • update/(create if it doesn't exist) CHANGELOG.md
  • push to github master branch + push tags
  • publish build packages to npm

NOTE:

all package files are gonna be within /dist folder from where npm publish will be executed

releases are handled by awesome standard-version

Initial Release (without bumping package.json version):

yarn release --first-release

Pre-release

  • To get from 1.1.2 to 1.1.2-0:

yarn release --prerelease

  • Alpha: To get from 1.1.2 to 1.1.2-alpha.0:

yarn release --prerelease alpha

  • Beta: To get from 1.1.2 to 1.1.2-beta.0:

yarn release --prerelease beta

Dry run mode

See what commands would be run, without committing to git or updating files

yarn release --dry-run

Check what files are gonna be published to npm

  • cd dist && yarn pack OR yarn release:preflight which will create a tarball with everything that would get published to NPM

Check size of your published NPM bundle

yarn size

Format and fix lint errors

yarn ts:style:fix

Generate documentation

yarn docs

Commit ( via commitizen )

  • this is preferred way how to create conventional-changelog valid commits
  • if you prefer your custom tool we provide a commit hook linter which will error out, it you provide invalid commit message
  • if you are in rush and just wanna skip commit message validation just prefix your message with WIP: something done ( if you do this please squash your work when you're done with proper commit message so standard-version can create Changelog and bump version of your library appropriately )

yarn commit - will invoke commitizen CLI

Troubleshooting

dynamic import()

This starter uses latest TypeScript >=2.9 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