@rexxars/babel-plugin-inline-json-import

A babel plugin that inlines all imports of JSON files straight into your JavaScript files.

Example

Given the following JSON file:

1{
2  "foo": "bar"
3}

The plugin will transform the following statement:

1import json from './path/to/file.json'

or

1const json = require('./path/to/file.json')

to:

1const json = {foo: 'bar'}

Simple as that! Both require and import are supported.

Not only that, but it also supports destructuring:

1const {foo} = require('./path/to/file.json')
2// =>
3const foo = 'bar'

Installation

Install the plugin through npm, you will also need babel installed for obvious reasons:

1$ npm install --save-dev @rexxars/babel-plugin-inline-json-import

Add @rexxars/babel-plugin-inline-json-import to the list of plugins. If you are using a .babelrc file, the file should have an entry that looks like this:

1{
2  "plugins": ["@rexxars/inline-json-import"]
3}

Usage

This should work straight out of the box. You can configure a RegExp pattern you want to match on, should you only wish it to apply to certain JSON files:

1{
2  "plugins": [
3    [
4      "@rexxars/inline-json-import",
5      {
6        "match": "/package.json$",
7        "matchFlags": "i"
8      }
9    ]
10  ]
11}

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request =)

Fork modifications

This module was originally made by Bryan Yap, and has been forked in order to provide the following improvements:

• Inlining of only destructured items where possible
• Rewritten imports now correctly appear after other imports
• Configurable RegExp for specifying which files to inline
• Handles certain "exotic" import styles without crashing
• Handles loading of JSON files from node_modules

All modifications were contributed upstream and is awaiting review at the time of writing.

License

This project is licensed under the MIT License - see the LICENSE file for details