Registry / devops / rollup-plugin-generate-package-json

rollup-plugin-generate-package-json

library3.2.0jsnpmunverified

Rollup plugin that generates a lean package.json file containing only the dependencies from your bundle, optionally supplemented with additional dependencies. Version 3.2.0, released 2021-01-28 with active maintenance; supports Rollup >=1.0.0 and Node >=8.3. Key differentiator: automatically extracts dependencies used in the bundle, avoiding manual pruning of package.json for deployment. Offers options to customize base contents (via object or function) and add extra dependencies with version overrides. ESM-only plugin.

devops

npm install rollup-plugin-generate-package-json

github ↗package ↗

INSTALL

IMPORT

SIG · ROLLUP-PLUGIN-GENE

rollup-plugin-generate-package-json

devopsjavascriptv3.2.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generatePackageJson

✓ import generatePackageJson from 'rollup-plugin-generate-package-json'

✗ const generatePackageJson = require('rollup-plugin-generate-package-json')

The plugin is ESM-only; CommonJS require will fail. Use import.

generatePackageJson

✓ import generatePackageJson from 'rollup-plugin-generate-package-json'

Default export in v3. Previously named exports were not available.

generatePackageJson

✓ import generatePackageJson from 'rollup-plugin-generate-package-json'

✗ import { generatePackageJson } from 'rollup-plugin-generate-package-json'

Named import is not supported; only default export exists.

Shows basic usage: import plugin, configure output dir, set base package.json contents and extra dependencies.

// rollup.config.js import generatePackageJson from 'rollup-plugin-generate-package-json'; export default { input: 'src/index.js', output: { dir: 'dist', format: 'cjs' }, plugins: [ generatePackageJson({ baseContents: { name: 'my-app', private: true, scripts: { start: 'node index.js' } }, additionalDependencies: ['pg'] }) ] };

Debug

Known issues

breakingIn v3.0.0, the option 'inputPackageJson' was renamed to 'inputFolder' and its semantic changed: it now points to the folder containing the input package.json, not the file itself.

fix

Replace 'inputPackageJson' option with 'inputFolder' set to the folder path (e.g., 'src').

affects: >=3.0.0

breakingIn v2.0.0, the option 'inputFile' was renamed to 'inputPackageJson'.

fix

Rename 'inputFile' to 'inputPackageJson'.

affects: >=2.0.0 <3.0.0

deprecatedSupport for Rollup < 1.0.0 is dropped; peer dependency rollup >= 1.0.0 required.

fix

Upgrade Rollup to version 1.0.0 or higher.

affects: >=3.0.0

breakingNode.js version < 8.3 is no longer supported in v3.2.0.

fix

Update Node.js to version 8.3 or higher.

affects: >=3.2.0

gotchaThe plugin generates package.json in the output folder determined by Rollup's 'dir' option (or 'file' parent). Ensure 'output.dir' is set appropriately.

fix

Use 'output.dir' in Rollup config, not 'output.file' (or set 'outputFolder' explicitly to override).

affects: >=3.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /path/node_modules/rollup-plugin-generate-package-json/dist/index.js

Using CommonJS require() to load an ESM-only plugin.

fix

Use the import statement: import generatePackageJson from 'rollup-plugin-generate-package-json'

TypeError: generatePackageJson is not a function

Using named import instead of default import.

fix

Use default import: import generatePackageJson from 'rollup-plugin-generate-package-json'

Error: [generate-package-json] Input package.json not found at specified folder: /path/to/folder

The 'inputFolder' option points to a folder that does not contain a package.json file.

fix

Ensure the folder exists and contains a valid package.json, or set 'inputFolder' to the correct path.

Error: [generate-package-json] Output folder is not defined. Use 'outputFolder' option or use 'dir' for rollup output.

Neither 'outputFolder' option nor Rollup's 'output.dir' is set.

fix

Set the 'outputFolder' option in the plugin or provide 'dir' in Rollup output configuration.

Upgrade

Version history

3.2.0latest on npm

Audit

Dependencies

rolluprequiredpeer dependency; version >=1.0.0 required

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/vladshcherbin/rollup-plugin-generate-package-json ↗

packagehttps://www.npmjs.com/package/rollup-plugin-generate-package-json ↗