npm 包 rollup-plugin-json5 使用教程

简介

rollup 是目前比较流行的前端打包工具之一，json5 则是一种相对于 json 更加灵活和易于使用的数据格式。而这篇文章要介绍的是 rollup-plugin-json5 这个 npm 包，可以让我们在 rollup 打包时直接使用 json5 格式的数据，避免了一些手动转换的麻烦。

安装

使用 npm 安装 rollup-plugin-json5，并将其加入到 rollup 插件中：

npm install --save-dev rollup-plugin-json5

-- -------------------- ---- -------
-- ----------------
------ ----- ---- ----------------------

------ ------- -
  ------ ---------------
  -------- -
    -------
  --
  ------- -
    -
      ----- -----------------
      ------- -----
    -
  -
-

使用

通过上面的配置，我们就可以在 rollup 打包时直接使用 json5 格式的数据文件了。比如下面的例子：

// data.json5
{
  name: 'rollup-plugin-json5',
  description: 'A rollup plugin for loading JSON5 data files'
}

// index.js
import data from './data.json5';

console.log(data.name); // rollup-plugin-json5
console.log(data.description); // A rollup plugin for loading JSON5 data files

参数

rollup-plugin-json5 还提供了一些可选的参数：

• include：与被包含的文件名匹配的文件将被添加到构建中。默认值为 ['**/*.json5', '**/*.json']。
• exclude：与被排除的文件名匹配的文件将不被添加到构建中。默认值为 undefined。
• options：要传递给 JSON5.parse() 方法的选项对象。默认值为 undefined。

-- -------------------- ---- -------
-- ----------------
------ ----- ---- ----------------------

------ ------- -
  ------ ---------------
  -------- -
    -------
      -------- ---------------
      -------- --------------------
      -------- -
        -------- ----- ------ --
          ------ ----- --- -------- -- -------------------------- -- -
            ------------------ -
            -----
      -
    --
  --
  ------- -
    -
      ----- -----------------
      ------- -----
    -
  -
-

结语

使用 rollup-plugin-json5 可以简化我们使用 json5 格式的数据文件的过程，避免了一些手动转换的麻烦，使前端开发变得更加高效，尤其是对于一些基于 rollup 的库的作者来说更是如此。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/63840