npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rollup-plugin-cjs-check

v1.0.3

Published

Rollup plugin to automatically check the exports of a library for cjs-module-lexer compatibility.

Downloads

877

Readme

rollup-plugin-cjs-check

A Rollup plugin for checking CommonJS exports against cjs-module-lexer.

Why?

As Node.js defines it, CommonJS modules consist of a module.exports object which can be of any type. When importing a CommonJS, while Node.js is in ESM mode, a CommonJS module will always be reliably importable via a default import.

For modern modules, it's common to use Rollup to bundle and build both CommonJS and ECMAScript Modules (ESM) outputs for any given module. This means that to achieve compatibility between both modules either requires the module to only have a default-export, or to rely on Node.js' compatibility mode.

For better compatibility, Node.js attempts to detect the CommonJS exports of every CommonJS module that's exported. Since sometimes, especially in legacy CommonJS mode, the import of a given CommonJS module built with Rollup cannot be prevented entirely, the module has to be compatible with cjs-module-lexer.

The cjs-module-lexer library is what Node.js uses to detect exports of a given CommonJS module and hence, when choosing how to configure Rollup, the Rollup bundle outputs have to be compatible with it, or otherwise, the module's exports won't be detected.

This plugin checks that cjs-module-lexer agrees with the ECMAScript modules exports that Rollup detects.

For more information, check out the Node.js documentation on CommonJS namespaces.

Requirements

This plugin requires an LTS Node version (v14.0.0+) and Rollup v1.20.0+.

Install

npm install --save-dev rollup-plugin-cjs-check
# or
yarn add -D rollup-plugin-cjs-check
# or
pnpm add --save-dev rollup-plugin-cjs-check

Usage

Import the rollup-plugin-cjs-check plugin in your Rollup configuration file, and add it to your plugins:

import cjsCheck from 'rollup-plugin-cjs-check';

export default {
  input: 'src/index.js',
  output: {
    dir: 'output',
    format: 'cjs'
  },
  plugins: [
    cjsCheck(),
  ]
};