@aklinker1/check 1.3.0 → 1.4.0

package/README.md

@@ -13,7 +13,7 @@ pnpm check --fix
 To enable checks for any of the following modules, just install them:
 
 ```sh
-pnpm i -D typescript eslint prettier publint
+pnpm i -D typescript oxlint prettier publint eslint
 ```
 
 ## Contributing

package/dist/index.mjs

@@ -1,23 +1,38 @@
 import { ALL_TOOLS } from "./tools/index.mjs";
 import { p } from "@antfu/utils";
-import { bold, cyan, debug, dim, humanMs, isDebug, red, yellow } from "./utils.mjs";
+import {
+  bold,
+  cyan,
+  debug as debugLog,
+  dim,
+  humanMs,
+  isDebug,
+  red,
+  yellow
+} from "./utils.mjs";
 import { createTaskList } from "./tasklist/index.mjs";
 import { relative, resolve, sep } from "node:path";
 import { isCI } from "ci-info";
 export async function check(options = {}) {
   const {
-    debug: debug2,
+    debug,
     fix = !isCI,
     root = process.cwd(),
     binDir = "node_modules/.bin"
   } = options;
-  if (debug2) {
+  if (debug) {
     process.env.DEBUG = "true";
   }
   console.log();
+  debugLog("Options:" + JSON.stringify(options));
+  debugLog("Resolved options:" + JSON.stringify({ debug, fix, root, binDir }));
   const tools = await findInstalledTools({ root, binDir });
   if (tools.length === 0) {
-    console.log("No tools detected! Run with --debug for more info");
+    if (isDebug()) {
+      console.log("No tools detected!");
+    } else {
+      console.log("No tools detected! Run with --debug for more info");
+    }
     console.log();
     process.exit(1);
   }
@@ -94,9 +109,9 @@ async function findInstalledTools(opts) {
   if (isDebug()) {
     const getTools = (isInstalled) => status.filter((item) => item.isInstalled === isInstalled).map((item) => item.tool.name).join(", ");
     const installed = getTools(true);
-    debug(`Installed: ${installed || "(none)"}`);
+    debugLog(`Installed: ${installed || "(none)"}`);
     const skipped = getTools(false);
-    debug(`Skipping: ${skipped || "(none)"} `);
+    debugLog(`Skipping: ${skipped || "(none)"} `);
   }
   return status.filter(({ isInstalled }) => isInstalled).map((item) => item.tool);
 }

package/dist/tools/index.mjs

@@ -1,5 +1,6 @@
 import { eslint } from "./eslint.mjs";
+import { oxlint } from "./oxlint.mjs";
 import { prettier } from "./prettier.mjs";
-import { typescript } from "./typescript.mjs";
 import { publint } from "./publint.mjs";
-export const ALL_TOOLS = [publint, prettier, typescript, eslint];
+import { typescript } from "./typescript.mjs";
+export const ALL_TOOLS = [publint, prettier, typescript, oxlint, eslint];

package/dist/tools/oxlint.d.ts

@@ -0,0 +1,3 @@
+import type { OutputParser, ToolDefinition } from "../types";
+export declare const oxlint: ToolDefinition;
+export declare const parseOuptut: OutputParser;

package/dist/tools/oxlint.mjs

@@ -0,0 +1,42 @@
+import { execAndParse, isBinInstalled } from "../utils.mjs";
+import { resolve } from "node:path";
+export const oxlint = ({ binDir, root }) => {
+  const bin = resolve(root, binDir, "oxlint");
+  const checkArgs = ["--format=linux"];
+  const fixArgs = ["--format=linux", "--fix"];
+  return {
+    name: "Oxlint",
+    isInstalled: () => isBinInstalled(bin),
+    check: () => execAndParse(bin, checkArgs, root, parseOuptut),
+    fix: () => execAndParse(bin, fixArgs, root, parseOuptut)
+  };
+};
+export const parseOuptut = ({ stdout, stderr }) => {
+  if (stdout.trim()) {
+    return stdout.split(/\r?\n/).reduce((acc, line) => {
+      const groups = /^(?<file>.+?):(?<line>[0-9]+):(?<column>[0-9]):\s?(?<message>.*?)\s?\[(?<kind>Warning|Error)\/?(?<rule>.*?)\]\s?$/.exec(
+        line
+      )?.groups;
+      if (groups) {
+        acc.push({
+          file: groups.file,
+          kind: groups.kind === "Error" ? "error" : "warning",
+          message: groups.message,
+          rule: groups.rule || void 0,
+          location: {
+            line: parseInt(groups.line, 10),
+            column: parseInt(groups.column, 10)
+          }
+        });
+      }
+      return acc;
+    }, []);
+  }
+  return stdout.trim().split(/\r?\n/).map((line) => line.trim()).filter((line) => !!line && !line.includes(" ")).map(
+    (line) => ({
+      file: line.trim(),
+      kind: "warning",
+      message: "Not formatted."
+    })
+  );
+};

package/dist/tools/oxlint.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tools/oxlint.test.mjs

@@ -0,0 +1,57 @@
+import { describe, it, expect } from "bun:test";
+import { parseOuptut } from "./oxlint.mjs";
+describe("Oxlint", () => {
+  it("should properly parse output", async () => {
+    const stdout = `
+test.ts:1:7: Variable 'test' is declared but never used. [Warning/eslint(no-unused-vars)]
+test.ts:3:7: Variable 'variable' is declared but never used. [Warning/eslint(no-unused-vars)]
+test.ts:8:7: Variable 'two' is declared but never used. [Warning/eslint(no-unused-vars)]
+test.ts:8:7: Missing initializer in const declaration [Error]
+
+3 problems
+`;
+    const stderr = "";
+    const code = 1;
+    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+      {
+        file: "test.ts",
+        message: "Variable 'test' is declared but never used.",
+        location: {
+          line: 1,
+          column: 7
+        },
+        rule: "eslint(no-unused-vars)",
+        kind: "warning"
+      },
+      {
+        file: "test.ts",
+        message: "Variable 'variable' is declared but never used.",
+        location: {
+          line: 3,
+          column: 7
+        },
+        rule: "eslint(no-unused-vars)",
+        kind: "warning"
+      },
+      {
+        file: "test.ts",
+        message: "Variable 'two' is declared but never used.",
+        location: {
+          line: 8,
+          column: 7
+        },
+        rule: "eslint(no-unused-vars)",
+        kind: "warning"
+      },
+      {
+        file: "test.ts",
+        message: "Missing initializer in const declaration",
+        location: {
+          line: 8,
+          column: 7
+        },
+        kind: "error"
+      }
+    ]);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aklinker1/check",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/aklinker1/check"