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:

  1. $ npm install json5-loader --save-dev

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

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

假设我们有如下 json5 文件：

file.json5

  1. // file.json5
  2. {
  3.   env: 'production',
  4.   passwordStrength: 'strong',
  5. }

Usage with preconfigured loader

webpack.config.js

  1. // webpack.config.js
  2. module.exports = {
  3.   entry: './index.js',
  4.   output: {
  5.     /* ... */
  6.   },
  7.   module: {
  8.     loaders: [
  9.       {
  10.         // 使所有以 .json5 结尾的文件使用 `json5-loader`
  11.         test: /\.json5$/,
  12.         loader: 'json5-loader',
  13.       },
  14.     ],
  15.   },
  16. };
  1. // index.js
  2. var appConfig = require('./appData.json5');
  3. // 或者 ES6 语法
  4. // import appConfig from './appData.json5'
  6. console.log(appConfig.env); // 'production'

require 语句使用 loader 前缀的用法

  1. var appConfig = require('json5-loader!./appData.json5');
  2. // 返回的是 json 解析过的对象
  4. 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