.

Author: yoshuawuyts

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,41 @@
+{
+  "env": {
+    "node": true
+  },
+  "rules": {
+    // warnings
+    "no-unused-expressions": 1,
+    "no-warning-comments": 1,
+    "no-native-reassign": 1,
+    "no-invalid-regexp": 1,
+    "no-debugger": 1,
+    "no-console": 1,
+    "no-empty": 1,
+    "radix": 1,
+
+    // errors
+    "no-shadow-restricted-names": 2,
+    "handle-callback-err": 2,
+    "no-self-compare": 2,
+    "no-empty-class": 2,
+    "no-unused-vars": 2,
+    "no-dupe-keys": 2,
+    "valid-typeof": 2,
+    "no-undef": 2,
+
+    // stylistic errors
+    "quotes": [2, "single", "avoid-escape"],
+    "no-space-before-semi": 2,
+    "space-unary-word-ops": 2,
+    "no-spaced-func": 2,
+    "yoda": "always",
+    "new-cap": 2,
+
+    // mute
+    "no-use-before-define": 0,
+    "eol-last": 0,
+    "strict": 0,
+    "eqeqeq": 0,
+    "curly": 0
+  }
+}

.gitignore

@@ -0,0 +1,22 @@
+# tmp files
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+# tmp folders
+pids/
+logs/
+results/
+coverage/
+
+# node.js
+node_modules/
+npm-debug.log
+
+# osx
+.DS_Store

.travis.yml

@@ -0,0 +1,6 @@
+node_js:
+- "0.10"
+- "0.11"
+language: node_js
+script: "make test-travis"
+after_script: "npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,30 @@
+SRC = index.js
+
+include node_modules/make-lint/index.mk
+
+LINT_CONFIG = .eslintrc
+TESTS = test.js
+
+test: lint
+	@NODE_ENV=test ./node_modules/.bin/mocha \
+		$(TESTS) \
+		--bail
+
+test-cov:
+	@NODE_ENV=test node \
+		node_modules/.bin/istanbul cover \
+		./node_modules/.bin/_mocha \
+		-- -u exports \
+		$(TESTS) \
+		--bail
+
+test-travis:
+	@NODE_ENV=test node \
+		node_modules/.bin/istanbul cover \
+		./node_modules/.bin/_mocha \
+		--report lcovonly \
+		-- -u exports \
+		$(TESTS) \
+		--bail
+
+.PHONY: test

README.md

@@ -0,0 +1,42 @@
+# regex-username
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+[![Downloads][downloads-image]][downloads-url]
+
+Regular expression for usernames.
+
+## Installation
+```bash
+npm install regex-username
+```
+
+## Usage
+```js
+var regex = require('regex-username');
+
+regex().test('tobi-ferret');
+// => true
+```
+
+## Why?
+Which usernames to allow typically varies between applications. For prototypes
+however it's nice to have an off the shelf solution. This module is that
+solution. It follows the same rules GitHub uses:
+> Username may only contain alphanumeric characters or dashes and cannot begin
+with a dash
+
+## See Also
+- [regex-email](https://github.com/regexps/email)
+
+## License
+[MIT](https://tldrlegal.com/license/mit-license)
+
+[npm-image]: https://img.shields.io/npm/v/regex-username.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/regex-username
+[travis-image]: https://img.shields.io/travis/regexps/regex-username.svg?style=flat-square
+[travis-url]: https://travis-ci.org/regexps/regex-username
+[coveralls-image]: https://img.shields.io/coveralls/regexps/regex-username.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/r/regexps/regex-username?branch=master
+[downloads-image]: http://img.shields.io/npm/dm/regex-username.svg?style=flat-square
+[downloads-url]: https://npmjs.org/package/regex-username

index.js

@@ -0,0 +1,11 @@
+/**
+ * Expose username regex.
+ *
+ * Example input:
+ *   tobi
+ *   tobi-ferret
+ *   tobino---ferret--
+ */
+module.exports = function() {
+  return /^\w[\w-]+$/;
+};

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "regex-username",
+  "version": "1.0.0",
+  "description": "Regular expression for usernames",
+  "main": "index.js",
+  "scripts": {
+    "test": "make test"
+  },
+  "repository": "regexps/regex-username",
+  "keywords": [
+    "regular expression",
+    "regex",
+    "regexp",
+    "user",
+    "username"
+  ],
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "istanbul": "^0.3.5",
+    "make-lint": "^1.0.1",
+    "mocha": "^2.0.1"
+  },
+  "files": [
+    "LICENSE",
+    "index.js",
+    "README.md"
+  ]
+}

test.js

@@ -0,0 +1,21 @@
+/**
+ * Module dependencies
+ */
+var assert = require('assert');
+var regex = require('./');
+
+/**
+ * Test
+ */
+describe('username regex', function() {
+  it('should match username input', function() {
+    assert.equal(regex().test('tobi3'), true);
+    assert.equal(regex().test('tobi-ferret'), true);
+    assert.equal(regex().test('3tobi--ferret'), true);
+  });
+
+  it('should catch incorrect input', function() {
+    assert.equal(regex().test('-hello'), false);
+    assert.equal(regex().test('~~derp@darp-----++asdfasdf'), false);
+  });
+});