Skip to main content

normalize-package-name

Functions

normalizePackageName(name) โ‡’ string

Brings package name to correct format based on prefix

getShorthandName(fullName) โ‡’ string

Removes the prefix from a fullName.

normalizePackageName(name) โ‡’ string

Brings package name to correct format based on prefix

Kind: global function
Returns: string - Normalized name of the package

ParamTypeDescription
namestringThe name of the package.

normalizePackageName~normalizedName

for scoped packages, insert the prefix after the first / unless the path is already @scope/eslint or @scope/eslint-xxx-yyy

Kind: inner property of normalizePackageName

normalizePackageName~scopedPackageShortcutRegex

it's a scoped package package name is the prefix, or just a username

Kind: inner constant of normalizePackageName

getShorthandName(fullName) โ‡’ string

Removes the prefix from a fullName.

Kind: global function
Returns: string - The term without prefix.

ParamTypeDescription
fullNamestringThe term which may have the prefix.