https://github.com/juliendargelos/rollup-library

Library template for rollup and typescript, powered by github actions
https://github.com/juliendargelos/rollup-library

rollup template typescript

Last synced: 18 days ago
JSON representation

Library template for rollup and typescript, powered by github actions

• Host: GitHub
• URL: https://github.com/juliendargelos/rollup-library
• Owner: juliendargelos
• License: mit
• Created: 2020-01-31T14:36:34.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-02T04:41:25.000Z (over 3 years ago)
• Last Synced: 2024-11-11T05:39:07.707Z (3 months ago)
• Topics: rollup, template, typescript
• Language: JavaScript
• Homepage:
• Size: 181 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rollup-library

[![test](https://github.com/juliendargelos/rollup-library/workflows/test/badge.svg?branch=master)](https://github.com/juliendargelos/rollup-library/actions?workflow=test)

[![build](https://github.com/juliendargelos/rollup-library/workflows/build/badge.svg?branch=master)](https://github.com/juliendargelos/rollup-library/actions?workflow=build)

[![version](https://img.shields.io/github/package-json/v/juliendargelos/rollup-library)](https://github.com/juliendargelos/rollup-library)

Library template for rollup and typescript, powered by github actions. Dependencies always up to date thanks to [dependabot](https://dependabot.com).

*See [rollup-application](https://github.com/juliendargelos/rollup-application) if you need an application template.*

### Usage

Click on [![Use this template](https://img.shields.io/badge/-Use%20this%20template-brightgreen)](https://github.com/juliendargelos/rollup-library/generate) then wait for the [initialize workflow](.github/workflows/initialize.yml) to complete. The package name and urls will be automatically replaced at initialization. You may want to change the author name in `package.json` and `LICENSE`.

### Features

#### Bundling

- Rollup, TypeScript, ESLint and Jest

- ESM, CJS and UMD bundles

- Path alias from tsconfig.json synced with rollup

- Development server with demo in watch mode

- Terser for browser and demo bundle

#### Continuous integration (Github Actions)

- Build and test on pull requests and push to master

- Build, test and publish to npm when a new version is pushed to master


  *Requires `NODE_TOKEN` secret to be set as a [NPM authentication token](https://docs.npmjs.com/about-authentication-tokens).*

- Build demo and deploy to Github Pages on push to master


  *Requires `PERSONAL_TOKEN` secret to be set as a [GitHub personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with full `repo` scope.*

The [publish](.github/workflows/publish.yml.sample) and [demo](.github/workflows/demo.yml.sample) workflows are disabled by default, [add the required secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) and remove the `.sample` suffix from the corresponding files to enable them.