tests: use dtslint for testing type definitions

Author: Ovyerus

package.json

@@ -14,17 +14,20 @@
   },
   "license": "MIT",
   "files": [
-    "index.js"
+    "index.js",
+    "types/index.d.ts"
   ],
   "main": "index.js",
-  "types": "split-string.d.ts",
+  "types": "types/index.d.ts",
   "engines": {
     "node": ">=8.6"
   },
   "scripts": {
-    "test": "nyc mocha"
+    "test": "nyc mocha",
+    "test:types": "dtslint types"
   },
   "devDependencies": {
+    "dtslint": "^0.7.0",
     "gulp-format-md": "^1.0.0",
     "mocha": "^5.2.0",
     "nyc": "^12.0.2"

split-string.d.ts renamed to types/index.d.ts

@@ -1,10 +1,12 @@
-interface ASTNode {
+// TypeScript Version: 3.0
+
+export interface ASTNode {
   type: 'root' | 'bracket';
   nodes: ASTNode[];
   stash: string[];
 }
 
-interface State {
+export interface State {
   input: string;
   separator: string;
   stack: ASTNode[];
@@ -14,7 +16,7 @@ interface State {
   next(): string;
 }
 
-interface Options {
+export interface Options {
   brackets?: { [key: string]: string } | boolean;
   quotes?: string[] | boolean;
   separator?: string;
@@ -24,9 +26,7 @@ interface Options {
 
 type SplitFunc = (state: State) => boolean;
 
-declare function split(input: string): string[];
-declare function split(input: string, options: Options): string[];
-declare function split(input: string, fn: SplitFunc): string[];
+declare function split(input: string, options?: Options | SplitFunc): string[];
 declare function split(input: string, options: Options, fn: SplitFunc): string[];
 
 export default split;

test/test.ts renamed to types/test.ts

@@ -1,13 +1,13 @@
 /**
  * Testing the TypeScript definitions for split-string.
  */
-import split from '../';
+import split, { State } from '.';
 
-function keep(value, state) {
+function keep(value: string, state: State) {
   return value !== '\\' && (value !== '"' || state.prev() === '\\');
-};
+}
 
-function splitFunc(state) {
+function splitFunc(state: State) {
   console.log(state);
   return state.prev() === 'a';
 }
@@ -27,7 +27,8 @@ split('«a.b».⟨c.d⟩.[e.f]', {
 split('a.b.c.a.d.e', splitFunc);
 split('a.b."c.d.e.f.g".h.i', { quotes: ['"'] }, splitFunc);
 
-// should error
-split();
-split(splitFunc);
-split({ quotes: ['"'] });
+// Make sure invalid calls fail
+
+split(); // $ExpectError
+split(splitFunc); // $ExpectError
+split({ quotes: ['"'] }); // $ExpectError

types/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es6", "dom"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true
+  }
+}

types/tslint.json

@@ -0,0 +1,6 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "no-relative-import-in-test": false
+  }
+}