infra: setup tslint

Author: mrodrig

package-lock.json

@@ -5,7 +5,7 @@
     },
     "name": "json-2-csv",
     "description": "A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.",
-    "version": "3.4.0",
+    "version": "3.4.1",
     "repository": {
         "type": "git",
         "url": "https://github.com/mrodrig/json-2-csv.git"
@@ -20,9 +20,11 @@
     "main": "./src/converter.js",
     "types": "./src/converter.d.ts",
     "scripts": {
-        "test": "./node_modules/.bin/mocha test/tests.js",
-        "coverage": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- -R spec",
-        "lint": "./node_modules/.bin/eslint src bin test"
+        "test": "mocha test/tests.js",
+        "coverage": "istanbul cover mocha -- -R spec",
+        "lint": "npm run lint:eslint && npm run lint:tslint",
+        "lint:eslint": "eslint src bin test",
+        "lint:tslint": "tslint -c tslint.json 'src/**/*.ts'"
     },
     "keywords": [
         "json",
@@ -48,7 +50,9 @@
         "eslint": "5.11.1",
         "istanbul": "0.4.5",
         "mocha": "5.2.0",
-        "should": "13.2.3"
+        "should": "13.2.3",
+        "tslint": "5.12.1",
+        "typescript": "3.3.3"
     },
     "engines": {
         "node": ">= 6"

package.json

@@ -1,4 +1,4 @@
-export interface ReadOptions {
+export interface ISharedOptions {
   /**
    * Specifies the different types of delimiters
    */
@@ -36,7 +36,7 @@ export interface ReadOptions {
   trimFieldValues?: boolean;
 }
 
-export interface WriteOptions extends ReadOptions {
+export interface IFullOptions extends ISharedOptions {
   /**
    * Should all documents have the same schema?
    * @default false
@@ -68,10 +68,12 @@ export interface WriteOptions extends ReadOptions {
 
 }
 
-export function json2csv(data: object[], callback: (err?: Error, csv?: string) => void, options?: WriteOptions): void;
+export function json2csv(data: object[],
+                         callback: (err?: Error, csv?: string) => void, options?: IFullOptions): void;
 
-export function json2csvAsync(data: object[], options?: WriteOptions): Promise<string>;
+export function json2csvAsync(data: object[], options?: IFullOptions): Promise<string>;
 
-export function csv2json(csv: string, callback: (err?: Error, data?: unknown[]) => void, options?: ReadOptions): void;
+export function csv2json(csv: string,
+                         callback: (err?: Error, data?: Array<unknown>) => void, options?: ISharedOptions): void;
 
-export function csv2jsonAsync(csv: string, options?: ReadOptions): Promise<unknown[]>;
+export function csv2jsonAsync(csv: string, options?: ISharedOptions): Promise<Array<unknown>>;

src/converter.d.ts

@@ -0,0 +1,9 @@
+{
+    "defaultSeverity": "error",
+    "extends": [
+        "tslint:recommended"
+    ],
+    "jsRules": {},
+    "rules": {},
+    "rulesDirectory": []
+}