Package Health Score

92 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
20.21.0	\|	12/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
20.20.0	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
20.19.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
19.1.2	\|	11/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
18.2.6	\|	10/2022		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 (188,045)

GitHub Stars: 221
Forks: 57
Contributors: 100

Direct Usage Popularity

The npm package @netlify/config receives a total of 188,045 downloads a week. As such, we scored @netlify/config popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @netlify/config, we found that it has been starred 221 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: Yes
Contributors: 100
Funding: No

With more than 10 contributors for the @netlify/config repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 15
Open PR: 30
Last Release: 8 days ago
Last Commit: 5 days ago

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

We found that @netlify/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.16.0 || >=16.0.0

Age: 5 years
Dependencies: 24 Direct
Versions: 432
Install Size: 163 kB
Dist-tags: 5
# of Files: 127
Maintainers: 17
TS Typings: No

@netlify/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.

Not sure how to use @netlify/config?

To help you get started, we've collected the most common ways that @netlify/config is being used within popular public projects.

netlify / cli / src / commands / build / index.js View on Github

async getConfig() {
    try {
      return await getConfigPath()
    } catch (error) {
      try {
        return await getConfigPath(undefined, this.netlify.site.root)
      } catch (error) {
        console.error(error.message)
        this.exit(1)
      }
    }
  }
}

View more ways to use @netlify/config

Netlify Config

This library loads, validates, and normalizes the Netlify configuration.

Netlify can be configured:

In the build settings.
In a netlify.toml file in the repository root directory or site base directory.

Install

npm install @netlify/config

Usage (Node.js)

resolveConfig(options?)

options: object?
Return value: Promise

import { resolveConfig } from '@netlify/config'

const exampleFunction = async function () {
  const { config, configPath, buildDir, context, branch, token, siteInfo } = await resolveConfig(options)
  // {
  // "siteInfo": {
  //   "id": "418b94bc-93cd-411a-937a-ae4c734f17c4",
  //   "name": "mick",
  //   "build_settings": {
  //     "cmd": "",
  //     "dir": "",
  //     "env": { ... },
  //     "functions_dir": "",
  //     "base": "",
  //   },
  //   ...
  // },
  // "accounts": [
  //   {
  //     "name": "my team",
  //     "slug": "me",
  //     ...
  //   },
  //   ...
  // ],
  // "addons": [],
  // "env": {
  //   "NODE_VERSION": { "sources": ["configFile"], "value": "16" },
  //   ...
  // },
  // "configPath": "/home/me/code/cv-website/netlify.toml",
  // "buildDir": "/home/me/code/cv-website",
  // "repositoryRoot": "/home/me/code/cv-website",
  // "config": {
  //   "functionsDirectory": "/home/me/code/cv-website/netlify/functions",
  //   "functionsDirectoryOrigin": "default",
  //   "functions": { "*": { "node_bundler": "esbuild" } },
  //   "plugins": [
  //     {
  //       "package": "@netlify/plugin-sitemap",
  //       "inputs": {},
  //       "origin": "config"
  //     }
  //   ],
  //   "build": {
  //     "publish": "/home/me/code/cv-website/build",
  //     "publishOrigin": "default",
  //     "command": "gulp build",
  //     "commandOrigin": "config",
  //     "functions": "/home/me/code/cv-website/netlify/functions"
  //   }
  // },
  // "context": "production",
  // "branch": "main",
  // "token": "564194bc-12cd-511a-037a-be4c734f17c4"
  // }
}

Options

The options are an optional object with the following properties.

Those options are automatically set when using @netlify/config in the Netlify production CI or with Netlify CLI.

debug

Type: boolean
Default value: false unless the NETLIFY_BUILD_DEBUG environment variable is set.

Prints debugging information showing the configuration being resolved.

offline

Type: boolean
Default value: false

Do not send requests to the Netlify API to retrieve site settings.

buffer

Type: boolean
Default value: false

When using debug, returns the logs instead of printing them on the console.

config

Type: string

Path to the netlify.toml. It is either an absolute path or a path relative to the cwd.

If not specified, it is searched in the following directories (by highest priority order):

base directory
repositoryRoot
current directory
any parent directory

Otherwise, no netlify.toml is used.

repositoryRoot

Type: string
Default value: see cwd

Repository root directory. This is used in the following cases:

Searching for the netlify.toml (see config)
When a base directory was specified, its path is relative to the repository root directory
The functions, edge_handlers and publish directories are relative to the repository root directory or (if specified) the base directory
Determining the build directory

If not specified, it is automatically guessed by looking for any .git directory from the cwd, and up. If none is found, the cwd is used instead.

cwd

Type: string
Default value: process.cwd()

Current directory. This is used in the following cases:

Searching for the netlify.toml (see config)
Searching for the repositoryRoot
In a monorepo, when stepping inside a specific package in the console, that package is automatically used as base directory

