Skip to content
This repository has been archived by the owner on Feb 12, 2025. It is now read-only.

antfu/are-we-esm

Repository files navigation

Deprecated: use node-modules-inspector instead.


are-we-esm

npm version npm downloads bundle JSDocs License

CLI to check your project's ESM support status

Screenshot

Usage

Run the following command in your project root:

pnpx are-we-esm

Note

Only works with pnpm projects

Options

  • --simple - Simplified the module type to CJS and ESM. Consider DUAL as ESM, FAUX as CJS (default: false)
  • --prod - Check only the production dependencies
  • --dev - Check only the development dependencies
  • --exclude - Exclude packages from the check, e.g. --exclude="eslint,eslint-*,@eslint/*"
  • --all - Print all packages, including those that are ESM compatible (default: false)
  • --list - Print the flat list of packages, instead of tree (default: false)
  • --depth - Limit the depth search of the tree (default: 25)

TODOs

  • Add progress bar
  • Cache the result to disk
  • Improve --prod flag by traversing the tree
  • Support exclude list
  • Summary how top-level packages are contribute to ESM support
  • Web UI

Sponsors

Credits

Thanks to the following projects and their authors for inspiration:

License

MIT License © 2025-PRESENT Anthony Fu