@pirxpilot/exorcist

v2.0.0

Externalizes the source map found inside a stream to an external `.js.map` file For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

Package Health Score

45 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.0.0	\|	06/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

No

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (2)

GitHub Stars: 0
Forks: 0
Contributors: 20

Direct Usage Popularity

The npm package @pirxpilot/exorcist receives a total of 2 downloads a week. As such, we scored @pirxpilot/exorcist popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @pirxpilot/exorcist, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @pirxpilot/exorcist repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @pirxpilot/exorcist is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 5 years ago
Last Commit: 5 years ago

Further analysis of the maintenance status of @pirxpilot/exorcist based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @pirxpilot/exorcist is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 4 Direct
Versions: 2
Install Size: 15.7 kB
Dist-tags: 1
# of Files: 8
Maintainers: 1
TS Typings: No

@pirxpilot/exorcist has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

This is a fork of exorcist package. It updates dependencies and fixes splitting surrogate pairs bug.

exorcist

Externalizes the source map found inside a stream to an external .map file or stream.

Works with both JavaScript and CSS input streams.

var browserify = require('browserify')
  , path       = require('path')
  , fs         = require('fs')
  , exorcist   = require('exorcist')
  , mapfile    = path.join(__dirname, 'bundle.js.map')

// from a file, to a file, and send source map to its own file
browserify({debug: true})
  .require(require.resolve('./main'), { entry: true })
  .bundle()
  .pipe(exorcist(mapfile))
  .pipe(fs.createWriteStream(path.join(__dirname, 'bundle.js'), 'utf8'))

//  from a stream, to a stream, and send source map to a stream
browserify([readableSourceStream], browserifyOptions)
  .bundle()
  .pipe(exorcist(targetSourceMapStream, '/url/path/to/replace/source/comment/with/bundle.js'))
  .pipe(writableTargetStream)

command line example

browserify main.js --debug | exorcist bundle.js.map &gt; bundle.js

Table of Contents generated with DocToc

Usage

exorcist map_file [options]

  Externalizes the source map of the file streamed in.

  The source map is written as JSON to map_file, and the original file is streamed out with its
  sourceMappingURL set to the path of map_file (or to the value of the --url option).

OPTIONS:

              --base -b   Base path for calculating relative source paths.
                          (default: use absolute paths)

              --root -r   Root URL for loading relative source paths.
                          Set as sourceRoot in the source map.
                          (default: '')

               --url -u   Full URL to source map.
                          Set as sourceMappingURL in the output stream.
                          (default: map_file)

  --error-on-missing -e   Abort with error if no map is found in the stream.
                          (default: warn but still pipe through source)

EXAMPLE:

  Bundle main.js with browserify into bundle.js and externalize the map to bundle.js.map.

    browserify main.js --debug | exorcist bundle.js.map &gt; bundle.js

Installation

npm install exorcist

API

exorcist(input, url, root, base, errorOnMissing) → {TransformStream}

Externalizes the source map of the file streamed in.

The source map is written as JSON to file, and the original file is streamed out with its sourceMappingURL set to the path of file (or to the value of url).

Events (in addition to stream events)

missing-map emitted if no map was found in the stream and errorOnMissing is falsey (the src is still piped through in this case, but no map file is written)

Parameters:

Name	Type	Argument	Description
`input`	String / Object		full path to the map file to which to write the extracted source map or a writable stream
`url`	String	<optional>	full URL to the map file, set as `sourceMappingURL` in the streaming output (default: file)
`root`	String	<optional>	root URL for loading relative source paths, set as `sourceRoot` in the source map (default: '')
`base`	String	<optional>	base path for calculating relative source paths (default: use absolute paths)
`errorOnMissing`	Boolean	<optional>	when truthy, causes 'error' to be emitted instead of 'missing-map' if no map was found in the stream (default: falsey)

Source:

index.js , lineno 33

Returns:

transform stream into which to pipe the code containing the source map

Type: TransformStream

generated with docme

Integration with other tools

using exorcist with gulp

License

MIT

@pirxpilot/exorcist dependencies

convert-source-map is-stream minimist through2

@pirxpilot/exorcist development dependencies

browserify jshint proxyquire tap

FAQs

What is @pirxpilot/exorcist?

Externalizes the source map found inside a stream to an external `.js.map` file. Visit Snyk Advisor to see a full health score report for @pirxpilot/exorcist, including popularity, security, maintenance & community analysis.

Is @pirxpilot/exorcist popular?

The npm package @pirxpilot/exorcist receives a total of 2 weekly downloads. As such, @pirxpilot/exorcist popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @pirxpilot/exorcist well maintained?

We found indications that @pirxpilot/exorcist is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @pirxpilot/exorcist safe to use?

The npm package @pirxpilot/exorcist was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 4 November-2024, at 16:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected