Git Product home page Git Product logo

create-typescript-library's Introduction

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

create-typescript-library's People

Contributors

ryancat avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.