@aklinker1/check 2.1.0 → 2.1.2

package/dist/index.mjs

@@ -1,135 +0,0 @@
-import { ALL_TOOLS } from "./tools/index.mjs";
-import { p } from "@antfu/utils";
-import {
-  bold,
-  cyan,
-  debug as debugLog,
-  dim,
-  humanMs,
-  isDebug,
-  red,
-  yellow
-} from "./utils.mjs";
-import { createTaskList } from "./tasklist/index.mjs";
-import { relative, resolve, sep, join } from "node:path";
-import { isCI } from "ci-info";
-import { readFile } from "node:fs/promises";
-export async function check(options = {}) {
-  const { debug, fix = !isCI, root = process.cwd() } = options;
-  const packageJson = JSON.parse(
-    await readFile(join(root, "package.json"), "utf8")
-  );
-  if (debug) {
-    process.env.DEBUG = "true";
-  }
-  console.log();
-  debugLog("Options:" + JSON.stringify(options));
-  debugLog(
-    "Resolved options:" + JSON.stringify({ debug, fix, root, packageJson })
-  );
-  const tools = await findInstalledTools({ root, packageJson });
-  if (tools.length === 0) {
-    if (isDebug()) {
-      console.log("No tools detected!");
-    } else {
-      console.log("No tools detected! Run with --debug for more info");
-    }
-    console.log();
-    process.exit(1);
-  }
-  const results = await createTaskList(
-    tools,
-    async ({ input: tool, fail, succeed, warn }) => {
-      const startTime = performance.now();
-      const fn = fix ? tool.fix ?? tool.check : tool.check;
-      const problems2 = await fn();
-      problems2.forEach((problem) => {
-        problem.file = resolve(root ?? process.cwd(), problem.file);
-      });
-      const duration = humanMs(performance.now() - startTime);
-      const title = `${tool.name} ${dim(`(${duration})`)}`;
-      const errorCount = problems2.filter((p2) => p2.kind === "error").length;
-      if (errorCount > 0)
-        fail(title);
-      else if (problems2.length > 0)
-        warn(title);
-      else
-        succeed(title);
-      return problems2;
-    }
-  );
-  const problems = results.flat();
-  console.log();
-  if (problems.length === 0) {
-    process.exit(0);
-  }
-  console.log(plural(problems.length, "Problem:", "Problems:"));
-  problems.sort((l, r) => {
-    const nameCompare = l.file.localeCompare(r.file);
-    if (nameCompare !== 0)
-      return nameCompare;
-    const lineCompare = (l.location?.line ?? 0) - (r.location?.line ?? 0);
-    if (lineCompare !== 0)
-      return lineCompare;
-    return (l.location?.column ?? 0) - (r.location?.column ?? 0);
-  });
-  const groupedProblems = problems.reduce((acc, problem) => {
-    const locationHash = `${problem.file}:${problem.location?.line}:${problem.location?.column}`;
-    const list = acc.get(locationHash) ?? [];
-    list.push(problem);
-    acc.set(locationHash, list);
-    return acc;
-  }, /* @__PURE__ */ new Map());
-  console.log([...groupedProblems.values()].map(renderProblemGroup).join("\n"));
-  const files = Object.entries(
-    problems.reduce((acc, problem) => {
-      const file = "." + sep + relative(process.cwd(), problem.file);
-      acc[file] ??= 0;
-      acc[file]++;
-      return acc;
-    }, {})
-  );
-  const maxLength = files.reduce(
-    (prev, [file]) => Math.max(prev, file.length),
-    0
-  );
-  console.log();
-  console.log("Across " + plural(files.length, "File:", "Files:"));
-  files.forEach(([file, count]) => {
-    console.log(`${cyan(file.padEnd(maxLength, " "))} ${count}`);
-  });
-  console.log();
-  process.exit(problems.length);
-}
-async function findInstalledTools(opts) {
-  const status = await p(ALL_TOOLS).map(async (def) => {
-    const tool = await def(opts);
-    const isInstalled = !!opts.packageJson.devDependencies?.[tool.packageName];
-    return { tool, isInstalled };
-  }).promise;
-  if (isDebug()) {
-    const getTools = (isInstalled) => status.filter((item) => item.isInstalled === isInstalled).map((item) => item.tool.name).join(", ");
-    const installed = getTools(true);
-    debugLog(`Installed: ${installed || "(none)"}`);
-    const skipped = getTools(false);
-    debugLog(`Skipping: ${skipped || "(none)"} `);
-  }
-  return status.filter(({ isInstalled }) => isInstalled).map((item) => item.tool);
-}
-function plural(count, singular, plural2) {
-  return `${count} ${count === 1 ? singular : plural2} `;
-}
-export function renderProblemGroup(problems) {
-  const renderedProblems = problems.map(renderProblem);
-  const problem = problems[0];
-  const path = relative(process.cwd(), problem.file);
-  const location = problem.location ? `${path}:${problem.location.line}:${problem.location.column}` : path;
-  const link = dim(`\u2192 .${sep}${location}`);
-  return `${renderedProblems.join("\n")}
-  ${link}`;
-}
-export function renderProblem(problem) {
-  const icon = problem.kind === "warning" ? bold(yellow("\u26A0")) : bold(red("\u2717"));
-  const source = problem.rule ? dim(` (${problem.rule})`) : "";
-  return `${icon} ${problem.message}${source}`;
-}

