shebang-regex

What is shebang-regex?

The shebang-regex npm package is a simple utility that provides a regular expression for matching shebang lines in files. A shebang line is the first line in a script file that is used to indicate the script interpreter to be used to execute the file. It is commonly found at the top of script files in Unix-based systems and starts with '#!'. This package helps in identifying and extracting the shebang line from files.

What are shebang-regex's main functionalities?

Shebang line matching

The shebang-regex package exports a regular expression that matches the shebang line. Here's an example of how to use it in code to test if a string contains a shebang line: `const shebangRegex = require('shebang-regex'); console.log(shebangRegex.test('#!/usr/bin/env node')); // true`

/^#!.+/

Other packages similar to shebang-regex

shebang-command

The shebang-command package is similar to shebang-regex in that it is used to parse the shebang line from a file or string. However, it goes a step further by specifically extracting the command after the shebang. This can be useful for determining the interpreter that the script is intended to be run with.

README

shebang-regex

Regular expression for matching a shebang line

Install

$ npm install shebang-regex

Usage

import shebangRegex from 'shebang-regex';

const string = '#!/usr/bin/env node\nconsole.log("unicorns");';

shebangRegex.test(string);
//=> true

shebangRegex.exec(string)[0];
//=> '#!/usr/bin/env node'

shebangRegex.exec(string)[1];
//=> '/usr/bin/env node'

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}