rollup-plugin-json

What is rollup-plugin-json?

The rollup-plugin-json package is a Rollup plugin that allows you to import JSON files into your JavaScript bundles. It converts JSON files into ES6 modules, enabling you to use JSON data directly in your Rollup projects.

What are rollup-plugin-json's main functionalities?

Import JSON files

This feature allows you to import JSON files directly into your JavaScript code. The JSON data is converted into an ES6 module, making it easy to work with JSON data in your Rollup projects.

import data from './data.json';
console.log(data);

Convert JSON to ES6 modules

The plugin converts JSON files into ES6 modules, allowing you to access JSON properties as if they were part of a JavaScript object. This makes it convenient to manage configuration or data files in JSON format.

import config from './config.json';
console.log(config.setting);

Other packages similar to rollup-plugin-json

rollup-plugin-commonjs

rollup-plugin-commonjs is a Rollup plugin that allows you to convert CommonJS modules to ES6, so they can be included in a Rollup bundle. While it primarily focuses on CommonJS modules, it can also handle JSON imports, similar to rollup-plugin-json, but with broader functionality for module conversion.

rollup-plugin-node-resolve

rollup-plugin-node-resolve is a Rollup plugin that helps in resolving Node.js modules, including JSON files. It allows you to import JSON files as modules, similar to rollup-plugin-json, but it also provides additional features for resolving other types of modules and dependencies.

README

rollup-plugin-json

Convert .json files to ES6 modules:

// import a single property from a JSON file,
// discarding the rest
import { version } from './package.json';
console.log( `running version ${version}` );

// import the whole file as an object
import pkg from './package.json';
console.log( `running version ${pkg.version}` );

Installation

npm install --save-dev rollup-plugin-json

Usage

// rollup.config.js
import json from 'rollup-plugin-json';

export default {
  input: 'src/main.js',
  output: {
    file: 'dist/bundle.js',
    format: 'iife'
  },

  plugins: [
    json({
      // All JSON files will be parsed by default,
      // but you can also specifically include/exclude files
      include: 'node_modules/**',
      exclude: [ 'node_modules/foo/**', 'node_modules/bar/**' ],

      // for tree-shaking, properties will be declared as
      // variables, using either `var` or `const`
      preferConst: true, // Default: false

      // specify indentation for the generated default export —
      // defaults to '\t'
      indent: '  ',

      // ignores indent and generates the smallest code
      compact: true, // Default: false

      // generate a named export for every property of the JSON object
      namedExports: true // Default: true
    })
  ]
};

License

MIT

Changelog

3.1.0

2018-09-13

• Expose "compact" and "namedExports" options (#45)
• Update rollup-pluginutils to support null values in JSON (#44)
• Update dependencies and ensure rollup@1.0 compatibility (#46)