package/dist/tasklist/index.d.ts

@@ -1,8 +0,0 @@
-export declare function createTaskList<TInput extends {
-    name: string;
-}, TResult = void>(inputs: TInput[], run: (ctx: {
-    input: TInput;
-    succeed: (title?: string) => void;
-    warn: (title?: string) => void;
-    fail: (title?: string) => void;
-}) => Promise<TResult>): Promise<TResult[]>;

package/dist/tasklist/index.mjs

@@ -1,78 +0,0 @@
-import { cyan, dim, green, red, yellow } from "../utils.mjs";
-import readline from "node:readline";
-export async function createTaskList(inputs, run) {
-  const states = inputs.map((item) => ({
-    title: item.name,
-    state: "pending"
-  }));
-  const isTty = process.stderr.isTTY;
-  let tick = 0;
-  const render = (opts) => {
-    if (isTty && !opts?.firstRender) {
-      readline.moveCursor(process.stderr, 0, -1 * states.length);
-    }
-    if (isTty || opts?.firstRender || opts?.lastRender) {
-      states.forEach(({ state, title }) => {
-        readline.clearLine(process.stderr, 0);
-        const frames = SPINNER_FRAMES[state];
-        process.stderr.write(`${frames[tick % frames.length]} ${title}
-`);
-      });
-    }
-    tick++;
-  };
-  render({ firstRender: true });
-  const renderInterval = setInterval(render, SPINNER_INTERVAL_MS);
-  try {
-    const result = await Promise.all(
-      inputs.map(async (input, i) => {
-        const succeed = (title) => {
-          if (title != null)
-            states[i].title = title;
-          states[i].state = "success";
-          render();
-        };
-        const warn = (title) => {
-          if (title != null)
-            states[i].title = title;
-          states[i].state = "warning";
-          render();
-        };
-        const fail = (title) => {
-          if (title != null)
-            states[i].title = title;
-          states[i].state = "error";
-          render();
-        };
-        try {
-          states[i].state = "in-progress";
-          render();
-          const res = await run({ input, succeed, warn, fail });
-          if (states[i].state === "in-progress")
-            states[i].state = "success";
-          render();
-          return res;
-        } catch (err) {
-          if (err instanceof Error)
-            fail(err.message);
-          else
-            fail(String(err));
-          render();
-          throw err;
-        }
-      })
-    );
-    render({ lastRender: true });
-    return result;
-  } finally {
-    clearInterval(renderInterval);
-  }
-}
-const SPINNER_INTERVAL_MS = 80;
-const SPINNER_FRAMES = {
-  pending: [dim("\u25A1")],
-  "in-progress": ["\u280B", "\u2819", "\u2839", "\u2838", "\u283C", "\u2834", "\u2826", "\u2827", "\u2807", "\u280F"].map(cyan),
-  success: [green("\u2714")],
-  warning: [yellow("\u26A0")],
-  error: [red("\u2717")]
-};

