@darksheep/eslint-formatter-github 0.0.0 → 0.0.1

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@darksheep/eslint-formatter-github",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "ESLint + Github actions",
   "license": "UNLICENCED",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./types/index.d.ts",
   "files": [
-    "./src"
+    "./src",
+    "./types"
   ],
   "scripts": {
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "prepack": "tsc"
   },
   "dependencies": {
     "@darksheep/github-actions": "~0.0.0",

package/types/index.d.ts

@@ -0,0 +1,53 @@
+export = formatter;
+/**
+ * @typedef {Object} LintMessage
+ * @property {number} column
+ * @property {number} line
+ * @property {number} [endColumn]
+ * @property {number} [endLine]
+ * @property {string | null} ruleId
+ * @property {string} message
+ * @property {string} [messageId]
+ * @property {string} [nodeType]
+ * @property {boolean} [fatal]
+ * @property {0 | 1 | 2} severity
+ */
+/**
+ * @typedef {Object} LintResult
+ * @property {string} filePath
+ * @property {LintMessage[]} messages
+ * @property {number} errorCount
+ * @property {number} fatalErrorCount
+ * @property {number} warningCount
+ * @property {number} fixableErrorCount
+ * @property {number} fixableWarningCount
+ */
+/**
+ * @param {LintResult[]} fileResults The eslint results
+ * @returns {string}
+ */
+declare function formatter(fileResults: LintResult[]): string;
+declare namespace formatter {
+    export { LintMessage, LintResult };
+}
+type LintResult = {
+    filePath: string;
+    messages: LintMessage[];
+    errorCount: number;
+    fatalErrorCount: number;
+    warningCount: number;
+    fixableErrorCount: number;
+    fixableWarningCount: number;
+};
+type LintMessage = {
+    column: number;
+    line: number;
+    endColumn?: number | undefined;
+    endLine?: number | undefined;
+    ruleId: string | null;
+    message: string;
+    messageId?: string | undefined;
+    nodeType?: string | undefined;
+    fatal?: boolean | undefined;
+    severity: 0 | 1 | 2;
+};