crookedneighbor / npm-unpack Goto Github PK

A module to pack and unpack your modules.

JavaScript 92.96% TypeScript 7.04%

npm-unpack's Introduction

npm-unpack

Easilly pack and unpack your npm modules to see what files are being included when you npm publish

Usage

cd /path/to/npm/module
npx npm-unpack

You'll see something like this:

Packing [email protected]...

Number of files: 6

package.json
lib/foo.js
lib/bar.js
lib/baz.js
test/file/that/should/not/be/included.js
bin/your-module.js

If you have a file that shouldn't be included (such as the test file above), just add it to your .npmignore file and re-run npm-unpack

# .npmignore
test/*

Re-run npm-unpack to verify:

npx npm-unpack

And see that now only our source files are included!

Packing [email protected]...

Number of files: 5

package.json
lib/foo.js
lib/bar.js
lib/baz.js
bin/your-module.js

Automated Tests

The tests are written using vitest.

To run them:

npm test

npm-unpack's People

Contributors

Stargazers

Watchers

Forkers

mikesamuel

npm-unpack's Issues

Warn about common files that should probably be ignored

dotfiles
test/spec directories
dist

tarFile argument is not shell escaped.

npm-unpack/lib/tar.js

Line 5 in 90fa078

exec('tar -tf ' + tarFile, function (err, stdout) {

calls child_process.exec in shell mode, so a tarfile path that includes shell meta characters will break.

Specifically, a tarfile path like "/dev/null; ls -l /etc/passwd" will execute ls -l /etc/passwd and collect its output into stdout.

An in-range update of mocha is breaking the build 🚨

The devDependency mocha was updated from `6.0.2` to `6.1.0`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

mocha is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Release Notes for v6.1.0

6.1.0 / 2019-04-07

🔒 Security Fixes

#3845: Update dependency "js-yaml" to v3.13.0 per npm security advisory (@plroebuck)

🎉 Enhancements

#3766: Make reporter constructor support optional options parameter (@plroebuck)
#3760: Add support for config files with .jsonc extension (@sstephant)

📠 Deprecations

These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:

#3719: Deprecate this.skip() for "after all" hooks (@juergba)

🐛 Fixes

#3829: Use cwd-relative pathname to load config file (@plroebuck)
#3745: Fix async calls of this.skip() in "before each" hooks (@juergba)
#3669: Enable --allow-uncaught for uncaught exceptions thrown inside hooks (@givanse)

and some regressions:

#3848: Fix Suite cloning by copying root property (@fatso83)
#3816: Guard against undefined timeout option (@boneskull)
#3814: Update "yargs" in order to avoid deprecation message (@boneskull)
#3788: Fix support for multiple node flags (@aginzberg)

📖 Documentation

mochajs/mocha-examples: New repository of working examples of common configurations using mocha (@craigtaub)
#3850: Remove pound icon showing on header hover on docs (@jd2rogers2)
#3812: Add autoprefixer to documentation page CSS (@Munter)
#3811: Update doc examples "tests.html" (@DavidLi119)
#3807: Mocha website HTML tweaks (@plroebuck)
#3793: Update config file example ".mocharc.yml" (@cspotcode)

🔩 Other

#3830: Replace dependency "findup-sync" with "find-up" for faster startup (@cspotcode)
#3799: Update devDependencies to fix many npm vulnerabilities (@XhmikosR)

Commits

The new version differs by 28 commits.

f4fc95a Release v6.1.0
bd29dbd update CHANGELOG for v6.1.0 [ci skip]
aaf2b72 Use cwd-relative pathname to load config file (#3829)
b079d24 upgrade deps as per npm audit fix; closes #3854
e87c689 Deprecate this.skip() for "after all" hooks (#3719)
81cfa90 Copy Suite property "root" when cloning; closes #3847 (#3848)
8aa2fc4 Fix issue 3714, hide pound icon showing on hover header on docs page (#3850)
586bf78 Update JS-YAML to address security issue (#3845)
d1024a3 Update doc examples "tests.html" (#3811)
1d570e0 Delete "/docs/example/chai.js"
ade8b90 runner.js: "self.test" undefined in Browser (#3835)
0098147 Replace findup-sync with find-up for faster startup (#3830)
d5ba121 Remove "package" flag from sample config file because it can only be passes as CLI arg (#3793)
a3089ad update package-lock
75430ec Upgrade yargs-parser dependency to avoid loading 2 copies of yargs

There are 28 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

An in-range update of sinon is breaking the build 🚨

Version 4.1.4 of sinon was just published.

Branch	Build failing 🚨
Dependency	sinon
Current Version	4.1.3
Type	devDependency