package/dist/tools/eslint.d.ts

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

package/dist/tools/eslint.mjs

@@ -1,41 +0,0 @@
-import { execAndParse } from "../utils.mjs";
-export const eslint = ({ root }) => {
-  const bin = "eslint";
-  const checkArgs = [
-    ".",
-    "--ext",
-    ".js,.ts,.jsx,.tsx,.mjs,.mts,.cjs,.cts,.vue",
-    "--format",
-    "compact",
-    "--max-warnings",
-    "0"
-  ];
-  const fixArgs = [...checkArgs, "--fix"];
-  return {
-    name: "ESLint",
-    packageName: "eslint",
-    check: () => execAndParse(bin, checkArgs, root, parseOutput),
-    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stdout, stderr }) => {
-  return `${stdout}
-${stderr}`.split(/\r?\n/).reduce((acc, line) => {
-    const groups = /^(?<file>.*?): line (?<line>[0-9]+), col (?<column>[0-9]+), (?<kind>\S+) - (?<message>.*?) \((?<rule>\S*?)\)$/.exec(
-      line
-    )?.groups;
-    if (groups) {
-      acc.push({
-        file: groups.file,
-        kind: groups.kind === "Warning" ? "warning" : "error",
-        message: groups.message,
-        location: {
-          line: parseInt(groups.line, 10),
-          column: parseInt(groups.column, 10)
-        },
-        rule: groups.rule
-      });
-    }
-    return acc;
-  }, []);
-};

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

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

package/dist/tools/eslint.test.mjs

@@ -1,35 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } from "./eslint.mjs";
-describe("ESLint", () => {
-  it("should properly parse output", async () => {
-    const stdout = `/path/to/check/demo/test.ts: line 1, col 7, Warning - 'test' is assigned a value but never used. (@typescript-eslint/no-unused-vars)
-/path/to/check/demo/test.ts: line 5, col 7, Error - 'variable' is assigned a value but never used. (@typescript-eslint/no-unused-vars)
-
-4 problems
-`;
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "/path/to/check/demo/test.ts",
-        message: "'test' is assigned a value but never used.",
-        kind: "warning",
-        location: {
-          line: 1,
-          column: 7
-        },
-        rule: "@typescript-eslint/no-unused-vars"
-      },
-      {
-        file: "/path/to/check/demo/test.ts",
-        message: "'variable' is assigned a value but never used.",
-        kind: "error",
-        location: {
-          line: 5,
-          column: 7
-        },
-        rule: "@typescript-eslint/no-unused-vars"
-      }
-    ]);
-  });
-});

package/dist/tools/index.d.ts

@@ -1 +0,0 @@
-export declare const ALL_TOOLS: import("..").ToolDefinition[];

package/dist/tools/index.mjs

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

package/dist/tools/markdownlint.d.ts

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

package/dist/tools/markdownlint.mjs

@@ -1,34 +0,0 @@
-import { execAndParse } from "../utils.mjs";
-export const markdownlint = ({ root }) => {
-  const bin = "markdownlint";
-  const checkArgs = [
-    ".",
-    "--json",
-    "--ignore='**/dist/**'",
-    "--ignore='**/node_modules/**'",
-    "--ignore='**/.output/**'",
-    "--ignore='**/coverage/**'"
-  ];
-  const fixArgs = [...checkArgs, "--fix"];
-  return {
-    name: "Markdownlint",
-    packageName: "markdownlint-cli",
-    check: () => execAndParse(bin, checkArgs, root, parseOutput),
-    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stderr: _stderr }) => {
-  const stderr = _stderr.trim();
-  if (!stderr)
-    return [];
-  return JSON.parse(stderr).map((warning) => ({
-    location: {
-      line: warning.lineNumber,
-      column: warning.errorRange?.[0] ?? 0
-    },
-    message: warning.ruleDescription,
-    file: warning.fileName,
-    kind: "warning",
-    rule: warning.ruleNames[0]
-  }));
-};

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

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

