@rollup/plugin-json
    TypeScript icon, indicating that this package has built-in type declarations

    4.1.0 • Public • Published

    npm size libera manifesto

    @rollup/plugin-json

    🍣 A Rollup plugin which Converts .json files to ES6 modules.

    Requirements

    This plugin requires an LTS Node version (v8.0.0+) and Rollup v1.20.0+.

    Install

    Using npm:

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

    Usage

    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 pkg from './package.json';
    console.log(`running version ${pkg.version}`);

    Options

    compact

    Type: Boolean
    Default: false

    If true, instructs the plugin to ignore indent and generates the smallest code.

    exclude

    Type: String | Array[...String]
    Default: null

    A minimatch pattern, 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]
    Default: null

    A minimatch pattern, 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
    Default: '\t'

    Specifies the indentation for the generated default export.

    namedExports

    Type: Boolean
    Default: true

    If true, instructs the plugin to generate a named export for every property of the JSON object.

    preferConst

    Type: Boolean
    Default: false

    If true, instructs the plugin to declare properties as variables, using either var or const. This pertains to tree-shaking.

    Meta

    CONTRIBUTING

    LICENSE (MIT)

    Install

    npm i @rollup/plugin-json

    DownloadsWeekly Downloads

    929,629

    Version

    4.1.0

    License

    MIT

    Unpacked Size

    15.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • guybedford
    • lukastaegert
    • rich_harris
    • shellscape