Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solidjs-community/rollup-preset-solid
A small opinionated preset for rollup to bundle your solid libraries with rollup.
https://github.com/solidjs-community/rollup-preset-solid
preset rollup solid-js
Last synced: about 2 months ago
JSON representation
A small opinionated preset for rollup to bundle your solid libraries with rollup.
- Host: GitHub
- URL: https://github.com/solidjs-community/rollup-preset-solid
- Owner: solidjs-community
- License: mit
- Created: 2021-03-13T21:35:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-25T09:53:44.000Z (about 1 year ago)
- Last Synced: 2024-04-14T00:25:51.001Z (5 months ago)
- Topics: preset, rollup, solid-js
- Language: TypeScript
- Homepage:
- Size: 133 KB
- Stars: 36
- Watchers: 1
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-solid-js - Roll-up preset for Solid Libraries - Preset for rollup to bundle your solid libraries with rollup (📦 Components & Libraries / DX)
README
# Solid Rollup Preset
A small opinionated preset for rollup to bundle your [solid](https://github.com/ryansolid/solid) libraries with rollup.
Features out of the box:
- Automatic TypeScript
- Minimal - two lines config
- No lock-in - you are in total control of the rollup config
- Best practices for publishing solid libraries by compiling for `esm`, `cjs`, `jsx`, `umd` and `tsc`
- Automatically clean `dist` folder on build
## Usage
1. Install with your favorite package manager:
```sh
npm install -D rollup-preset-solid rollup
pnpm add -D rollup-preset-solid rollup
yarn add -D rollup-preset-solid rollup
```
2. Import `withConfig` in your `rollup.config.js`. The first and only argument is (optionally) your rollup config:
```js
// rollup.config.js
import withSolid from "rollup-preset-solid";
export default withSolid();
```
3. Configure your package.json
```json
{
"name": "my-lib",
"// This is optional but this remove the need to manually configure the source input for rollup": "",
"source": "src/my-lib.tsx",
"// All the following properties will be hinted during build": "",
"// You will just have to copy paste them": "",
"main": "dist/cjs/my-lib.js",
"module": "dist/esm/my-lib.js",
"types": "dist/types/my-lib.d.ts",
"files": ["dist"],
"exports": {
".": {
"solid": "./dist/source/my-lib.jsx",
"import": "./dist/esm/my-lib.js",
"browser": "./dist/esm/my-lib.js",
"require": "./dist/cjs/my-lib.js",
"node": "./dist/cjs/my-lib.js"
}
}
}
```
## API
### withSolid(options?: Options | Options[]): RollupOptions | RollupOptions[]
The default export. A wrapper function that accepts all of the rollup options and a few extra to configure what to generate.
### Options
The options are the exact same as Rollup with a few extra that are
specific to the wrapper
#### Interface
```ts
interface Options extends RollupOptions {
/**
* Defines which target you want
* @default ['esm']
*/
targets?: ModuleFormat[];
/**
* Whether to generate a package.json or not
* This is useful for sub packages
* @default false
*/
writePackageJson?: boolean;
/**
* Whether to hint what to put in your package.json or not
* @default false
*/
printInstructions?: boolean;
}
```
#### Example
```js
// rollup.config.js
import withSolid from "rollup-preset-solid";
export default withSolid([
{ input: "browser.ts", targets: ["esm"] },
{ input: "server.ts", targets: ["esm", "cjs"], writePackageJson: true },
]);
```