shinnn / github-username-regex

A regular expression that only matches a currently valid Github username

github-username-regex

A regular expression that only matches a valid Github username

import githubUsernameRegex from 'github-username-regex';

githubUsernameRegex.test('john'); //=> true
githubUsernameRegex.test('john-due'); //=> true
githubUsernameRegex.test('john-due-'); //=> false

According to the form validation messages on Join Github page,

• Github username may only contain alphanumeric characters or hyphens.
• Github username cannot have multiple consecutive hyphens.
• Github username cannot begin or end with a hyphen.
• Maximum is 39 characters.

Installation

npm

npm install github-username-regex

bower

bower install github-username-regex

API

import githubUsernameRegex from 'github-username-regex';

githubUsernameRegex

Type: RegExp (/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i)

// Returns `true`
githubUsernameRegex.test('a');
githubUsernameRegex.test('0');
githubUsernameRegex.test('a-b');
githubUsernameRegex.test('a-b-123');
githubUsernameRegex.test('a'.repeat(39));

// Returns `false`
githubUsernameRegex.test('');
githubUsernameRegex.test('a_b');
githubUsernameRegex.test('a--b');
githubUsernameRegex.test('a-b-');
githubUsernameRegex.test('-a-b');
githubUsernameRegex.test('a'.repeat(40));

Note that this module doesn't take reserved usernames into consideration. For example it matches help, about and pricing, though they are reserved words and cannot be used as Github usernames.

License

Creative Commons Zero v1.0 Universal

github-username-regex's Issues

Maximum is 39 chars but regex specifies 38.

Also I beleive an empty string is not a valid github username so this should probably not allow 0 characters.

Golang syntax

Hi there,
Do you have your regex in Golang syntax ?
Thank's a lot :-)

Does not match trailing dash

Quite surprisingly a trailing dash is allowed on GitHub... I'm not sure if this is a new thing or perhaps it's legacy and they no longer support it, but there are users out there with trailing dashes in their username, eg: https://github.com/Guin-

I'm not sure if this is something that you want to support or not