@aklinker1/check 2.1.0 → 2.1.2

package/dist/tools/prettier.test.mjs

@@ -1,78 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } from "./prettier.mjs";
-describe("Prettier", () => {
-  it("should properly parse output", async () => {
-    const stdout = `target/.rustc_info.json
-  test.ts
-  `;
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "target/.rustc_info.json",
-        message: "Not formatted.",
-        kind: "warning"
-      },
-      {
-        file: "test.ts",
-        message: "Not formatted.",
-        kind: "warning"
-      }
-    ]);
-  });
-  it("return no problems when there isn't any output", async () => {
-    const stdout = "";
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([]);
-  });
-  it("should return an error when a syntax error is reported", async () => {
-    const stderr = `[error] src/components/CommitDiff.ts: SyntaxError: Declaration or statement expected. (15:1)
-[error]   13 | });
-[error]   14 |
-[error] > 15 | }
-[error]      | ^
-[error]   16 |
-[error] src/components/CompareDiff.ts: Some other error message. (14:1)
-[error]   12 | });
-[error]   13 |
-[error] > 14 | }
-[error]      | ^
-[error]   15 |
-`;
-    const stdout = `.github/assets/privacy-policy.md 18ms
-  .github/workflows/submit.yml 20ms
-  .github/workflows/validate.yml 4ms
-  .prettierrc.yml 0ms`;
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "src/components/CommitDiff.ts",
-        message: "SyntaxError: Declaration or statement expected.",
-        location: {
-          line: 15,
-          column: 1
-        },
-        kind: "error"
-      },
-      {
-        file: "src/components/CompareDiff.ts",
-        message: "Some other error message.",
-        location: {
-          line: 14,
-          column: 1
-        },
-        kind: "error"
-      }
-    ]);
-  });
-  it("should not report warnings for fix output", () => {
-    const stderr = "";
-    const stdout = `.github/assets/privacy-policy.md 18ms
-.github/workflows/submit.yml 20ms
-.github/workflows/validate.yml 4ms
-.prettierrc.yml 0ms`;
-    const code = 0;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([]);
-  });
-});

package/dist/tools/publint.d.ts

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

package/dist/tools/publint.mjs

@@ -1,28 +0,0 @@
-import { execAndParse } from "../utils.mjs";
-export const publint = ({ root }) => {
-  const bin = "publint";
-  const args = [];
-  return {
-    name: "Publint",
-    packageName: "publint",
-    check: () => execAndParse(bin, args, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stdout }) => {
-  let kind = "warning";
-  return stdout.split(/\r?\n/).reduce((acc, line) => {
-    if (line.includes("Errors:")) {
-      kind = "error";
-      return acc;
-    }
-    const groups = /^[0-9]+\.\s?(?<message>.*)$/.exec(line)?.groups;
-    if (groups == null)
-      return acc;
-    acc.push({
-      kind,
-      message: groups.message,
-      file: "package.json"
-    });
-    return acc;
-  }, []);
-};

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

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

package/dist/tools/publint.test.mjs

@@ -1,33 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } from "./publint.mjs";
-describe("Publint", () => {
-  it("should properly parse output", async () => {
-    const stdout = `@aklinker1/check lint results:
-Suggestions:
-1. Consider being better lolz.
-Warnings:
-1. pkg.exports["."].import types is not exported. Consider adding pkg.exports["."].import.types: "./dist/index.d.ts" to be compatible with TypeScript's "moduleResolution": "bundler" compiler option.
-Errors:
-1. pkg.module is ./dist/index.cjs but the file does not exist.
-`;
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "package.json",
-        message: "Consider being better lolz.",
-        kind: "warning"
-      },
-      {
-        file: "package.json",
-        message: `pkg.exports["."].import types is not exported. Consider adding pkg.exports["."].import.types: "./dist/index.d.ts" to be compatible with TypeScript's "moduleResolution": "bundler" compiler option.`,
-        kind: "warning"
-      },
-      {
-        file: "package.json",
-        message: "pkg.module is ./dist/index.cjs but the file does not exist.",
-        kind: "error"
-      }
-    ]);
-  });
-});

