Repository files navigation

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

This package exports a single synchronous function that takes astring asinput and returns an object with two properties:

• validForNewPackages ::Boolean
• validForOldPackages ::Boolean

• Naming rules
• Examples
  • Valid Names
  • Invalid Names
• Legacy Names
• Tests
• License

Below is a list of rules that validnpm 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 namecan consist of hyphens
• package name mustnot contain any non-url-safe characters (since name ends up being part of a URL)
• package name should not start with. or_
• package name shouldnot contain any spaces
• package name shouldnot contain any of the following characters:~)('!*
• package namecannot 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

varvalidate=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}

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']}

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

If you give this function a package name thatused to be valid, you'll seea change in the value ofvalidForNewPackages property, and a warnings arraywill 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"]}

npm installnpmtest

ISC