theoomoregbee / rollup-typescript-lib-starter

Just a boilerplate for building a library with TS + Github action for testing

rollup-typescript-lib-starter

Just a boilerplate for building a library with TS + Github action for testing.

Configured with:

• Rollup module bundler
• Typescript 4.2
• StandardJs linter and formatter
• Mocha with Chai for unit testing
• Simple example of TypeScript code and unit test
• Github Actions Test workflow

Build Configuration

• Use package.json name field as the name of the library when bundling for browsers
• type definition is exposed via types field in package.json
• main entry point field within package.json targets the bundled distribution

Note: update main and types when build directory is changed.

Github Actions Test workflow

Automatically runs when you push to main branch or a pull request pointing to main branch.

see test.yml

Available scripts

yarn start

Start the library build and test in watch mode for every file edit.

yarn build

Build distribution bundle to ./build/ directory.

yarn test

Lints and test library.

yarn lint

Uses ts-standard for linting so you don't have to worry about ESLint configurations

yarn lint:fix

Automatically fixes any lint errors encountered.

yarn build:watch

Run build script in watch mode.