package/dist/tools/markdownlint.test.mjs

@@ -1,72 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } from "./markdownlint.mjs";
-describe("Markdownlint", () => {
-  it("should properly parse output", async () => {
-    const stdout = "";
-    const stderr = `
-[
-  {
-    "fileName": "docs/guide/resources/upgrading.md",
-    "lineNumber": 59,
-    "ruleNames": [
-      "MD031",
-      "blanks-around-fences"
-    ],
-    "ruleDescription": "Fenced code blocks should be surrounded by blank lines",
-    "ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md",
-    "errorDetail": null,
-    "errorContext": "\`\`\`ts",
-    "errorRange": null,
-    "fixInfo": {
-      "lineNumber": 59,
-      "insertText": "\\n"
-    }
-  },
-  {
-    "fileName": "CODE_OF_CONDUCT.md",
-    "lineNumber": 63,
-    "ruleNames": [
-      "MD034",
-      "no-bare-urls"
-    ],
-    "ruleDescription": "Bare URL used",
-    "ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md",
-    "errorDetail": null,
-    "errorContext": "example@gmail.com",
-    "errorRange": [
-      5,
-      23
-    ],
-    "fixInfo": {
-      "editColumn": 1,
-      "deleteCount": 23,
-      "insertText": "<example@gmail.com>"
-    }
-  }
-]
-`;
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "docs/guide/resources/upgrading.md",
-        message: "Fenced code blocks should be surrounded by blank lines",
-        location: {
-          line: 59,
-          column: 0
-        },
-        rule: "MD031",
-        kind: "warning"
-      },
-      {
-        file: "CODE_OF_CONDUCT.md",
-        message: "Bare URL used",
-        location: {
-          line: 63,
-          column: 5
-        },
-        rule: "MD034",
-        kind: "warning"
-      }
-    ]);
-  });
-});

package/dist/tools/oxlint.d.ts

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

package/dist/tools/oxlint.mjs

@@ -1,49 +0,0 @@
-import { execAndParse } from "../utils.mjs";
-export const oxlint = ({ root }) => {
-  const bin = "oxlint";
-  const checkArgs = [
-    "--format=unix",
-    "--deny-warnings",
-    "--ignore-path=.oxlintignore",
-    "--ignore-pattern='**/dist/**'",
-    "--ignore-pattern='**/node_modules/**'",
-    "--ignore-pattern='**/.output/**'",
-    "--ignore-pattern='**/coverage/**'"
-  ];
-  const fixArgs = [...checkArgs, "--fix"];
-  return {
-    name: "Oxlint",
-    packageName: "oxlint",
-    check: () => execAndParse(bin, checkArgs, root, parseOutput),
-    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stdout }) => {
-  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

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

package/dist/tools/oxlint.test.mjs

@@ -1,57 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } 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(parseOutput({ 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/dist/tools/prettier.d.ts

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

package/dist/tools/prettier.mjs

@@ -1,40 +0,0 @@
-import { execAndParse } from "../utils.mjs";
-export const prettier = ({ root }) => {
-  const bin = "prettier";
-  const checkArgs = [".", "--list-different"];
-  const fixArgs = [".", "-w"];
-  return {
-    name: "Prettier",
-    packageName: "prettier",
-    check: () => execAndParse(bin, checkArgs, root, parseOutput),
-    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stdout, stderr }) => {
-  if (stderr.trim()) {
-    return stderr.split(/\r?\n/).reduce((acc, line) => {
-      const groups = /^\[(?<kind>.+?)\]\s?(?<file>.+?):\s?(?<message>.*?)\s?\((?<line>[0-9]+):(?<column>[0-9]+)\)$/.exec(
-        line
-      )?.groups;
-      if (groups) {
-        acc.push({
-          file: groups.file,
-          kind: groups.kind === "error" ? "error" : "warning",
-          message: groups.message,
-          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/prettier.test.d.ts

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