Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

validate-npm-package-name

Package Overview
Dependencies
1
Maintainers
5
Versions
14
Issues
File Explorer

Advanced tools

validate-npm-package-name

Give me a string and I'll tell you if it's a valid npm package name

    5.0.0latest

Version published
Maintainers
5
Weekly downloads
8,268,176
decreased by-4.25%

Weekly downloads

Changelog

Source

5.0.0 (2022-10-10)

⚠️ BREAKING CHANGES

  • validate-npm-package-name is now compatible with the following semver range for node: ^14.17.0 || ^16.13.0 || >=18.0.0

Features

  • f0983ef #50 postinstall for dependabot template-oss PR (@lukekarrys)

Readme

Source

validate-npm-package-name

Give me a string and I'll tell you if it's a valid npm package name.

This package exports a single synchronous function that takes a string as input and returns an object with two properties:

  • validForNewPackages :: Boolean
  • validForOldPackages :: Boolean

Contents

Naming Rules

Below is a list of rules that valid npm package name should conform to.

  • package name length should be greater than zero
  • all the characters in the package name must be lowercase i.e., no uppercase or mixed case names are allowed
  • package name can consist of hyphens
  • package name must not contain any non-url-safe characters (since name ends up being part of a URL)
  • package name should not start with . or _
  • package name should not contain any spaces
  • package name should not contain any of the following characters: ~)('!*
  • package name cannot be the same as a node.js/io.js core module nor a reserved/blacklisted name. For example, the following names are invalid:
    • http
    • stream
    • node_modules
    • favicon.ico
  • package name length cannot exceed 214

Examples

Valid Names

var validate = require("validate-npm-package-name") validate("some-package") validate("example.com") validate("under_score") validate("123numeric") validate("@npm/thingy") validate("@jane/foo.js")

All of the above names are valid, so you'll get this object back:

{ validForNewPackages: true, validForOldPackages: true }

Invalid Names

validate("excited!") validate(" leading-space:and:weirdchars")

That was never a valid package name, so you get this:

{ validForNewPackages: false, validForOldPackages: false, errors: [ 'name cannot contain leading or trailing spaces', 'name can only contain URL-friendly characters' ] }

Legacy Names

In the old days of npm, package names were wild. They could have capital letters in them. They could be really long. They could be the name of an existing module in node core.

If you give this function a package name that used to be valid, you'll see a change in the value of validForNewPackages property, and a warnings array will be present:

validate("eLaBorAtE-paCkAgE-with-mixed-case-and-more-than-214-characters-----------------------------------------------------------------------------------------------------------------------------------------------------------")

returns:

{ validForNewPackages: false, validForOldPackages: true, warnings: [ "name can no longer contain capital letters", "name can no longer contain more than 214 characters" ] }

Tests

npm install npm test

License

ISC

Keywords

FAQs

What is validate-npm-package-name?

Give me a string and I'll tell you if it's a valid npm package name

Is validate-npm-package-name popular?

The npm package validate-npm-package-name receives a total of 7,863,645 weekly downloads. As such, validate-npm-package-name popularity was classified as popular.

Is validate-npm-package-name well maintained?

We found that validate-npm-package-name demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 5 open source maintainers collaborating on the project.

Last updated on 14 Oct 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc