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

sindresorhus · Apr 17, 2019 · 578f3a7 · 578f3a7
1 parent 767c465
commit 578f3a7
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 22 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,4 @@
 language: node_js
 node_js:
+  - '10'
   - '8'
-  - '6'
-  - '4'
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,21 @@
+/**
+Strip leading whitespace from each line in a string.
+
+The line with the least number of leading whitespace, ignoring empty lines, determines the number to remove.
+
+@example
+```
+import stripIndent = require('strip-indent');
+
+const string = '\tunicorn\n\t\tcake';
+//	unicorn
+//		cake
+
+stripIndent(string);
+//unicorn
+//	cake
+```
+*/
+declare function stripIndent(string: string): string;
+
+export = stripIndent;
diff --git a/index.js b/index.js
@@ -1,14 +1,14 @@
 'use strict';
 const minIndent = require('min-indent');
 
-module.exports = str => {
-	const indent = minIndent(str);
+module.exports = string => {
+	const indent = minIndent(string);
 
 	if (indent === 0) {
-		return str;
+		return string;
 	}
 
-	const re = new RegExp(`^[ \\t]{${indent}}`, 'gm');
+	const regExp = new RegExp(`^[ \\t]{${indent}}`, 'gm');
 
-	return str.replace(re, '');
+	return string.replace(regExp, '');
 };
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -0,0 +1,4 @@
+import {expectType} from 'tsd';
+import stripIndent = require('.');
+
+expectType<string>(stripIndent('\tunicorn\n\t\tcake'));
diff --git a/package.json b/package.json
@@ -10,13 +10,14 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=4"
+		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"strip",
@@ -35,7 +36,8 @@
 		"min-indent": "^1.0.0"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
 	}
 }
diff --git a/readme.md b/readme.md
@@ -19,13 +19,13 @@ $ npm install strip-indent
 ```js
 const stripIndent = require('strip-indent');
 
-const str = '\tunicorn\n\t\tcake';
+const string = '\tunicorn\n\t\tcake';
 /*
 	unicorn
 		cake
 */
 
-stripIndent(str);
+stripIndent(string);
 /*
 unicorn
 	cake

diff --git a/test.js b/test.js
@@ -1,9 +1,9 @@
 import test from 'ava';
-import m from '.';
+import stripIndent from '.';
 
-test(t => {
-	t.is(m('\nunicorn\n'), '\nunicorn\n');
-	t.is(m('\n  unicorn\n'), '\nunicorn\n');
-	t.is(m('\t\t<!doctype html>\n\t\t<html>\n\t\t\t<body>\n\n\n\n\t\t\t\t<h1>Hello world!</h1>\n\t\t\t</body>\n\t\t</html>'), '<!doctype html>\n<html>\n\t<body>\n\n\n\n\t\t<h1>Hello world!</h1>\n\t</body>\n</html>');
-	t.is(m('\n\t\n\t\tunicorn\n\n\n\n\t\t\tunicorn'), '\n\t\nunicorn\n\n\n\n\tunicorn', 'ignore whitespace only lines');
+test('main', t => {
+	t.is(stripIndent('\nunicorn\n'), '\nunicorn\n');
+	t.is(stripIndent('\n  unicorn\n'), '\nunicorn\n');
+	t.is(stripIndent('\t\t<!doctype html>\n\t\t<html>\n\t\t\t<body>\n\n\n\n\t\t\t\t<h1>Hello world!</h1>\n\t\t\t</body>\n\t\t</html>'), '<!doctype html>\n<html>\n\t<body>\n\n\n\n\t\t<h1>Hello world!</h1>\n\t</body>\n</html>');
+	t.is(stripIndent('\n\t\n\t\tunicorn\n\n\n\n\t\t\tunicorn'), '\n\t\nunicorn\n\n\n\n\tunicorn', 'ignore whitespace only lines');
 });