rollup-plugin-generate-package-json

Generate package.json file with packages from your bundle using Rollup.

About

This plugin is useful when you have a lot of packages in your current package.json file and want to create a lean one with only packages from your generated bundle, probably for deployment.

Installation

1# yarn
2yarn add rollup-plugin-generate-package-json -D
3
4# npm
5npm install rollup-plugin-generate-package-json -D

Usage

1// rollup.config.js
2import generatePackageJson from 'rollup-plugin-generate-package-json'
3
4export default {
5  input: 'src/index.js',
6  output: {
7    file: 'dist/app.js',
8    format: 'cjs'
9  },
10  plugins: [
11    generatePackageJson()
12  ]
13}

Configuration

There are some useful options, all of them are optional:

inputFolder

Type: string
Default: current working directory

Set input package.json folder.

1generatePackageJson({
2  inputFolder: 'nested/folder'
3})

outputFolder

Type: string
Default: bundle output folder

Set output folder for generated package.json file.

1generatePackageJson({
2  outputFolder: 'dist'
3})

baseContents

Type: object | function
Default: {}

Set base contents for your generated package.json file.

1generatePackageJson({
2  baseContents: {
3    scripts: {
4      start: 'node app.js'
5    },
6    dependencies: {},
7    private: true
8  }
9})

It can also be a function, which receives the contents of the input package.json file.

1generatePackageJson({
2  baseContents: (pkg) => ({
3    name: pkg.name,
4    main: pkg.main.replace('src', 'dist')
5    dependencies: {},
6    private: true
7  })
8})

additionalDependencies

Type: Array | object
Default: []

Set dependencies which are not directly imported in the bundle, but are used by the app.

1generatePackageJson({
2  additionalDependencies: ['pg']
3})

It's also possible to add new dependencies or overwrite dependency version.

1generatePackageJson({
2  additionalDependencies: {
3    pg: '7.12.1',
4    'react-calendar': 'file:../react-calendar/react-calendar-v2.13.2.tgz'
5  }
6})

License

MIT