fix: add declarations (#7)

Author: whxaxes

.eslintignore

@@ -0,0 +1 @@
+test/fixtures/ts/**/*.js

.gitignore

@@ -13,3 +13,4 @@ results
 node_modules
 npm-debug.log
 coverage/
+test/fixtures/ts/**/*.js

index.d.ts

@@ -0,0 +1,22 @@
+import { SpawnOptions } from 'child_process';
+import { Writable } from 'stream';
+
+declare namespace RunScript {
+  export interface Options extends SpawnOptions {
+    stdout?: Writable;
+    stderr?: Writable;
+  }
+
+  export interface Stdio {
+    stdout: Buffer | null;
+    stderr: Buffer | null;
+  }
+
+  export interface StdError extends Error {
+    stdio: Stdio;
+  }
+}
+
+declare function RunScript(cmd: string, opts?: RunScript.Options): Promise<RunScript.Stdio>;
+
+export = RunScript;

package.json

@@ -4,7 +4,8 @@
   "description": "Run script easy!",
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
     "test": "npm run lint && egg-bin test",
@@ -18,11 +19,13 @@
     "is-type-of": "^1.1.0"
   },
   "devDependencies": {
+    "@types/node": "^12.0.8",
     "autod": "*",
     "egg-bin": "1",
     "egg-ci": "^1.8.0",
     "eslint": "3",
-    "eslint-config-egg": "3"
+    "eslint-config-egg": "3",
+    "typescript": "^3.5.1"
   },
   "homepage": "https://github.com/node-modules/runscript",
   "repository": {

test/fixtures/ts/check.ts

@@ -0,0 +1,19 @@
+import * as runscript from '../../../';
+import assert = require('assert');
+
+runscript('node -v', { stdio: 'pipe' })
+  .then(result => {
+    assert(!result.stderr);
+    assert(!!result.stdout!.toString());
+    console.info(result.stdout!.toString());
+
+    return runscript('node -h', {
+      stdio: 'pipe',
+      stdout: process.stdout,
+      stderr: process.stderr,
+    });
+  })
+  .catch((err: runscript.StdError) => {
+    assert(err.stdio);
+    throw new Error('should not throw');
+  });

test/fixtures/ts/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "es2017",
+    "module": "commonjs",
+    "moduleResolution": "node"
+  }
+}

test/runscript.test.js

@@ -116,6 +116,26 @@ describe('test/runscript.test.js', () => {
     });
   });
 
+  it('should compile ts without error', () => {
+    return runScript('tsc -p ./ts/tsconfig.json', {
+      stdio: 'pipe',
+      cwd: path.join(__dirname, 'fixtures'),
+    }).then(stdio => {
+      assert(!stdio.stderr);
+
+      return runScript('node ./ts/check.js', {
+        stdio: 'pipe',
+        cwd: path.join(__dirname, 'fixtures'),
+      }).then(stdio => {
+        assert(!stdio.stderr);
+        const stdout = stdio.stdout.toString();
+        assert(stdout);
+        assert(stdout.match(/v\d+\.\d+\.\d+/));
+        assert(stdout.match(/Options:/));
+      });
+    });
+  });
+
   if (process.platform === 'win32') {
     it('should run relative path .\\node_modules\\.bin\\autod', () => {
       return runScript('.\\node_modules\\.bin\\autod -V', {