Add TypeScript definition (#2)

.gitattributes

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

.travis.yml

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

index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert a camelized/dasherized/underscored string into a humanized one: `fooBar-Baz_Faz` → `Foo bar baz faz`.
+ *
+ * @param text - The string to make human readable.
+ */
+export default function humanizeString(text: string): string;

index.js

@@ -1,7 +1,7 @@
 'use strict';
 const decamelize = require('decamelize');
 
-module.exports = input => {
+const humanizeString = input => {
 	if (typeof input !== 'string') {
 		throw new TypeError('Expected a string');
 	}
@@ -12,3 +12,6 @@ module.exports = input => {
 
 	return input;
 };
+
+module.exports = humanizeString;
+module.exports.default = humanizeString;

index.test-d.ts

@@ -0,0 +1,4 @@
+import {expectType} from 'tsd-check';
+import humanizeString from '.';
+
+expectType<string>(humanizeString('fooBar'));

package.json

@@ -13,10 +13,11 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd-check"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"humanize",
@@ -37,7 +38,8 @@
 		"decamelize": "^2.0.0"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^1.2.1",
+		"tsd-check": "^0.3.0",
+		"xo": "^0.24.0"
 	}
 }

test.js

@@ -1,14 +1,14 @@
 import test from 'ava';
-import m from '.';
+import humanizeString from '.';
 
 test('main', t => {
-	t.is(m(''), '');
-	t.is(m('unicorns and rainbows'), 'Unicorns and rainbows');
-	t.is(m('unicorns-and-rainbows'), 'Unicorns and rainbows');
-	t.is(m('UnicornsAndRainbows'), 'Unicorns and rainbows');
-	t.is(m('unicornsAndRainbows'), 'Unicorns and rainbows');
-	t.is(m('unicorns_and_rainbows'), 'Unicorns and rainbows');
-	t.is(m('-UnicornsAndRainbows'), 'Unicorns and rainbows');
-	t.is(m('  unicorns  and  rainbows  '), 'Unicorns and rainbows');
-	t.is(m('unicorns_and-Rainbows_andPonies  '), 'Unicorns and rainbows and ponies');
+	t.is(humanizeString(''), '');
+	t.is(humanizeString('unicorns and rainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('unicorns-and-rainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('UnicornsAndRainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('unicornsAndRainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('unicorns_and_rainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('-UnicornsAndRainbows'), 'Unicorns and rainbows');
+	t.is(humanizeString('  unicorns  and  rainbows  '), 'Unicorns and rainbows');
+	t.is(humanizeString('unicorns_and-Rainbows_andPonies  '), 'Unicorns and rainbows and ponies');
 });