Security News
GitHub Removes Malicious Pull Requests Targeting Open Source Repositories
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
preferred-node-version
Advanced tools
Get the preferred Node.js version of a user or project.
This looks for (from highest to lowest priority):
.n-node-version
,
.naverc
,
.node-version
,
.nodeenvrc
.nvmrc
or
package.json
(engines.node
field)
in the current directory, parent directories, or home directoryNODE_VERSION
,
NODIST_NODE_VERSION
environment variablenvm
aliases (like current
or lts/erbium
) and version ranges (like 12
or
>=12
) are resolved to regular "major.minor.patch"
version strings.
Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.
import preferredNodeVersion from 'preferred-node-version'
// Look for any `.nvmrc` or `package.json` (`engines.node` field)
const { version } = await preferredNodeVersion()
console.log(version) // 12.10.0
// Search only the home directory and environment variables
await preferredNodeVersion({ global: true })
// Start looking for a Node.js version file from this directory instead
await preferredNodeVersion({ cwd: '/path/to/cwd' })
// Search for specific files
await preferredNodeVersion({
files: ['/path/to/.nvmrc', '/path/to/package.json'],
})
npm install preferred-node-version
This package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
an import
or import()
statement,
not require()
. If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.
options
: object?
Returns: Promise<object>
The returned promise resolves to an object with the following properties. An empty object is returned if no preferred Node.js version was found.
If a file cannot be read or if it contains an invalid version, the promise is rejected with an error.
Type: string
Full Node.js version. For example 12.16.2
Type: string
Node.js version as specified in the Node.js version file. This might include
aliases or version ranges. For example latest
, lts/erbium
, 12
or
12.16.2
.
Type: string?
Absolute path to the Node.js version file. Either filePath
or envVariable
is
defined.
Type: string?
Name of the environment variable containing the version. For example
NODE_VERSION
. Either filePath
or envVariable
is defined.
Type: string | URL
Default: process.cwd()
Start looking for a Node.js version file from this directory.
Type: boolean
Default: false
If true
, find the global Node.js version instead:
Type: string[]
Default: []
Additional files to lookup. Their filenames must be one of package.json
,
.nvmrc
, etc.
Type: string
Default: https://nodejs.org/dist
Base URL to fetch the list of available Node.js versions. Can be customized (for
example https://npmmirror.com/mirrors/node
).
The following environment variables can also be used: NODE_MIRROR
,
NVM_NODEJS_ORG_MIRROR
, N_NODE_MIRROR
or NODIST_NODE_MIRROR
.
Type: boolean
Default: undefined
The list of available Node.js versions is cached for one hour by default. If the
fetch
option is:
true
: the cache will not be usedfalse
: the cache will be used even if it's older than one hourType:
AbortSignal
Cancels when the signal is aborted.
Type: string[]
List of filenames being searched: .nvmrc
, package.json
, etc.
nve
: Run a specific Node.js version (CLI)nvexeca
: Run a specific Node.js version
(programmatic)get-node
: Download Node.jsnormalize-node-version
:
Normalize and validate Node.js versionsnode-version-alias
: Resolve
Node.js version aliases like latest
, lts
or erbium
all-node-versions
: List all
available Node.js versionsfetch-node-website
: Fetch
releases on nodejs.orgFor any question, don't hesitate to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
Thanks go to our wonderful contributors:
ehmicky 💻 🎨 🤔 📖 | Adrien Becchis 💻 ⚠️ 🤔 | Шухрат Шадмонов 🤔 💬 |
FAQs
Get the preferred Node.js version of a project or user
We found that preferred-node-version demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.