context

Type: string
Default value: environment variable CONTEXT, or "production"

Deploy context.

The netlify.toml can contain contexts.{CONTEXT} properties, which are like build properties but only applied when {CONTEXT} matches.

branch

Type: string
Default value: environment variable BRANCH, current git branch, "main" or "master".

Same as context but using a git branch name.

token

Type: string
Default value: environment variable NETLIFY_AUTH_TOKEN

Netlify API token.

This is used to retrieve siteInfo.

host

Type: string
Default value: api.netlify.com

Host of the Netlify API.

scheme

Type: string
Default value: https

Scheme/protocol of the Netlify API.

pathPrefix

Type: string
Default value: /api/v1

Base path prefix of the Netlify API.

siteId

Type: string
Default value: environment variable NETLIFY_SITE_ID

Netlify Site ID.

This is used to retrieve siteInfo, accounts and addons.

env

Type: object

Environment variable to use, in addition to the current process.env. This is used as the default values of other options.

mode

Type: string
Default value: "require"

What is calling @netlify/config. Can be:

"buildbot": Netlify production CI
"cli": Netlify CLI
"require": anything else

This is used for the following cases:

if mode is buildbot, siteInfo, accounts and addons are not retrieved because they are also passed using another internal option.

defaultConfig

Type: string

Configuration object used as default. This is an object serialized with JSON.

inlineConfig

Type: object

Configuration object overriding any properties. This is a JavaScript object.

configMutations

Type: array

Array of changes to apply to the configuration. Each change must be an object with three properties:

keys: array of keys targetting the property to change
value: new value of that property
event: build event when this change was applied, e.g. onPreBuild

Return value

The return value is a Promise resolving to an object with the following properties.

config

Type: object

Resolved configuration object.

configPath

Type: string?

Absolute path to the netlify.toml, if this file exists.

headersPath

Type: string

Absolute path to the _headers, even if this file does not exist.

redirectsPath

Type: string

Absolute path to the _redirects, even if this file does not exist.

buildDir

Type: string

Absolute path to the build directory.

The build directory is the current directory in which most build operations, including the build command, execute. It is usually either the repositoryRoot or (if specified) the base directory.

repositoryRoot

Type: string

The computed value of repositoryRoot.

context

Type: string

Resolved context. See the context option.

branch

Type: string

Resolved git branch. See the branch option.

siteInfo

Type: object

Netlify Site information retrieved using the getSite Netlify API endpoint. This is used to retrieve Build settings set in the Netlify App: plugins, Build command, Publish directory, Functions directory, Base directory, Environment variables.

This might be empty depending on the options passed.

accounts

Type: object[]

Netlify accounts retrieved using the listAccountsForUser Netlify API endpoint. This is used to retrieve account-level environment variables.

This might be empty depending on the options passed.

addons

Type: object[]

Netlify addons retrieved using the listServiceInstancesForSite Netlify API endpoint. This is used to retrieve addon-specific environment variables.

This might be empty depending on the options passed.

token

Type: string

Netlify API token. This takes into account the token option but also some Netlify-specific environment variables.

api

Type: NetlifyClient?

Netlify JavaScript client instance used to retrieve siteInfo, accounts and addons.

logs

Type: object?

When the buffer option is used, this contains two arrays stdout and stderr with the logs.

env

Type: object?

Site's environment variables. Each environment variable value is an object with the following properties:

value string
sources string[] among:
- general: general environment variables set for all sites
- account: environment variables set in the Netlify UI for a specific account
- addons: addon-specific environment variables
- ui: environment variables set in the Netlify UI for a specific site
- configFile: environment variables set in netlify.toml

Usage (CLI)

$ netlify-config

Like resolveConfig(), but in the CLI. The return value is printed on stdout.

The CLI flags use the same options.

@netlify/config development dependencies

@types/node ava c8 has-ansi is-ci tmp-promise typescript

FAQs

What is @netlify/config?

Netlify config module. Visit Snyk Advisor to see a full health score report for @netlify/config, including popularity, security, maintenance & community analysis.

Is @netlify/config popular?

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

Is @netlify/config well maintained?

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

Is @netlify/config safe to use?

The npm package @netlify/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 19 December-2024, at 06:06 (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

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (188,045)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @netlify/config?

Netlify Config

Install

Usage (Node.js)

resolveConfig(options?)

Options

debug

offline

buffer

config

repositoryRoot

cwd

context

branch

token

host

scheme

pathPrefix

siteId

env

mode

defaultConfig

inlineConfig

configMutations

Return value

config

configPath

headersPath

redirectsPath

buildDir

repositoryRoot

context

branch

siteInfo

accounts

addons

token

api

logs

env

Usage (CLI)

@netlify/config dependencies

@netlify/config development dependencies

FAQs

What is @netlify/config?

Is @netlify/config popular?

Is @netlify/config well maintained?

Is @netlify/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