github-username-regex

A regular expression that only matches a valid Github username

1import githubUsernameRegex from 'github-username-regex';
2
3githubUsernameRegex.test('john'); //=> true
4githubUsernameRegex.test('john-due'); //=> true
5githubUsernameRegex.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

1import githubUsernameRegex from 'github-username-regex';

githubUsernameRegex

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

1// Returns `true`
2githubUsernameRegex.test('a');
3githubUsernameRegex.test('0');
4githubUsernameRegex.test('a-b');
5githubUsernameRegex.test('a-b-123');
6githubUsernameRegex.test('a'.repeat(39));
7
8// Returns `false`
9githubUsernameRegex.test('');
10githubUsernameRegex.test('a_b');
11githubUsernameRegex.test('a--b');
12githubUsernameRegex.test('a-b-');
13githubUsernameRegex.test('-a-b');
14githubUsernameRegex.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