Add type definitions. (#469)

Author: yeldiRium

index.d.ts

@@ -0,0 +1,52 @@
+interface LintIssue {
+    lintId: string;
+    severity: 'error' | 'warning';
+    node: 'string';
+    lintMessage: 'string';
+}
+
+interface FileLintResult {
+    filePath: string;
+    issues: LintIssue[];
+    ignored: boolean;
+    errorCount: number;
+    warningCount: number;
+}
+
+interface LinterResult {
+    results: FileLintResult[];
+    ignoreCount: number;
+    errorCount: number;
+    warningCount: number;
+}
+
+type NpmPackageJsonLintOptions = {
+    cwd?: string;
+    config?: object;
+    configFile: string;
+    configBaseDirectory?: string;
+    quiet?: boolean;
+    ignorePath?: string;
+    fix?: boolean;
+} & (
+  {
+    packageJsonObject: object,
+    packageJsonFilePath?: string;
+  } |
+  {
+    patterns: string[]
+  }
+);
+
+declare class NpmPackageJsonLint {
+    constructor (options: NpmPackageJsonLintOptions);
+
+    lint(): LinterResult;
+}
+
+export {
+    FileLintResult,
+    LinterResult,
+    LintIssue,
+    NpmPackageJsonLint
+};

package.json

@@ -27,6 +27,7 @@
     "CONTRIBUTING.md"
   ],
   "main": "src/api.js",
+  "types": "index.d.ts",
   "scripts": {
     "eslint": "eslint . --format=node_modules/eslint-formatter-pretty",
     "npmpackagejsonlint": "node src/cli.js ./package.json",