Require Node.js 8, add TypeScript definition

.editorconfig

@@ -7,6 +7,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[{package.json,*.yml}]
+[*.yml]
 indent_style = space
 indent_size = 2

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.gitignore

@@ -1 +1,2 @@
 node_modules
+yarn.lock

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.travis.yml

@@ -1,5 +1,4 @@
-sudo: false
 language: node_js
 node_js:
-  - '6'
-  - '4'
+  - '10'
+  - '8'

index.d.ts

@@ -0,0 +1,50 @@
+declare namespace urlRegex {
+	interface Options {
+		/**
+		Only match an exact string. Useful with `RegExp#test` to check if a string is a URL.
+
+		@default false
+		*/
+		readonly exact?: boolean;
+
+		/**
+		Force URLs to start with a valid protocol or `www`. If set to `false` it'll match the TLD against a list of valid [TLDs](https://github.com/stephenmathieson/node-tlds).
+
+		@default true
+		*/
+		readonly strict?: boolean;
+	}
+}
+
+/**
+Regular expression for matching URLs.
+
+@example
+```
+import urlRegex = require('url-regex');
+
+urlRegex().test('http://github.com foo bar');
+//=> true
+
+urlRegex().test('www.github.com foo bar');
+//=> true
+
+urlRegex({exact: true}).test('http://github.com foo bar');
+//=> false
+
+urlRegex({exact: true}).test('http://github.com');
+//=> true
+
+urlRegex({strict: false}).test('github.com foo bar');
+//=> true
+
+urlRegex({exact: true, strict: false}).test('github.com');
+//=> true
+
+'foo http://github.com bar //google.com'.match(urlRegex());
+//=> ['http://github.com', '//google.com']
+```
+*/
+declare function urlRegex(options?: urlRegex.Options): RegExp;
+
+export = urlRegex;

index.js

@@ -2,18 +2,21 @@
 const ipRegex = require('ip-regex');
 const tlds = require('tlds');
 
-module.exports = opts => {
-	opts = Object.assign({strict: true}, opts);
+module.exports = options => {
+	options = {
+		strict: true,
+		...options
+	};
 
-	const protocol = `(?:(?:[a-z]+:)?//)${opts.strict ? '' : '?'}`;
+	const protocol = `(?:(?:[a-z]+:)?//)${options.strict ? '' : '?'}`;
 	const auth = '(?:\\S+(?::\\S*)?@)?';
 	const ip = ipRegex.v4().source;
 	const host = '(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)';
 	const domain = '(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*';
-	const tld = `(?:\\.${opts.strict ? '(?:[a-z\\u00a1-\\uffff]{2,})' : `(?:${tlds.sort((a, b) => b.length - a.length).join('|')})`})\\.?`;
+	const tld = `(?:\\.${options.strict ? '(?:[a-z\\u00a1-\\uffff]{2,})' : `(?:${tlds.sort((a, b) => b.length - a.length).join('|')})`})\\.?`;
 	const port = '(?::\\d{2,5})?';
 	const path = '(?:[/?#][^\\s"]*)?';
 	const regex = `(?:${protocol}|www\\.)${auth}(?:localhost|${ip}|${host}${domain}${tld})${port}${path}`;
 
-	return opts.exact ? new RegExp(`(?:^${regex}$)`, 'i') : new RegExp(regex, 'ig');
+	return options.exact ? new RegExp(`(?:^${regex}$)`, 'i') : new RegExp(regex, 'ig');
 };

index.test-d.ts

@@ -0,0 +1,6 @@
+import {expectType} from 'tsd';
+import urlRegex = require('.');
+
+expectType<RegExp>(urlRegex());
+expectType<RegExp>(urlRegex({exact: true}));
+expectType<RegExp>(urlRegex({strict: false}));

package.json

@@ -1,37 +1,36 @@
 {
-  "name": "url-regex",
-  "version": "4.1.1",
-  "description": "Regular expression for matching URLs",
-  "license": "MIT",
-  "repository": "kevva/url-regex",
-  "author": {
-    "name": "Kevin Mårtensson",
-    "email": "[email protected]",
-    "url": "https://github.com/kevva"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "regex",
-    "string",
-    "url"
-  ],
-  "dependencies": {
-    "ip-regex": "^1.0.1",
-    "tlds": "^1.187.0"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  },
-  "xo": {
-    "esnext": true
-  }
+	"name": "url-regex",
+	"version": "4.1.1",
+	"description": "Regular expression for matching URLs",
+	"license": "MIT",
+	"repository": "kevva/url-regex",
+	"author": {
+		"name": "Kevin Mårtensson",
+		"email": "[email protected]",
+		"url": "https://github.com/kevva"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"regex",
+		"string",
+		"url"
+	],
+	"dependencies": {
+		"ip-regex": "^4.1.0",
+		"tlds": "^1.203.0"
+	},
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
+	}
 }

readme.md

@@ -8,7 +8,7 @@ Based on this [gist](https://gist.github.com/dperini/729294) by Diego Perini.
 ## Install
 
 ```
-$ npm install --save url-regex
+$ npm install url-regex
 ```
 
 
@@ -42,9 +42,9 @@ urlRegex({exact: true, strict: false}).test('github.com');
 
 ## API
 
-### urlRegex(options)
+### urlRegex([options])
 
-Returns a regex for matching URLs.
+Returns a `RegExp` for matching URLs.
 
 #### options
 

test.js

@@ -1,5 +1,5 @@
 import test from 'ava';
-import m from './';
+import urlRegex from '.';
 
 test('match exact URLs', t => {
 	const fixtures = [
@@ -63,7 +63,7 @@ test('match exact URLs', t => {
 	];
 
 	for (const x of fixtures) {
-		t.true(m({exact: true}).test(x));
+		t.true(urlRegex({exact: true}).test(x));
 	}
 });
 
@@ -82,7 +82,7 @@ test('match URLs in text', t => {
 		'http://example.com/with-path',
 		'https://another.example.com',
 		'//bar.net/?q=Query'
-	], fixture.match(m()));
+	], fixture.match(urlRegex()));
 });
 
 test('do not match URLs', t => {
@@ -129,7 +129,7 @@ test('do not match URLs', t => {
 	];
 
 	for (const x of fixtures) {
-		t.false(m({exact: true}).test(x));
+		t.false(urlRegex({exact: true}).test(x));
 	}
 });
 
@@ -192,6 +192,6 @@ test('match using list of TLDs', t => {
 	];
 
 	for (const x of fixtures) {
-		t.true(m({exact: true, strict: false}).test(x));
+		t.true(urlRegex({exact: true, strict: false}).test(x));
 	}
 });