lirantal / lockfile-lint

Lint an npm or yarn lockfile to analyze and detect security issues
Apache License 2.0
785 stars 35 forks source link

docs: fix casing of ParseLockfile in example code for lockfile-lint-api #38

Closed jonchurch closed 4 years ago

jonchurch commented 4 years ago

Fix the example code for lockfile-lint-api. As it currently is, it fails because the casing of ParseLockfile is incorrect in the example. Seems the docs weren't updated after the casing change occurred in the project.

Description

Change casing from ParseLockFile to ParseLockfile

Types of changes

Related Issue

closes #37

Checklist:

baby_yoda

codecov-io commented 4 years ago

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #38   +/-   ##
=======================================
  Coverage   97.81%   97.81%           
=======================================
  Files          11       11           
  Lines         183      183           
  Branches       26       26           
=======================================
  Hits          179      179           
  Misses          4        4

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 acbdc9a...bddf2da. Read the comment docs.

lirantal commented 4 years ago

Great catch and spot-on picture ✨ Thanks Jonathan!