Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add npm-shrinkwrap.json usage #73

Merged
merged 2 commits into from Mar 1, 2020
Merged

Add npm-shrinkwrap.json usage #73

merged 2 commits into from Mar 1, 2020

Conversation

drazisil
Copy link
Contributor

@drazisil drazisil commented Mar 1, 2020

Description

  • Add usage example for npm-shrinkwrap.json
  • Add note about no output === success

Types of changes

  • Docs clarification (non-breaking change which improves usibility)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Related Issue

None

Motivation and Context

Prevents users from hitting this error:

ABORTING lockfile lint process due to error exceptions 

Unable to find relevant lockfile parser for "npm-shrinkwrap.json", consider passing the --type option. 

Error
    at new ParsingError (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/node_modules/lockfile-lint-api/src/common/ParsingError.js:27:33)
    at ParseLockfile.parseSync (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/node_modules/lockfile-lint-api/src/ParseLockfile.js:53:13)
    at ValidateHostManager (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/src/validators/index.js:40:27)
    at validators.forEach.validator (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/src/main.js:35:28)
    at Array.forEach (<anonymous>)
    at Object.runValidators (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/src/main.js:25:14)
    at Object.<anonymous> (/home/drazisil/.npm/_npx/12990/lib/node_modules/lockfile-lint/bin/lockfile-lint.js:31:17)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32) 

error: command failed with exit code 1 

How Has This Been Tested?

Confirmed the error does not occur when passing the --type flag

Screenshots (if appropriate):

Checklist:

  • [ x] I have updated the documentation (if required).
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • [x ] All new and existing tests passed.
  • [x ] I added a picture of a cute animal cause it's fun

image
Photo Credit: https://unsplash.com/photos/YyEotvsoOXs

Also add note about no output === success
@codecov-io
Copy link

codecov-io commented Mar 1, 2020

Codecov Report

Merging #73 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #73   +/-   ##
=======================================
  Coverage   95.08%   95.08%           
=======================================
  Files          11       11           
  Lines         183      183           
  Branches       29       29           
=======================================
  Hits          174      174           
  Misses          8        8           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e894df...34c8b59. Read the comment docs.

@lirantal
Copy link
Owner

lirantal commented Mar 1, 2020

Thanks a bunch @drazisil ❤️
Minor typo correction and we'll land this in

@drazisil
Copy link
Contributor Author

drazisil commented Mar 1, 2020

Minor typo correction and we'll land this in

What typo correction?

README.md Outdated Show resolved Hide resolved
@lirantal
Copy link
Owner

lirantal commented Mar 1, 2020

What typo correction?

Silly me. Forgot to submit the review. See now.

Co-Authored-By: Liran Tal <liran.tal@gmail.com>
@lirantal lirantal self-requested a review March 1, 2020 22:59
@lirantal lirantal merged commit 8e3cdbe into lirantal:master Mar 1, 2020
@drazisil drazisil deleted the patch-1 branch March 1, 2020 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants