@percy/config

v1.30.5

Handles loading and adding options to Percy configuration files. Uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) to load configuration files and [JSON schema](https://json-schema.org/) with [AJV](https://github.com/epoberezkin/ajv) to val For more information about how to use this package see README

Latest version published 9 days ago

License: MIT

NPM

GitHub

Package Health Score

86 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Security

No known security issues

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.30.5	\|	12/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.30.4	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.29.4	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.28.9	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.27.7	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

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

Popular

Weekly Downloads (277,471)

GitHub Stars: 72
Forks: 47
Contributors: 40

Direct Usage Popularity

The npm package @percy/config receives a total of 277,471 downloads a week. As such, we scored @percy/config popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @percy/config, we found that it has been starred 72 times.

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

Community

Active

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

With more than 10 contributors for the @percy/config 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 @percy/config is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 21
Open PR: 11
Last Release: 9 days ago
Last Commit: 9 days ago

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

We found that @percy/config demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: >=14

Age: 4 years
Dependencies: 4 Direct
Versions: 259
Install Size: 34.9 kB
Dist-tags: 3
# of Files: 14
Maintainers: 1
TS Typings: Yes

@percy/config 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

@percy/config

Handles loading and adding options to Percy configuration files. Uses cosmiconfig to load configuration files and JSON schema with AJV to validate those configuration files.

Loading config files

The .load() method will load and validate a configuation file, optionally merging it with any provided overrides. If no path is provided, will search for the first supported config found from the current directory up to the home directoy. Configuration files are cached and reused unless reload is true.

import PercyConfig from '@percy/config'

// loading is done synchronously
const config = PercyConfig.load(options)

Options

path — Config file path or directory containing a config file
overrides — Config option overrides
reload — Do not use cached config (default false)
bail — Return undefined when failing validation (default false)
print — Print info and error logs (default false)

Supported files

"percy" entry in package.json
.percyrc YAML or JSON file
.percy.json JSON file
.percy.yaml or .percy.yml YAML file
.percy.js or percy.config.js file that exports an object

Extending config options

The .addSchema() function will add a sub-schema to the Percy configuration file which will be parsed and validated when PercyConfig.load() is called. See JSON schema for possible schema options.

import PercyConfig from '@percy/config'

PercyConfig.addSchema({
  propertyName: JSONSchema
})

@percy/config dependencies

@percy/logger ajv cosmiconfig yaml

@percy/config development dependencies

json-schema-typed

FAQs

What is @percy/config?

Handles loading and adding options to Percy configuration files. Uses [cosmiconfig](https://github.com/davidtheclark/co... Visit Snyk Advisor to see a full health score report for @percy/config, including popularity, security, maintenance & community analysis.

Is @percy/config popular?

The npm package @percy/config receives a total of 277,471 weekly downloads. As such, @percy/config popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @percy/config well maintained?

We found that @percy/config demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @percy/config safe to use?

The npm package @percy/config 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 20 December-2024, at 03:20 (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 (277,471)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@percy/config

Loading config files

Options

Supported files

Extending config options

@percy/config dependencies

@percy/config development dependencies

FAQs

What is @percy/config?

Is @percy/config popular?

Is @percy/config well maintained?

Is @percy/config 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