json5-loader

[![npm][npm]][npm-url] [![node][node]][node-url] [![deps][deps]][deps-url] [![tests][tests]][tests-url] [![cover][cover]][cover-url] [![chat][chat]][chat-url] [![size][size]][size-url]

A webpack loader for parsing json5 files into JavaScript objects.

Getting Started

To begin, you'll need to install json5-loader:

$ npm install json5-loader --save-dev

你可以通过以下两种用法使用此 loader:

  • 在 webpack 配置里的 module.loaders 对象中配置 json5-loader
  • 或者,直接在 require 语句中使用 json5-loader! 前缀。

假设我们有如下 json5 文件:

file.json5

// file.json5
{
  env: 'production',
  passwordStrength: 'strong',
}

Usage with preconfigured loader

webpack.config.js

// webpack.config.js
module.exports = {
  entry: './index.js',
  output: {
    /* ... */
  },
  module: {
    loaders: [
      {
        // 使所有以 .json5 结尾的文件使用 `json5-loader`
        test: /\.json5$/,
        loader: 'json5-loader',
      },
    ],
  },
};
// index.js
var appConfig = require('./appData.json5');
// 或者 ES6 语法
// import appConfig from './appData.json5'

console.log(appConfig.env); // 'production'

require 语句使用 loader 前缀的用法

var appConfig = require('json5-loader!./appData.json5');
// 返回的是 json 解析过的对象

console.log(appConfig.env); // 'production'

如果需要在 Node.js 中使用,不要忘记兼容(polyfill) require。更多参考 webpack 文档。

贡献

Please take a moment to read our contributing guidelines if you haven't yet done so.

贡献指南

License

MIT