/typescript-rollup-boilerplate

TypeScript + Rollup boilerplate with extra stuffs

Primary LanguageHTMLMIT LicenseMIT

Typescript-Rollup-Boilerplate

Written in TypeScript Tested with Jest Bundled with Rollup Documentation built by TypeDoc

Statements Branches Functions Lines Build Status Built By We Love
Statements Branches Functions Lines BuildStatus BuiltBy ForTheBadge

Features

  • TypeScript compiler bundled with Rollup carrying the following plugins:

    1. Replace (removing node environment things)
    2. Resolve (module resolution plugin)
    3. JSON (resolve JSON files)
    4. TypeScript (compile TS files)
    5. CommonJS (allow cjs understanding)
    6. Google Closure Compiler (it reduces the bundle size)

  • Source Map Viewer with source-map-explorer

  • Jest Badges within the README file with jest-badges-readme

    Statements Branches Functions Lines Build Status Built By We Love
    Statements Branches Functions Lines BuildStatus BuiltBy ForTheBadge

  • Documentation built with TypeDoc

Requirements

  • Assuming you have installed all dependencies after npm install, you must have Java installed in your environment in order to reduce bundle size with Google Closure Compiler.

Motivation

  • To create a boilerplate ready to deliver JavaScript libraries with ease, strong documentation and tests.

Table of contents

Collaborators

Created by the Frontend team of - Rio de Janeiro - 2019 - 💀

Olavo Parno