@qubit-ltd/rollup-builder 1.8.4

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,335 @@
+# Rollup Builder
+
+[![npm package](https://img.shields.io/npm/v/@haixing_hu/rollup-builder.svg)](https://npmjs.com/package/@haixing_hu/rollup-builder)
+[![License](https://img.shields.io/badge/License-Apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![中文文档](https://img.shields.io/badge/文档-中文版-blue.svg)](README.zh_CN.md)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/Haixing-Hu/rollup-builder/tree/master.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/Haixing-Hu/rollup-builder/tree/master)
+
+`rollup-builder` provides a utility function to simplify the process of building 
+JavaScript libraries using the [Rollup] bundler. It allows you to generate various 
+formats such as CommonJS (CJS), ES Module (ESM), and Universal Module Definition
+(UMD), and gives you the option to choose whether to perform code minification.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration Options](#configuration)
+- [Mixing Default and Named Exports](#mix-default-named)
+- [Contributions](#contributions)
+- [License](#license)
+
+## <span id="features">Features</span>
+
+- Build JavaScript libraries in multiple formats, making them compatible with a 
+  variety of environments.
+- Minify your library for production use with ease.
+- Automatic generation of sourcemaps for debugging.
+- Configure the library's format, filename, and more using simple options.
+- You can [mix default and named exports](#mix-default-named) in ESM modules and 
+  the [Rollup] will generate code in CJS or UMD format that compatible with both
+  CommonJS and ES6.
+- Highly customizable using [Rollup] plugins and custom configurations.
+
+## <span id="installation">Installation</span>
+
+You can install `rollup-builder` as a development dependency using `npm` or `yarn`:
+
+```bash
+npm install @haixing_hu/rollup-builder --save-dev
+# or
+yarn add @haixing_hu/rollup-builder --dev
+```
+
+## <span id="usage">Usage</span>
+
+1. Create a [Rollup] configuration file (usually named `rollup.config.mjs`) and 
+   export a function that defines the library's build options. You can use the 
+   provided `rollupBuilder` function to streamline this process.
+
+   Example `rollup.config.mjs`:
+
+   ```js
+   import rollupBuilder from '@haixing_hu/rollup-builder';
+
+   export default rollupBuilder('MyLibrary', import.meta.url);
+   ```
+
+2. Customize the `rollup.config.mjs` file to match your library's specific 
+   requirements. You can specify the input file, formats, filename prefix, and 
+   other options. Refer to the [Configuration Options](#configuration) section
+   for more details.
+
+   Example `rollup.config.mjs`:
+    
+   ```js
+   import rollupBuilder from '@haixing_hu/rollup-builder';
+    
+   export default rollupBuilder('MyLibrary', import.meta.url, {
+     formats: ['cjs', 'esm'],
+     minify: true,
+     // Customize additional options as needed.
+   });
+   ```
+
+3. Run the [Rollup] build process using the following command:
+
+   ```bash
+   rollup -c rollup.config.mjs
+   ```
+
+4. The resulting library files will be placed in the `dist` directory, following 
+   the format you specified. For example, if you specified `formats: ['cjs', 'esm']`,
+   the following files will be generated:
+   ```bash
+    dist/my-library.cjs.js
+    dist/my-library.cjs.min.js
+    dist/my-library.esm.mjs
+    dist/my-library.esm.min.mjs
+   ```
+   
+5. You should modify your `package.json` file to specify the entry point of your
+   library. For example, if you specified `formats: ['cjs', 'esm']`, you should
+   add the following lines to your `package.json` file:
+   ```json
+   {
+     "main": "dist/my-library.cjs.min.js",
+     "module": "dist/my-library.esm.min.mjs",
+     "exports": {
+         ".": {
+            "require": "./dist/my-library.cjs.min.js",
+            "import": "./dist/my-library.esm.min.mjs"
+         }
+     }
+   }
+   ``` 
+6. You should add the following dev dependencies to your library:
+   ```bash
+   yarn add --dev @babel/core @babel/plugin-transform-runtime @babel/preset-env \
+     @rollup/plugin-alias @rollup/plugin-babel @rollup/plugin-commonjs \
+     @rollup/plugin-node-resolve @rollup/plugin-terser rollup rollup-plugin-analyzer
+   ```
+   or 
+   ```bash
+   npm install -D @babel/core @babel/plugin-transform-runtime @babel/preset-env \
+     @rollup/plugin-alias @rollup/plugin-babel @rollup/plugin-commonjs \
+     @rollup/plugin-node-resolve @rollup/plugin-terser rollup rollup-plugin-analyzer
+   ```
+
+## <span id="configuration">Configuration Options</span>
+
+- `libraryName: string`: The name of your library (used in the UMD format).
+- `importMetaUrl: string`: The `import.meta.url` of the caller module.
+- `options: object`: Additional build options, including:
+    - `debug: boolean`: Whether to print debug information. If this field is not
+      specified, the default value is `false`.
+    - `formats: [string]`: An array of formats to build. It can be an array 
+      of the following values:
+        - `'cjs'`: the CommonJS format.
+        - `'umd'`: the UMD format.
+        - `'esm'`: the ES module format.
+      
+      If this field is not specified, the default value is `['cjs', 'esm']`.
+    - `exports: string`: the export mode to use. It can be one of the following
+      values:
+        - `'auto'`: automatically guesses your intentions based on what the 
+          input module exports.
+        - `'default'`: if you are only exporting one thing using
+          `export default ...`; note that this can cause issues when generating 
+          CommonJS output that is meant to be interchangeable with ESM output.
+        - `'named'`: if you are using named exports.
+        - `'none'`: if you are not exporting anything (e.g. you are building an
+          app, not a library)
+        - `'mixed'`: if you are using named exports mixed with a default export.
+          Note that this is not a standard exports mode officially supported by
+          [Rollup], instead, it is an additional mode add by this library.
+          Refer to the [Mixing Default and Named Exports](#mix-default-named) for
+          more details.
+      
+      If this field is not specified, the default value is `'auto'`.
+    - `nodeEnv: string`: The `NODE_ENV` environment variable. If this field is 
+      not specified, the default value is `process.env.NODE_ENV`.
+    - `minify: boolean`: Whether to minify the code. If this field is not 
+      specified, the default value will be `true` for production environment, 
+      and `false` otherwise.
+    - `sourcemap: boolean`: Whether to generate sourcemaps. If this field is not
+      specified, the default value is `true`.
+    - `input: string`: The input file of the library. If this field is not
+      specified, the default value is `src/index.js`.
+    - `outputDir: string`: The output directory of the library. If this field 
+      is not specified, the default value is `dist`.
+    - `filenamePrefix: string`: The prefix for the output filename. If this 
+      field is not specified, the default value the dash-case of the library 
+      name.
+    - `externals: [string]`: the additional external packages, each can be 
+      specified with either a string or a regular expression. If this field is
+      not specified, the default value is an empty array.
+    - `useAliasPlugin: boolean`: whether to use the `@rollup/plugin-alias` 
+      plugin. If this field is not specified, the default value is `true`.
+    - `aliasPluginOptions: object`: the options for the `@rollup/plugin-alias` 
+      plugin. If this field is not specified, the default value is:
+      ```js
+      {
+        entries: {
+          'src': fileURLToPath(new URL('src', importMetaUrl)),
+        },
+      }
+      ```
+    - `useNodeResolvePlugin: boolean`: whether to use the `@rollup/plugin-node-resolve`
+      plugin. If this field is not specified, the default value is `true`.
+    - `nodeResolvePluginOptions: object`: the options for the `@rollup/plugin-node-resolve`
+      plugin. If this field is not specified, the default value is: `{}`.
+    - `useCommonjsPlugin: boolean`: whether to use the `@rollup/plugin-commonjs` plugin.
+      If this field is not specified, the default value is `true`.
+    - `commonjsPluginOptions: object`: the options for the `@rollup/plugin-commonjs`
+      plugin. If this field is not specified, the default value is:
+      ```js
+      {
+        include: ['node_modules/**']
+      }
+      ```
+    - `useBabelPlugin: boolean`: whether to use the `@rollup/plugin-babel` plugin.
+      If this field is not specified, the default value is `true`.
+    - `babelPluginOptions: object`: the options for the `@rollup/plugin-babel` plugin.
+      If this field is not specified, the default value is:
+      ```js
+      {
+        babelHelpers: 'runtime',
+        exclude: ['node_modules/**'],
+        presets: [
+          '@babel/preset-env',
+        ],
+        plugins: [
+          '@babel/plugin-transform-runtime',
+        ]
+      }
+      ```
+      Note that if use the `@rollup/plugin-babel` plugin, you can also specify
+      the configuration of Babel in the standard Babel configuration files,
+      such as `babel.config.js`, `.babelrc`, etc.
+    - `terserOptions: object`: the options for the `@rollup/plugin-terser` plugin.
+      If this field is not specified, the default value is: `{}`. Whether
+      to use the `@rollup/plugin-terser` plugin depends on the `minify`
+      field of the options or the `NODE_ENV` environment variable.
+    - `useAnalyzerPlugin: boolean`: whether to use the `rollup-plugin-analyzer` plugin.
+      If this field is not specified, the default value is `true`.
+    - `analyzerOptions: object`: the options for the `rollup-plugin-analyzer` plugin.
+      If this field is not specified, the default value is:
+      ```js
+      {
+        hideDeps: true,
+        limit: 0,
+        summaryOnly: true,
+      }
+      ```
+    - `useVisualizerPlugin: boolean`: whether to use the `rollup-plugin-visualizer` plugin.
+      If this field is not specified, the default value is `true`.
+    - `visualizerPluginOptions: object`: the options for the `rollup-plugin-visualizer` plugin.
+      If this field is not specified, the default value is:
+      ```js
+      {
+        filename: './doc/${filenameBase}.visualization.html',
+        gzipSize: true,
+        brotliSize: true,
+      }
+      ```
+      where the `filenameBase` is the basename of the compiled library file in the
+      `./dist` directory.
+    - `plugins: [object]`: the additional [Rollup] plugins. If this field is not
+      specified, the default value is an empty array.
+
+## <span id="mix-default-named">Mixing Default and Named Exports</span>
+
+If an ESM module has both default export and named exports, [Rollup] cannot
+handle it correctly. For example, the following is a source ESM module:
+```js
+export { Foo, Bar };
+export default Foo;
+```
+The rollup will translate it into the following codes:
+```js
+exports.Foo = Foo;
+exports.Bar = Bar;
+exports.default = Foo;
+```
+However, a common-js consumer will use the module as follows:
+```js
+const Foo = require('my-module');
+```
+which will cause an error. The correct usage should be
+```js
+const Foo = require('my-module').default
+```
+But unfortunately, [Rollup] will translate the ESM default import as follows:
+```js
+// source
+import Foo from 'my-module';
+
+// translated
+const Foo = require('my-module');
+```
+Note that the above translation has no `.default` suffix, which will cause an error.
+
+If you mix default and named exports in an ESM module, [Rollup] will generate
+a warning message as follows:
+```bash
+(!) Mixing named and default exports
+https://rollupjs.org/configuration-options/#output-exports
+The following entry modules are using named and default exports together:
+src/index.js
+
+Consumers of your bundle will have to use chunk.default to access their default export, which may not be what you want. Use `output.exports: "named"` to disable this warning.
+```
+
+The workaround is copied from the [source code of the official rollup plugins].
+It makes the rollup option `output.exports` to `'named'` and adds a simple footer 
+statements to each `CJS` format bundle:
+```js
+module.exports = Object.assign(exports.default, exports);
+```
+With this workaround, [Rollup] will transform mixed exports into the following form:
+```js
+exports.Foo = Foo;
+exports.Bar = Bar;
+exports.default = Foo;
+module.exports = Object.assign(exports.default, exports);
+```
+Thus, the caller can directly use the following methods to import the default export:
+```js
+const Foo = require('my-module');
+// or
+import Foo from 'my-module';
+```
+
+See the following web pages for more details:
+- [Rollup Configuration Options: output.exports]
+- [Issue #1961: Question regarding mixing default and named exports]
+- [StackOverflow: Mixing default and named exports with Rollup]
+- [Github Repository: rollup-patch-seamless-default-export]
+
+**NOTE:** In order to use this feature, you must specify the `exports` option to
+`'mixed'` in the `rollup.config.mjs` file, i.e.,
+```js
+import rollupBuilder from '@haixing_hu/rollup-builder';
+
+export default rollupBuilder('MyLibrary', import.meta.url, { exports: 'mixed' });
+```
+
+## <span id="contributions">Contributions</span>
+
+Contributions are welcome! If you find any issues or have suggestions for
+improvements, please feel free to open an issue or create a pull request.
+
+## <span id="license">License</span>
+
+This project is licensed under the Apache 2.0 License. 
+See the [LICENSE](LICENSE) file for details.
+
+
+[Rollup]: https://rollupjs.org/
+[source code of the official rollup plugins]: https://github.com/rollup/plugins/blob/master/shared/rollup.config.mjs
+[Rollup Configuration Options: output.exports]: https://rollupjs.org/configuration-options/#output-exports
+[Issue #1961: Question regarding mixing default and named exports]: https://github.com/rollup/rollup/issues/1961
+[StackOverflow: Mixing default and named exports with Rollup]: https://stackoverflow.com/questions/58246998/mixing-default-and-named-exports-with-rollup
+[Github Repository: rollup-patch-seamless-default-export]: https://github.com/avisek/rollup-patch-seamless-default-export