You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
2.5 KiB
102 lines
2.5 KiB
3 years ago
|
[npm]: https://img.shields.io/npm/v/@rollup/plugin-json
|
||
|
|
[npm-url]: https://www.npmjs.com/package/@rollup/plugin-json
|
||
|
|
[size]: https://packagephobia.now.sh/badge?p=@rollup/plugin-json
|
||
|
|
[size-url]: https://packagephobia.now.sh/result?p=@rollup/plugin-json
|
||
|
|
|
||
|
|
[![npm][npm]][npm-url]
|
||
|
|
[![size][size]][size-url]
|
||
|
|
[](https://liberamanifesto.com)
|
||
|
|
|
||
|
|
# @rollup/plugin-json
|
||
|
|
|
||
|
|
🍣 A Rollup plugin which Converts .json files to ES6 modules.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
This plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v8.0.0+) and Rollup v1.20.0+.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Using npm:
|
||
|
|
|
||
|
|
```console
|
||
|
|
npm install @rollup/plugin-json --save-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Create a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files) and import the plugin:
|
||
|
|
|
||
|
|
```js
|
||
|
|
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](https://www.rollupjs.org/guide/en/#command-line-reference) or the [API](https://www.rollupjs.org/guide/en/#javascript-api).
|
||
|
|
|
||
|
|
With an accompanying file `src/index.js`, the local `package.json` file would now be importable as seen below:
|
||
|
|
|
||
|
|
```js
|
||
|
|
// src/index.js
|
||
|
|
import pkg from './package.json';
|
||
|
|
console.log(`running version ${pkg.version}`);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Options
|
||
|
|
|
||
|
|
### `compact`
|
||
|
|
|
||
|
|
Type: `Boolean`<br>
|
||
|
|
Default: `false`
|
||
|
|
|
||
|
|
If `true`, instructs the plugin to ignore `indent` and generates the smallest code.
|
||
|
|
|
||
|
|
### `exclude`
|
||
|
|
|
||
|
|
Type: `String` | `Array[...String]`<br>
|
||
|
|
Default: `null`
|
||
|
|
|
||
|
|
A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.
|
||
|
|
|
||
|
|
### `include`
|
||
|
|
|
||
|
|
Type: `String` | `Array[...String]`<br>
|
||
|
|
Default: `null`
|
||
|
|
|
||
|
|
A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.
|
||
|
|
|
||
|
|
### `indent`
|
||
|
|
|
||
|
|
Type: `String`<br>
|
||
|
|
Default: `'\t'`
|
||
|
|
|
||
|
|
Specifies the indentation for the generated default export.
|
||
|
|
|
||
|
|
### `namedExports`
|
||
|
|
|
||
|
|
Type: `Boolean`<br>
|
||
|
|
Default: `true`
|
||
|
|
|
||
|
|
If `true`, instructs the plugin to generate a named export for every property of the JSON object.
|
||
|
|
|
||
|
|
### `preferConst`
|
||
|
|
|
||
|
|
Type: `Boolean`<br>
|
||
|
|
Default: `false`
|
||
|
|
|
||
|
|
If `true`, instructs the plugin to declare properties as variables, using either `var` or `const`. This pertains to tree-shaking.
|
||
|
|
|
||
|
|
## Meta
|
||
|
|
|
||
|
|
[CONTRIBUTING](/.github/CONTRIBUTING.md)
|
||
|
|
|
||
|
|
[LICENSE (MIT)](/LICENSE)
|