Skip to content

ryancat/create-typescript-library

Repository files navigation

create-typescript-library

Build Status codecov

This is a nodejs command line util that will setup the basic structure for my (and your) next typescript library.

How it works?

Simply run npx create-typescript-library in an empty directory where you want to create your typescript library. If you are using yarn, run yarn exec create-typescript-library.

What it does

create-typescript-library will run an interactive prompt to gather information from you, and generate a basic working typescript library for you. Some examples include:

  • Use typescript compiler (tsc) to compile your library:
    • to commonjs code to consume
    • to es2015 code to consume
  • Use webpack version 4 to bundle your library:
    • to UMD module for others
  • Setup npm/yarn scripts for easy build
    • dev to compile or bundle code
    • dev:watch to watch the file changes (by nodemon) and run the dev script
    • build to generate minimized code for publishing
    • test to run test against bundle results, library and demo

Useful links

Special thanks

Inspired by the awesome blog post Compiling and bundling TypeScript libraries with Webpack by Marco Botto

About

Create your next typescript library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published