package/dist/tools/typescript.d.ts

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

package/dist/tools/typescript.mjs

@@ -1,47 +0,0 @@
-import { debug, execAndParse } from "../utils.mjs";
-export const typescript = async ({
-  root,
-  packageJson
-}) => {
-  const tsc = {
-    name: "TypeScript",
-    bin: "tsc",
-    packageName: "typescript",
-    args: ["--noEmit", "--pretty", "false"]
-  };
-  const vueTsc = {
-    name: "TypeScript (Vue)",
-    bin: "vue-tsc",
-    packageName: "vue-tsc",
-    args: ["--noEmit", "--pretty", "false"]
-  };
-  const isVueTsc = packageJson.devDependencies?.["vue-tsc"] !== void 0;
-  debug("TypeScript: Is vue-tsc installed? " + isVueTsc);
-  const cmd = isVueTsc ? vueTsc : tsc;
-  return {
-    name: cmd.name,
-    packageName: cmd.packageName,
-    // Execute the other TSC binary if necessary
-    check: async () => execAndParse(cmd.bin, cmd.args, root, parseOutput)
-  };
-};
-export const parseOutput = ({ stdout }) => {
-  return stdout.split(/\r?\n/).reduce((acc, line) => {
-    const groups = /^(?<file>\S+?)\((?<line>[0-9]+),(?<column>[0-9]+)\): \w+? (?<rule>TS[0-9]+): (?<message>.*)$/.exec(
-      line
-    )?.groups;
-    if (groups) {
-      acc.push({
-        file: groups.file,
-        kind: "error",
-        message: groups.message,
-        location: {
-          line: parseInt(groups.line, 10),
-          column: parseInt(groups.column, 10)
-        },
-        rule: groups.rule
-      });
-    }
-    return acc;
-  }, []);
-};

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

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

package/dist/tools/typescript.test.mjs

@@ -1,51 +0,0 @@
-import { describe, it, expect } from "bun:test";
-import { parseOutput } from "./typescript.mjs";
-describe("TypeScript", () => {
-  it("should properly parse output", async () => {
-    const stdout = `test.ts(1,19): error TS2355: A function whose declared type is neither 'undefined', 'void', nor 'any' must return a value.
-test.ts(5,24): error TS7006: Parameter 'a' implicitly has an 'any' type.
-`;
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "test.ts",
-        message: "A function whose declared type is neither 'undefined', 'void', nor 'any' must return a value.",
-        kind: "error",
-        location: {
-          line: 1,
-          column: 19
-        },
-        rule: "TS2355"
-      },
-      {
-        file: "test.ts",
-        message: "Parameter 'a' implicitly has an 'any' type.",
-        kind: "error",
-        location: {
-          line: 5,
-          column: 24
-        },
-        rule: "TS7006"
-      }
-    ]);
-  });
-  it("should parse vue-tsc output", () => {
-    const stdout = `src/components/CustomListsPref.vue(46,6): error TS2345: Argument of type '{ vale: string; }' is not assignable to parameter of type 'Partial<{}> & Omit<{ readonly value: string; "onUpdate:value"?: ((newValue: string) => any) | undefined; } & VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<...> & { ...; }, never> & Record<...>'.
-      Property 'value' is missing in type '{ vale: string; }' but required in type 'Omit<{ readonly value: string; "onUpdate:value"?: ((newValue: string) => any) | undefined; } & VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<...> & { ...; }, never>'.`;
-    const stderr = "";
-    const code = 1;
-    expect(parseOutput({ code, stdout, stderr })).toEqual([
-      {
-        file: "src/components/CustomListsPref.vue",
-        message: `Argument of type '{ vale: string; }' is not assignable to parameter of type 'Partial<{}> & Omit<{ readonly value: string; "onUpdate:value"?: ((newValue: string) => any) | undefined; } & VNodeProps & AllowedComponentProps & ComponentCustomProps & Readonly<...> & { ...; }, never> & Record<...>'.`,
-        kind: "error",
-        location: {
-          line: 46,
-          column: 6
-        },
-        rule: "TS2345"
-      }
-    ]);
-  });
-});

package/dist/types.d.ts

