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-velcro

v0.1.1

Published

A Rollup plugin to to resolve and read dependencies straight from the cloud using Velcro

Downloads

6

Readme

npm size

rollup-plugin-velcro

👟 A Rollup plugin to to resolve and read dependencies straight from the cloud ☁ using Velcro.

Requirements

This plugin must be configured with an http request function having a signature of (href: string) => Promise<ArrayBuffer>.

When running in the browser or environments other than Node.js, an promisified fs-equivalent must be provided that implements:

type Dirent = {
  isFile(): boolean;
  isDirectory(): boolean;
  name: string;
};

interface FsInterface {
  readdir(
    path: string,
    options: {
      encoding: 'utf-8';
      withFileTypes: true;
    }
  ): Promise<Dirent[]>;
  readFile(path: string): Promise<ArrayBuffer>;
  realpath(path: string): Promise<string>;
}

Install

Using npm:

npm install rollup-plugin-velcro --save-dev

Usage

Create a rollup.config.js configuration file and import the plugin:

import velcro from 'rollup-plugin-velcro';

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

Then call rollup either via the CLI or the API.

Options

cdn

Type: 'jsDelivr' | 'unpkg' Default: 'jsDelivr'

Selects the CDN that will be used for resolving and reading the files.

debug

Type: boolean Default: false

Opt into verbose logging of velcro resolver operations.

extensions

Type: string[] Default: [".js", ".json", ".mjs", ".cjs"]

An ordered list of file extensions that will be consulted for resolving dependencies between modules that don't specify the extension.

fs

Type: import('fs') Default: require('fs')

An implementation of the promisified fs interface that will be used for reading local files.

packageMain

Type: ('browser' | 'main' | 'module')[] Default: ["module", "main"]

An ordered list of package.json fields that will be consulted when resolving the default file of an npm module.

Note: This should fully support the sementics of browser overrides and exclusions.

Using with @rollup/plugin-commonjs

Since most packages in your node_modules folder are probably legacy CommonJS rather than JavaScript modules, you may need to use @rollup/plugin-commonjs:

// rollup.config.js
import resolve from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';

export default {
  input: 'main.js',
  output: {
    file: 'bundle.js',
    format: 'iife',
    name: 'MyModule',
  },
  plugins: [resolve(), commonjs()],
};

Resolving Built-Ins (like fs)

This plugin won't resolve any builtins (e.g. fs). If you need to resolve builtins you can install local modules and set preferBuiltins to false, or install a plugin like rollup-plugin-node-polyfills which provides stubbed versions of these methods.

If you want to silence warnings about builtins, you can add the list of builtins to the externals option; like so:

import resolve from '@rollup/plugin-node-resolve';
import builtins from 'builtin-modules'
export default ({
  input: ...,
  plugins: [resolve()],
  external: builtins,
  output: ...
})

Meta

LICENSE (MIT)