snyk-filter

v1.3.2

Module to consume json output from Snyk CLI for advanced filtering and results display For more information about how to use this package see README

Latest version published 1 year ago

License: ISC

NPM

GitHub

Package Health Score

42 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Limited

Security

Security review needed

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.3.2	\|	06/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.3	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	03/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

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

Small

Weekly Downloads (4,065)

GitHub Stars: 15
Forks: 28
Contributors: 6

Direct Usage Popularity

The npm package snyk-filter receives a total of 4,065 downloads a week. As such, we scored snyk-filter popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package snyk-filter, we found that it has been starred 15 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: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like snyk-filter is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 6
Open PR: 4
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of snyk-filter 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 snyk-filter 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: >=10

Age: 4 years
Dependencies: 10 Direct
Versions: 10
Install Size: 755 kB
Dist-tags: 1
# of Files: 27
Maintainers: 1
TS Typings: No

snyk-filter 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

Custom Filtering for Snyk CLI

snyk-filter takes the JSON outputted from the Snyk CLI, e.g. snyk test --json and applies custom filtering of the results, as well as options to fail your build.

This repository is in maintenance mode, no new features are being developed. Bug & security fixes will continue to be delivered. Open source contributions are welcome for small features & fixes (no breaking changes)

How do I use it?

Install

npm i -g snyk-filter

Note about `node-jq`

snyk-filter uses the node-jq library, which requires that a jq binary is installed. This typically happens transparently via npm install -g, but on some systems JQ does not get properly installed locally. If you receive an error after installation regarding node-jq, then jq should be installed manually to avoid this error.

# install jq ahead of time (ubuntu example)
sudo apt-get install -y jq

# tell node-jq to skip trying to install it on its own
export NODE_JQ_SKIP_INSTALL_BINARY=true

# tell node-jq where the existing jq binary is
export JQ_PATH=$(which jq)

# finally, install snyk-filter (does not work with node version > 12)
sudo npm install -g

Usage

Implement your custom JQ filters in a .snyk-filter/snyk.yml file relative to your current working directory where you will be running snyk test from (see in sample-filters and tweak things from there - use JQPlay )
Then pipe your snyk test --json output into snyk-filter or use the -i argument to input a json file. Use the -f argument to point to the yml file containing your custom filters if you are not using the default location (.snyk-filter/snyk.yml).
Return code of snyk-filter will be 0 for pass (no issues) and 1 for fail (issues found)

Example with Snyk CLI (using .snyk-filter/snyk.yml by default)

snyk test --json | snyk-filter

Example with Snyk CLI and custom yml file location

snyk test --json | snyk-filter -f /path/to/example-cvss-9-or-above.yml

Example

snyk-filter -i snyk_results.json

Example with custom yml file location

snyk-filter -i snyk_results.json -f /path/to/example-high-upgradeable-vulns.yml

Options

--json to output json

License

License: Apache License, Version 2.0

snyk-filter dependencies

@snyk/protect chalk debug is-relative js-yaml lodash minimist node-jq mkdirp cacheable-request

snyk-filter development dependencies

mocha prettier

FAQs

What is snyk-filter?

Module to consume json output from Snyk CLI for advanced filtering and results display. Visit Snyk Advisor to see a full health score report for snyk-filter, including popularity, security, maintenance & community analysis.

Is snyk-filter popular?

The npm package snyk-filter receives a total of 4,065 weekly downloads. As such, snyk-filter popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is snyk-filter well maintained?

We found indications that snyk-filter is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is snyk-filter safe to use?

While scanning the latest version of snyk-filter, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 24 September-2024, at 13:51 (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

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

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

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (4,065)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Custom Filtering for Snyk CLI

How do I use it?

Install

Note about node-jq

Usage

Example with Snyk CLI (using .snyk-filter/snyk.yml by default)

Example with Snyk CLI and custom yml file location

Example

Example with custom yml file location

Options

License

snyk-filter dependencies

snyk-filter development dependencies

FAQs

What is snyk-filter?

Is snyk-filter popular?

Is snyk-filter well maintained?

Is snyk-filter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Note about `node-jq`