https://github.com/dword-design/package-name-regex
Provides a regex that can be used to test if a string is a valid NPM package name.
https://github.com/dword-design/package-name-regex
match name package regex regexp test validate
Last synced: 10 months ago
JSON representation
Provides a regex that can be used to test if a string is a valid NPM package name.
- Host: GitHub
- URL: https://github.com/dword-design/package-name-regex
- Owner: dword-design
- License: other
- Created: 2019-12-03T00:08:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-18T09:36:06.000Z (over 1 year ago)
- Last Synced: 2025-02-27T00:23:40.661Z (over 1 year ago)
- Topics: match, name, package, regex, regexp, test, validate
- Language: JavaScript
- Homepage:
- Size: 1.94 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# package-name-regex
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](https://github.com/dword-design/package-name-regex/issues) or a [pull request](https://github.com/dword-design/package-name-regex/pulls)! ⚙️
## 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:
If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
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](https://opensource.org/license/mit/) © [Sebastian Landwehr](https://sebastianlandwehr.com)