@@ -1,55 +0,0 @@
-export interface CheckOptions {
-    /**
-     * Set to true to fix problems that can be automatically fixed.
-     *
-     * Defaults to `true` outside CI, and `false` inside CI.
-     */
-    fix?: boolean;
-    /**
-     * Directory to run commands in.
-     */
-    root?: string;
-    /**
-     * Set to true to enable debug logs.
-     */
-    debug?: boolean;
-}
-export type ToolDefinition = (opts: {
-    root: string;
-    packageJson: any;
-}) => Promise<Tool> | Tool;
-export interface Tool {
-    /**
-     * Name of tool shown in the console output.
-     */
-    name: string;
-    /**
-     * The name of the package in your `package.json`. If present, this tool will be ran.
-     */
-    packageName: string;
-    /**
-     * Run the tool, only checking for problems.
-     */
-    check: () => Promise<Problem[]>;
-    /**
-     * Run the tool, but fix problems if possible. If the tool doesn't support fixing problems, `check` will be called instead.
-     */
-    fix?: () => Promise<Problem[]>;
-}
-export interface Problem {
-    location?: CodeLocation;
-    message: string;
-    file: string;
-    kind: ProblemKind;
-    rule?: string;
-}
-export interface CodeLocation {
-    line: number;
-    column: number;
-}
-export type ProblemKind = "warning" | "error";
-export type OutputParser = (data: {
-    code: number;
-    stdout: string;
-    stderr: string;
-}) => Problem[];

package/dist/utils.d.ts

@@ -1,11 +0,0 @@
-import type { OutputParser, Problem } from "./types";
-export declare function execAndParse(bin: string, args: string[], cwd: string, parser: OutputParser): Promise<Problem[]>;
-export declare function isDebug(): boolean;
-export declare const bold: (str: string) => string;
-export declare const dim: (str: string) => string;
-export declare const red: (str: string) => string;
-export declare const green: (str: string) => string;
-export declare const yellow: (str: string) => string;
-export declare const cyan: (str: string) => string;
-export declare function humanMs(ms: number): string;
-export declare function debug(message: string): void;

package/dist/utils.mjs

@@ -1,50 +0,0 @@
-import { spawn } from "node:child_process";
-function exec(cmd, args, opts) {
-  return new Promise((resolve, reject) => {
-    const child = spawn(cmd, args, { ...opts, shell: true });
-    let stderr = "";
-    let stdout = "";
-    child.stdout.on("data", (data) => {
-      stdout += data.toString();
-    });
-    child.stderr.on("data", (data) => {
-      stderr += data.toString();
-    });
-    child.on("error", (error) => {
-      reject(error);
-    });
-    child.on("close", (exitCode) => {
-      resolve({ stderr, stdout, exitCode });
-    });
-  });
-}
-export async function execAndParse(bin, args, cwd, parser) {
-  const res = await exec(bin, args, { cwd });
-  if (res.exitCode == null)
-    throw Error("Exit code was null");
-  if (isDebug())
-    console.debug({ bin, args, cwd, ...res });
-  return parser({
-    code: res.exitCode,
-    stderr: res.stderr,
-    stdout: res.stdout
-  });
-}
-export function isDebug() {
-  return process.env.DEBUG === "true" || process.env.DEBUG === "1";
-}
-export const bold = (str) => `\x1B[1m${str}\x1B[0m`;
-export const dim = (str) => `\x1B[2m${str}\x1B[0m`;
-export const red = (str) => `\x1B[31m${str}\x1B[0m`;
-export const green = (str) => `\x1B[32m${str}\x1B[0m`;
-export const yellow = (str) => `\x1B[33m${str}\x1B[0m`;
-export const cyan = (str) => `\x1B[36m${str}\x1B[0m`;
-export function humanMs(ms) {
-  const minutes = Math.floor(ms / 6e4);
-  const seconds = (ms % 6e4 / 1e3).toFixed(minutes > 0 ? 0 : 3);
-  return `${minutes > 0 ? `${minutes}m ` : ""}${seconds}s`;
-}
-export function debug(message) {
-  if (isDebug())
-    console.debug(dim("\u2699 " + message));
-}