Require Node.js 8, add TypeScript definition (#13)

.editorconfig

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

.gitattributes

@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf

.gitignore

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

.npmrc

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

.travis.yml

@@ -1,6 +1,4 @@
-sudo: false
 language: node_js
 node_js:
-  - 'stable'
-  - '0.12'
-  - '0.10'
+  - '10'
+  - '8'

index.d.ts

@@ -0,0 +1,16 @@
+/**
+Escape RegExp special characters.
+
+@example
+```
+import escapeStringRegexp = require('escape-string-regexp');
+
+const escapedString = escapeStringRegexp('how much $ for a 🦄?');
+//=> 'how much \\$ for a 🦄\\?'
+
+new RegExp(escapedString);
+```
+*/
+declare const escapeStringRegexp: (str: string) => string;
+
+export = escapeStringRegexp;

index.js

@@ -1,11 +1,11 @@
 'use strict';
 
-var matchOperatorsRe = /[|\\{}()[\]^$+*?.]/g;
+const matchOperatorsRegex = /[|\\{}()[\]^$+*?.]/g;
 
-module.exports = function (str) {
-	if (typeof str !== 'string') {
+module.exports = string => {
+	if (typeof string !== 'string') {
 		throw new TypeError('Expected a string');
 	}
 
-	return str.replace(matchOperatorsRe, '\\$&');
+	return string.replace(matchOperatorsRegex, '\\$&');
 };

index.test-d.ts

@@ -0,0 +1,4 @@
+import {expectType} from 'tsd';
+import escapeStringRegexp = require('.');
+
+expectType<string>(escapeStringRegexp('how much $ for a 🦄?'));

license

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
 
-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:
+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 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.
+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.

package.json

@@ -1,41 +1,43 @@
 {
-  "name": "escape-string-regexp",
-  "version": "1.0.5",
-  "description": "Escape RegExp special characters",
-  "license": "MIT",
-  "repository": "sindresorhus/escape-string-regexp",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "[email protected]",
-    "url": "sindresorhus.com"
-  },
-  "maintainers": [
-    "Sindre Sorhus <[email protected]> (sindresorhus.com)",
-    "Joshua Boy Nicolai Appelman <[email protected]> (jbna.nl)"
-  ],
-  "engines": {
-    "node": ">=0.8.0"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "escape",
-    "regex",
-    "regexp",
-    "re",
-    "regular",
-    "expression",
-    "string",
-    "str",
-    "special",
-    "characters"
-  ],
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "escape-string-regexp",
+	"version": "1.0.5",
+	"description": "Escape RegExp special characters",
+	"license": "MIT",
+	"repository": "sindresorhus/escape-string-regexp",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "[email protected]",
+		"url": "sindresorhus.com"
+	},
+	"maintainers": [
+		"Sindre Sorhus <[email protected]> (sindresorhus.com)",
+		"Joshua Boy Nicolai Appelman <[email protected]> (jbna.nl)"
+	],
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"escape",
+		"regex",
+		"regexp",
+		"re",
+		"regular",
+		"expression",
+		"string",
+		"str",
+		"special",
+		"characters"
+	],
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
+	}
 }

readme.md

@@ -6,7 +6,7 @@
 ## Install
 
 ```
-$ npm install --save escape-string-regexp
+$ npm install escape-string-regexp
 ```
 
 
@@ -15,13 +15,13 @@ $ npm install --save escape-string-regexp
 ```js
 const escapeStringRegexp = require('escape-string-regexp');
 
-const escapedString = escapeStringRegexp('how much $ for a unicorn?');
-//=> 'how much \$ for a unicorn\?'
+const escapedString = escapeStringRegexp('how much $ for a 🦄?');
+//=> 'how much \\$ for a 🦄\\?'
 
 new RegExp(escapedString);
 ```
 
 
 ## License
 
-MIT © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](https://sindresorhus.com)

test.js

@@ -1,9 +1,9 @@
 import test from 'ava';
-import fn from './';
+import escapeStringRegexp from '.';
 
-test(t => {
+test('main', t => {
 	t.is(
-		fn('\\ ^ $ * + ? . ( ) | { } [ ]'),
+		escapeStringRegexp('\\ ^ $ * + ? . ( ) | { } [ ]'),
 		'\\\\ \\^ \\$ \\* \\+ \\? \\. \\( \\) \\| \\{ \\} \\[ \\]'
 	);
 });