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-config-module

v2.0.2

Published

Rollup config to create npm modules that support both ECMAScript module and CommonJS

Downloads

109

Readme

rollup-config-module

npm version Build Status Coverage Status

Rollup config to create npm modules that support both ECMAScript module and CommonJS

Installation

Use npm.

npm install --save-dev rollup-config-module

Usage

For module authors

  1. Include rollup --config=node:module to the build part of your module's npm scripts.
"scripts": {
  "build": "rollup --config=node:module",
  "pretest": "npm run-script build"
}
  1. Write your module using ECMAScript import / export instead of require / module.exports, and save it as index.mjs.
  2. Add module field to package.json and let it point to index.mjs.
"module": "index.mjs"
  1. Run the build script and you'll see index.js is created.
  2. Include both index.mjs and index.js to the published npm package.
"files": [
  "index.js",
  "index.mjs"
]

A real world example would help understanding how to create a package with rollup-config-module.

For module users

Modules built with this configuration can be used in both ES2015+ projects and traditional require-based projects.

Users can load index.mjs with a build tool that supports module field, for example rollup-plugin-node-resolve and Webpack.

import fn from 'awesome-npm-package';

Users can also load index.js via Node's built-in require,

const fn = require('awesome-npm-package');

because index.js has been compiled from index.mjs with all import and export replaced with require and module.exports.

import {inspect} from 'util';
import isNaturalNumber from 'is-natural-number';

export default function(v) {
  if (!isNaturalNumber(v)) {
    console.log(inspect(v) + 'is not a natural number.');
  }
}

'use strict';

var util = require('util');
var isNaturalNumber = require('is-natural-number');

module.exports = function(v) {
  if (!isNaturalNumber(v)) {
    console.log(util.inspect(v) + 'is not a natural number.');
  }
}

License

ISC License © 2018 Shinnosuke Watanabe