Home > @rushstack/node-core-library > IPackageNameParserOptions

IPackageNameParserOptions interface

Options that configure the validation rules used by a PackageNameParser instance.

Signature:

export interface IPackageNameParserOptions 

Remarks

The default validation is based on the npmjs.com registry’s policy for published packages, and includes these restrictions:

  • The package name cannot be longer than 214 characters.

  • The package name must not be empty.

  • Other than the @ and / delimiters used for scopes, the only allowed characters are letters, numbers, -, _, and ..

  • The name must not start with a . or _.

Properties

Property Type Description
allowUpperCase boolean If true, allows upper-case letters in package names. This improves compatibility with some legacy private registries that still allow that.