@rollup/plugin-json
Advanced tools
Package description
The @rollup/plugin-json npm package allows users to import JSON files as modules in their Rollup bundles. It converts JSON files into ES6 modules, making it possible to include JSON data in the bundle as if they were regular JavaScript modules.
Import JSON files as modules
This feature allows you to import JSON files directly into your JavaScript code. The JSON data is parsed and transformed into an ES6 module, which can then be used like any other imported module.
import config from './config.json';
console.log(config);Customize indentation
This feature allows you to specify the indentation for the generated default export, giving you control over the formatting of the output.
import json from '@rollup/plugin-json';
export default {
plugins: [
json({
indent: ' '
})
]
};Filter which JSON files to include
This feature allows you to use a filter function to determine which JSON files should be processed by the plugin. This is useful when you want to include only certain JSON files based on a pattern or condition.
import json from '@rollup/plugin-json';
import { createFilter } from '@rollup/pluginutils';
const filter = createFilter('**/config/*.json');
export default {
plugins: [
json({
include: filter
})
]
};Exclude JSON files
This feature allows you to exclude certain JSON files from being processed by the plugin. For example, you might want to exclude JSON files from the 'node_modules' directory.
import json from '@rollup/plugin-json';
export default {
plugins: [
json({
exclude: ['node_modules/**']
})
]
};This is the predecessor to @rollup/plugin-json. It offers similar functionality but is no longer maintained. Users are encouraged to migrate to @rollup/plugin-json for future updates and bug fixes.
Similar to @rollup/plugin-json, this plugin allows importing YAML files as ES6 modules. It's useful for projects that prefer YAML over JSON for configuration or data files.
This plugin allows importing GraphQL files as ES6 modules, similar to how @rollup/plugin-json handles JSON files. It's specifically designed for GraphQL query and schema files.
Readme
🍣 A Rollup plugin which Converts .json files to ES6 modules.
This plugin requires an LTS Node version (v14.0.0+) and Rollup v1.20.0+.
Using npm:
npm install @rollup/plugin-json --save-dev
Create a rollup.config.js configuration file and import the plugin:
import json from '@rollup/plugin-json';
export default {
input: 'src/index.js',
output: {
dir: 'output',
format: 'cjs'
},
plugins: [json()]
};
Then call rollup either via the CLI or the API.
With an accompanying file src/index.js, the local package.json file would now be importable as seen below:
// src/index.js
import { readFileSync } from 'fs';
const pkg = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8'));
console.log(`running version ${pkg.version}`);
compactType: Boolean
Default: false
If true, instructs the plugin to ignore indent and generates the smallest code.
excludeType: String | Array[...String]
Default: null
A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore. By default no files are ignored.
includeType: String | Array[...String]
Default: null
A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.
includeArbitraryNamesType: Boolean
Default: false
If true and namedExports is true, generates a named export for not a valid identifier properties of the JSON object by leveraging the "Arbitrary Module Namespace Identifier Names" feature.
indentType: String
Default: '\t'
Specifies the indentation for the generated default export.
namedExportsType: Boolean
Default: true
If true, instructs the plugin to generate a named export for every property of the JSON object.
preferConstType: Boolean
Default: false
If true, instructs the plugin to declare properties as variables, using either var or const. This pertains to tree-shaking.
FAQs
Convert .json files to ES6 modules
The npm package @rollup/plugin-json receives a total of 1,842,878 weekly downloads. As such, @rollup/plugin-json popularity was classified as popular.
We found that @rollup/plugin-json demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.
Company News
Come meet the Socket team at BSidesSF and RSA! We're sponsoring several fun networking events and we would love to see you there.