Presetter-preset-rollup NPM

🏄🏻 A collection of opinionated configurations for a building a code bundle via rollup for presetter

• Quick Start • Project Structure • Customization • Scripts •

Features

presetter-preset-rollup is an opinionated preset for you to setup rollup in a fraction of time you usually take via presetter.

🗞️ Rollup 4
2️⃣ Dual CJS and ESM modules export by default
🍄 Common rollup packages included as one single bundle
- @rollup/plugin-commonjs
- @rollup/plugin-graphql
- @rollup/plugin-image
- @rollup/plugin-json
- @rollup/plugin-typescript
- @rollup/plugin-yaml
- rollup <~ of course including rollup itself
- rollup-plugin-postcss
- rollup-plugin-tsconfig-paths
- rollup-plugin-visualizer

Quick Start

To kickstart a library, set the following in your package.json and follow the guide below.

{
  "main": "lib/index.js",
  "module": "lib/index.mjs",
  "types": "lib/index.d.ts",
  "exports": {
    "require": "./lib/index.js",
    "import": "./lib/index.mjs"
  },
  "scripts": {
    "prepare": "run prepare",
    "build": "run build",
    "clean": "run clean",
    "test": "run test",
    "watch": "run watch",
    "coverage": "run coverage"
  }
}

FULL DOCUMENTATION IS AVAILABLE HERE

1. Bootstrap your project with presetter-preset-web

On your project root, create a presetter.config.ts file with the following content:

// presetter.config.ts

import { preset } from 'presetter';
import essentials from 'presetter-preset-essentials';
import rollup from 'presetter-preset-rollup';

export default preset('project name', {
  // NOTE
  // you may need an additional preset like presetter-preset-essentials for typescript support and other basic toolings
  extends: [essentials, rollup],
  override: {
    // override the configuration here
  },
});

Then, install your project as usual with npm install or any package manager you prefer.

2. Develop and run life cycle scripts provided by the preset

At this point, all development packages specified in the preset are installed, and now you can try to run some example life cycle scripts (e.g. run prepare).

Demo

Project Structure

After installation, your project file structure should resemble the following or with more configuration files if you also installed other presets such as presetter-preset-esm.

Implement your business logic under source and prepare tests under spec.

TIPS You can always change the source directory to other (e.g. src) by setting the source variable in presetter.config.ts. See the customization section below for more details.

(root)
 ├─ .git
 ├─ presetter.config.ts
 ├─ node_modules
 ├─ source
 │   ├─ <folders>
 │   ├─ index.ts
 │   ├─ (auxiliary).ts
 ├─ spec
 │   ├─ *.spec.ts
 ├─ package.json
 └─ rollup.config.ts

Customization

By default, this preset exports a handy configuration for a typescript project. You can further customize (either extending or replacing) the configuration by specifying the changes in the config file presetter.config.ts.

Script Template Summary

run build: Transpile source code from typescript and replace any mapped paths
run clean: Clean up any previously transpiled code
run develop -- <file path>: Create a service that run the specified file whenever the source has changed
run test: Run all tests
run watch: Rerun all tests whenever the source has change
run coverage: Run all test with coverage report
run release: Bump the version and automatically generate a change log
run release -- --prerelease <tag>: Release with a prerelease tag