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-shebang-bin

v0.0.7

Published

Richly configurable rollup plugin for preserving or inserting shebang (hashbang) and making scripts executable.

Downloads

3,764

Readme

rollup-plugin-shebang-bin

Latest version Dependency status Coverage

Richly configurable Rollup plugin for preserving or inserting shebang (hashbang) and making scripts executable.

Requirements

This plugin requires Node.js 14 or newer and Rollup 2 or newer.

Installation

This module can be installed in your project using NPM, PNPM or Yarn. Make sure, that you use Node.js version 6 or newer.

npm i -D rollup-plugin-shebang-bin
pnpm i -D rollup-plugin-shebang-bin
yarn add rollup-plugin-shebang-bin

Usage

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

import shebang from 'rollup-plugin-shebang-bin'

export default {
  input: 'src/cli.js',
  output: {
    dir: 'bin',
    format: 'cjs'
  },
  plugins: [shebang()]
}

Then call rollup either via the command-line or programmatically.

The file bin/cli.js will be executable with the following content:

#!/usr/bin/env node

... // content of src/cli.js

Options

The following options can be passed in an object to the plugin function to change the default values.

include

Type: Array<String> Default: ['**/*.js']

Pattern to match files which will be processed by the plugin.

exclude

Type: Array<String> Default: []

Pattern to match files which will be ignored by the plugin.

regexp

Type: RegExp Default: /^\s*#!.*\n*/

The regular expression to match the shebang at the beginning of an input file.

shebang

Type: String Default: '#!/usr/bin/env node'

The shebang to insert to the beginning of an output file.

separator

Type: String Default: '\n\n'

The whitespace to insert after the shebang to separate if from the rest of an output file.

mode

Type: Number Default: 0o755

The permissions to apply to an output file. The value will be masked by the process umask.

insert

Type: Boolean Default: true

If the shebang will be inserted to an output file.

preserve

Type: Boolean Default: true

If an existing shebang will be preserved in an output file.

If you set preserve to false and insert to true, the existing shebang will be removed and a new one inserted to an output file.

executable

Type: Boolean Default: true

If an output file should become executable permissions.

License

Copyright (C) 2022-2024 Ferdinand Prantl

Licensed under the MIT License.