package-name-regex

src="https://img.shields.io/npm/v/package-name-regex.svg"
alt="npm version"
>

src="https://github.com/dword-design/package-name-regex/workflows/build/badge.svg"
alt="Build status"
>

src="https://codecov.io/gh/dword-design/package-name-regex/branch/master/graph/badge.svg"
alt="Coverage status"
>




src="https://gitpod.io/button/open-in-gitpod.svg"
alt="Open in Gitpod"
width="114"
>

src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
alt="Buy Me a Coffee"
width="114"
>

src="https://sebastianlandwehr.com/images/paypal.svg"
alt="PayPal"
width="163"
>

src="https://sebastianlandwehr.com/images/patreon.svg"
alt="Patreon"
width="163"
>

Provides a regex that can be used to test if a string is a valid NPM package name.

Install

``bash


npm

$ npm install package-name-regex

Yarn

$ yarn add package-name-regex
`

Usage

`js
import packageNameRegex from 'package-name-regex'
// Or import { packageNameRegex } from 'package-name-regex'

packageNameRegex.test('some-package') // true
packageNameRegex.test('example.com') // true
packageNameRegex.test('@npm/thingy') // true

packageNameRegex.test('crazy!') // false
packageNameRegex.test('.start-with-period') // false
packageNameRegex.test('@npm-zors/money!time.js') // false
``

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
alt="Buy Me a Coffee"
width="114"
>
 If you want to send me a one time donation. The coffee is pretty good 😊.


src="https://sebastianlandwehr.com/images/paypal.svg"
alt="PayPal"
width="163"
>
 Also for one time donations if you like PayPal.


src="https://sebastianlandwehr.com/images/patreon.svg"
alt="Patreon"
width="163"
>
 Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

License

MIT License © Sebastian Landwehr