3tk 中文文档教程
rollup-starter-project
这个包展示了如何开始使用 rollup（和 babel) 用于写作 使用 ES6 模块的 npm 包。 使用 jsnext:main 编写 npm 包允许 您的包的用户可以选择他们是否使用传统的方式使用它 require node.js 理解的函数，或者使用添加的 import 语句 在 ES6 中，它可以通过实时代码包含 static 产生更小的包 分析。
Usage
你可以简单地使用这个项目作为如何配置你自己的灵感， 或在开始您自己的项目时克隆它并编辑元数据文件（即 README.md、package.json 和许可证）。
lib/index.js
这是您应用程序中的主要源文件，也是您将启动的主要文件 编辑以实现包的功能。 如图所示 例如，您可以从该文件导入 其他文件，方法与您希望的类似 通常需要 包（例如lib/utils.js）。
test/index_test.js
这是包中测试的起点。 你应该导入 从 lib/ 中测试的代码，如示例中所示。 该项目已经 配置为在运行 npm test 时使用 mocha。
dist/rollup-starter-project.js
这是包的 main 文件，包括运行所需的所有代码 你的包裹。 它是 UMD 格式，这意味着它可以在大多数 JavaScript 中使用 运行时环境。 如果你的包有你不想捆绑的依赖项， 请务必将汇总配置为通过将它们标记为 external 来排除它们。 经过 默认情况下，package.json 中的所有 dependencies 条目都是 external。
dist/rollup-starter-project.mjs
这是包的 jsnext:main 文件，包括所有需要的代码 运行你的包。 与 UMD 版本相比，此版本保留了 ES6 导入 并在包边界导出支持它的工具（例如汇总）。 如果你的包有你不想捆绑的依赖项，一定要配置 汇总以通过将它们标记为 external 来排除它们。 默认全部 package.json 中的dependencies 条目将是external。
.eslintrc
这控制了包的 lint 和从推荐集开始的方式 来自 eslint 本身的规则。 它还使用 babel-eslint 来解析你的代码， 允许标准 eslint 解析器可能无法理解的语法（例如类型 注释）。
Dependencies
本节解释所有依赖项是什么以及它们的用途，所以 您可以决定您实际需要哪些。
babel-eslint
使 eslint 能够理解所有 JavaScript 语法 babel 理解，并添加了一些 linting ES2015 规则 代码。 如果你不打算使用 babel 转换 ES2015 代码，这个可以去掉 到 ES5 或者如果你不打算使用 eslint。
babel-plugin-external-helpers
确保每个 babel 助手只有一个副本包含在包中 与汇总一起使用。 如果你不打算使用babel进行改造，这个可以去掉 ES2015 代码到 ES5。
babel-preset-es2015
在不使用 rollup 的情况下使用 babel 时使用，并由 .babelrc 文件引用。 如果您不打算使用 babel 将 ES2015 代码转换为 ES5，则可以将其删除 或者您计划手动指定所有 babel 插件。
babel-register
通过 babel 提供按需转换，因此不需要预编译。 这在测试中使用以允许在不先编译的情况下运行它们，并且是 在 test/mocha.opts 中引用。
babelrc-rollup
处理将 babel 配置从 .babelrc 转换为适合使用的配置 使用 rollup-plugin-babel，您不想在其中使用任何模块插件。
eslint
eslint 检查您的代码是否存在常见错误并确保它 遵循您在 .eslintrc 中配置的样式。 如果你可以删除它 计划不对您的代码进行 lint，或者如果您正在使用其他 linter，例如 jshint 或 jscs。
mocha
mocha 是一个测试运行器。 如果你计划，你可以删除它 不要写测试（不要那样做！）或者如果你打算使用另一个测试运行器 例如 Jasmine。
istanbul
istanbul 是一个代码覆盖工具，它 使用模块加载器钩子计算语句、行、函数和分支覆盖率 在运行测试时透明地添加覆盖率。 您可以删除此依赖项 如果您不会编写测试或者您不关心代码覆盖率。
您还必须更改 test/mocha.opts 文件并删除自定义 报告者选项 --reporter test/istanbul.reporter.js。 之后你可以安全地 删除 test/istanbul.reporter.js 文件。
rollup
rollup 是一个 JavaScript 模块打包器以及原因 你首先关注这个项目，所以你可能不想 删除此依赖项。
rollup-plugin-babel
这个插件启用了对 babel 的支持，它转换 ES2015 代码到 ES5。 如果您不打算使用 ES2015 代码，则可以删除它。
rollup-plugin-istanbul
这个插件提供了 Rollup 和 Istanbul 生成代码覆盖率 您的项目报告。 如果您不打算编写测试或根本不关心 关于代码覆盖率，您可以安全地将其与伊斯坦布尔一起删除。
就像伊斯坦布尔依赖项一样，您应该更改 test/mocha.opts 文件。 阅读以上关于移除 Istanbul 的说明。
Contributing
如果您认为使用 rollup 构建的项目应该以不同的方式设置，请打开一个 问题来讨论它或创建拉取请求。
rollup-starter-project
This package shows how to get started with rollup (and babel) for writing npm packages using ES6 modules. Writing npm packages with a jsnext:main allows users of your package to choose whether they use it using the traditional require function understood by node.js, or using the import statement added in ES6 which can result in smaller bundles through live-code inclusion static analysis.
Usage
You can simply use this project as inspiration for how to configure your own, or clone it and edit the metadata files when starting your own project (i.e. README.md, package.json, and LICENSE).
lib/index.js
This is the main source file in your application, and the main file you'll start editing to implement the functionality of your package. As shown in this example, you can import other files from this file similarly to how you would require packages typically (e.g. lib/utils.js).
test/index_test.js
This is the starting point for tests in your package. You should import the code to test from lib/ as shown in the example. The project is already configured to use mocha when you run npm test.
dist/rollup-starter-project.js
This is the main file of the package and includes all the code needed to run your package. It is in UMD format, meaning it can be used in most JavaScript runtime environments. If your package has dependencies you do not want bundled, be sure to configure rollup to exclude them by marking them as external. By default all dependencies entries in your package.json will be external.
dist/rollup-starter-project.mjs
This is the jsnext:main file of the package and includes all the code needed to run your package. Compared to the UMD version, this one preserves ES6 imports and exports at the package boundary for tools that support it (such as rollup). If your package has dependencies you do not want bundled, be sure to configure rollup to exclude them by marking them as external. By default all dependencies entries in your package.json will be external.
.eslintrc
This controls how the package is linted and starts off with the recommended set of rules from eslint itself. It also uses babel-eslint to parse your code, allowing syntax that the standard eslint parser may not understand (e.g. type annotations).
Dependencies
This section explains what all the dependencies are and what they're for, so you can decide which ones you actually need.
babel-eslint
Enables eslint to understand all JavaScript syntax that babel understands, and adds a few rules for linting ES2015 code. This can be removed if you plan not to use babel to transform ES2015 code to ES5 or if you plan not to use eslint.
babel-plugin-external-helpers
Ensures that only one copy of each babel helper is included in the bundle when used with rollup. This can be removed if you plan not to use babel to transform ES2015 code to ES5.
babel-preset-es2015
Used when babel is used without rollup, and referenced by the .babelrc file. This can be removed if you plan not to use babel to transform ES2015 code to ES5 or you plan to specify all the babel plugins manually.
babel-register
Provides on-demand transpilation via babel so no precompilation is required. This is used in the tests to allow running them without compiling first, and is referenced in test/mocha.opts.
babelrc-rollup
Handles transforming the babel config from .babelrc to one suitable for use with rollup-plugin-babel, where you don't want to use any module plugins.
eslint
eslint checks your code for common errors and ensures it adheres to the style you configure in .eslintrc. You can remove this if you plan not to lint your code or if you're using another linter, such as jshint or jscs.
mocha
mocha is a test runner. You can remove this if you plan not to write tests (don't do that!) or if you plan to use another test runner such as Jasmine.
istanbul
istanbul is a code coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. You can remove this dependency if you won't be writing tests or you don't care about code coverage.
You'll also have to change the test/mocha.opts file and remove the custom reporter option --reporter test/istanbul.reporter.js. After that you can safely delete the test/istanbul.reporter.js file.
rollup
rollup is a JavaScript module bundler and the reason you're looking at this project in the first place, so you probably don't want to remove this dependency.
rollup-plugin-babel
This plugin enables support for babel, which transforms ES2015 code to ES5. You can remove this if you plan not to use ES2015 code.
rollup-plugin-istanbul
This plugin provides seamless integration between Rollup and Istanbul to generate code coverage reports of your project. If you don't plan to write tests or simply don't care about code coverage, you can safely remove this along with Istanbul.
Just like with the Istanbul dependency, you should change the test/mocha.opts file. Read the above instructions for removing Istanbul.
Contributing
If you think a project built with rollup should be set up differently, open an issue to discuss it or create a pull request.
