Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xunnamius/babel-plugin-metadata-accumulator

⚡ A babel plugin that collects and returns metadata from input files
https://github.com/xunnamius/babel-plugin-metadata-accumulator

babel collection imports metadata plugin

Last synced: 1 day ago
JSON representation

⚡ A babel plugin that collects and returns metadata from input files

Awesome Lists containing this project

README 

        





  







A babel plugin that collects and returns metadata from input files












[![Black Lives Matter!][x-badge-blm-image]][x-badge-blm-link]

[![Last commit timestamp][x-badge-lastcommit-image]][x-badge-repo-link]

[![Codecov][x-badge-codecov-image]][x-badge-codecov-link]

[![Source license][x-badge-license-image]][x-badge-license-link]

[![Uses Semantic Release!][x-badge-semanticrelease-image]][x-badge-semanticrelease-link]



[![NPM version][x-badge-npm-image]][x-badge-npm-link]

[![Monthly Downloads][x-badge-downloads-image]][x-badge-downloads-link]










# babel-plugin-metadata-accumulator



A babel plugin that collects and returns metadata from input files.



---



- [Install](#install)

- [Usage](#usage)

- [Appendix](#appendix)

  - [Published Package Details](#published-package-details)

  - [License](#license)

- [Contributing and Support](#contributing-and-support)

  - [Contributors](#contributors)







## Install



To install:



```shell

npm install babel-plugin-metadata-accumulator

```



## Usage



TODO



## Appendix



Further documentation can be found under [`docs/`][x-repo-docs].



### Published Package Details



This is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports

built by Babel for use in Node.js versions that are not end-of-life. For

TypeScript users, this package supports both `"Node10"` and `"Node16"` module

resolution strategies.



Expand details



That means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`

or `await import(...)`) source will load this package from the same entry points

when using Node. This has several benefits, the foremost being: less code

shipped/smaller package size, avoiding [dual package

hazard][x-pkg-dual-package-hazard] entirely, distributables are not

packed/bundled/uglified, a drastically less complex build process, and CJS

consumers aren't shafted.



Each entry point (i.e. `ENTRY`) in [`package.json`'s

`exports[ENTRY]`][x-repo-package-json] object includes one or more [export

conditions][x-pkg-exports-conditions]. These entries may or may not include: an

[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type

declaration file for TypeScript and IDEs, a

[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to

(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or

`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js

`require`/`import` and for browsers and other environments, and [other

conditions][x-pkg-exports-conditions] not enumerated here. Check the

[package.json][x-repo-package-json] file to see which export conditions are

supported.



Note that, regardless of the [`{ "type": "..." }`][x-pkg-type] specified in

[`package.json`][x-repo-package-json], any JavaScript files written in ESM

syntax (including distributables) will always have the `.mjs` extension. Note

also that [`package.json`][x-repo-package-json] may include the

[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for

optimal [tree shaking][x-pkg-tree-shaking] where appropriate.



### License



See [LICENSE][x-repo-license].



## Contributing and Support



**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]

are always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟

this project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy

me a beer][x-repo-sponsor], I'd appreciate it. Thank you!



See [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for

more information.



### Contributors



[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)



Thanks goes to these wonderful people ([emoji

key][x-repo-all-contributors-emojis]):



  

    

      Bernard
Bernard
🚇 💻 📖 🚧 ⚠️ 👀

    

  

  

    

      

        

          Add your contributions

        

      

    

  



This project follows the [all-contributors][x-repo-all-contributors]

specification. Contributions of any kind welcome!



[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!'

[x-badge-blm-link]: https://xunn.at/donate-blm

[x-badge-codecov-image]:

  https://img.shields.io/codecov/c/github/Xunnamius/babel-plugin-metadata-accumulator/main?style=flat-square&token=HWRIOBAAPW&flag=package.main_root

  'Is this package well-tested?'

[x-badge-codecov-link]:

  https://codecov.io/gh/Xunnamius/babel-plugin-metadata-accumulator

[x-badge-downloads-image]:

  https://img.shields.io/npm/dm/babel-plugin-metadata-accumulator?style=flat-square

  'Number of times this package has been downloaded per month'

[x-badge-downloads-link]:

  https://npmtrends.com/babel-plugin-metadata-accumulator

[x-badge-lastcommit-image]:

  https://img.shields.io/github/last-commit/Xunnamius/babel-plugin-metadata-accumulator?style=flat-square

  'Latest commit timestamp'

[x-badge-license-image]:

  https://img.shields.io/npm/l/babel-plugin-metadata-accumulator?style=flat-square

  "This package's source license"

[x-badge-license-link]:

  https://github.com/Xunnamius/babel-plugin-metadata-accumulator/blob/main/LICENSE

[x-badge-npm-image]:

  https://xunn.at/npm-pkg-version/babel-plugin-metadata-accumulator

  'Install this package using npm or yarn!'

[x-badge-npm-link]: https://npm.im/babel-plugin-metadata-accumulator

[x-badge-repo-link]:

  https://github.com/Xunnamius/babel-plugin-metadata-accumulator

[x-badge-semanticrelease-image]:

  https://xunn.at/badge-semantic-release

  'This repo practices continuous integration and deployment!'

[x-badge-semanticrelease-link]:

  https://github.com/semantic-release/semantic-release

[x-pkg-cjs-mojito]:

  https://dev.to/jakobjingleheimer/configuring-commonjs-es-modules-for-nodejs-12ed#publish-only-a-cjs-distribution-with-property-exports

[x-pkg-dual-package-hazard]:

  https://nodejs.org/api/packages.html#dual-package-hazard

[x-pkg-exports-conditions]:

  https://webpack.js.org/guides/package-exports#reference-syntax

[x-pkg-exports-module-key]:

  https://webpack.js.org/guides/package-exports#providing-commonjs-and-esm-version-stateless

[x-pkg-exports-types-key]:

  https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta#packagejson-exports-imports-and-self-referencing

[x-pkg-side-effects-key]:

  https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free

[x-pkg-tree-shaking]: https://webpack.js.org/guides/tree-shaking

[x-pkg-type]:

  https://github.com/nodejs/node/blob/8d8e06a345043bec787e904edc9a2f5c5e9c275f/doc/api/packages.md#type

[x-repo-all-contributors]: https://github.com/all-contributors/all-contributors

[x-repo-all-contributors-emojis]: https://allcontributors.org/docs/en/emoji-key

[x-repo-choose-new-issue]:

  https://github.com/Xunnamius/babel-plugin-metadata-accumulator/issues/new/choose

[x-repo-contributing]: /CONTRIBUTING.md

[x-repo-docs]: docs

[x-repo-license]: ./LICENSE

[x-repo-package-json]: package.json

[x-repo-pr-compare]:

  https://github.com/Xunnamius/babel-plugin-metadata-accumulator/compare

[x-repo-sponsor]: https://github.com/sponsors/Xunnamius

[x-repo-support]: /.github/SUPPORT.md