@aklinker1/check 1.0.0 → 1.0.1

package/README.md

@@ -1,12 +1,9 @@
 # Check
 
-An opinionated CLI tool to run all your checks all at once. The command will only exit with code 0 when no warnings exist.
+An opinionated CLI tool to run all your checks all at once. The command will only exit with code 0 when no problems exist.
 
 https://github.com/aklinker1/check/assets/10101283/c8089e5c-e25f-4f59-8897-d2a6f97a3139
 
-> [!WARNING]
-> I have not actually published this to NPM yet.
-
 ```sh
 pnpm i @aklinker1/check
 pnpm check

package/dist/index.mjs

@@ -3,8 +3,9 @@ import { p } from "@antfu/utils";
 import { bold, cyan, debug, 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, fix, root } = options;
+  const { debug: debug2, fix = !isCI, root } = options;
   if (debug2) {
     process.env.DEBUG = "true";
   }
@@ -20,24 +21,23 @@ export async function check(options = {}) {
     async ({ input: tool, fail, succeed, warn }) => {
       const startTime = performance.now();
       const fn = fix ? tool.fix ?? tool.check : tool.check;
-      const output = await fn(root);
-      if ("problems" in output) {
-        output.problems.forEach((problem) => {
-          problem.file = resolve(root ?? process.cwd(), problem.file);
-        });
-      }
+      const problems2 = await fn(root);
+      problems2.forEach((problem) => {
+        problem.file = resolve(root ?? process.cwd(), problem.file);
+      });
       const duration = humanMs(performance.now() - startTime);
       const title = `${tool.name} ${dim(`(${duration})`)}`;
-      if (output.type === "error")
+      const errorCount = problems2.filter((p2) => p2.kind === "error").length;
+      if (errorCount > 0)
         fail(title);
-      else if (output.type === "warning")
+      else if (problems2.length > 0)
         warn(title);
       else
         succeed(title);
-      return output;
+      return problems2;
     }
   );
-  const problems = results.flatMap((result) => result.type === "success" ? [] : result.problems).sort((l, r) => {
+  const problems = results.flat().sort((l, r) => {
     const nameCompare = l.file.localeCompare(r.file);
     if (nameCompare !== 0)
       return nameCompare;
@@ -72,8 +72,7 @@ export async function check(options = {}) {
     console.log(`${cyan(file.padEnd(maxLength, " "))} ${count}`);
   });
   console.log();
-  const failedChecks = results.filter((res) => res.type === "error").length;
-  process.exit(failedChecks);
+  process.exit(problems.length);
 }
 async function findInstalledTools(root) {
   const status = await p(ALL_TOOLS).map(async (tool) => ({

package/dist/tasklist/index.mjs

@@ -8,21 +8,23 @@ export async function createTaskList(inputs, run) {
   const isTty = process.stderr.isTTY;
   let tick = 0;
   const render = (opts) => {
-    if (!opts?.firstRender) {
+    if (isTty && !opts?.firstRender) {
       readline.moveCursor(process.stderr, 0, -1 * states.length);
     }
-    states.forEach(({ state, title }) => {
-      readline.clearLine(process.stderr, 0);
-      const frames = SPINNER_FRAMES[state];
-      process.stderr.write(`${frames[tick % frames.length]} ${title}
+    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 = Promise.all(
+    const result = await Promise.all(
       inputs.map(async (input, i) => {
         const succeed = (title) => {
           if (title != null)
@@ -46,22 +48,22 @@ export async function createTaskList(inputs, run) {
           states[i].state = "in-progress";
           render();
           const res = await run({ input, succeed, warn, fail });
-          if (states[i].state === "in-progress") {
+          if (states[i].state === "in-progress")
             states[i].state = "success";
-            render();
-          }
+          render();
           return res;
         } catch (err) {
           if (err instanceof Error)
             fail(err.message);
           else
             fail(String(err));
+          render();
           throw err;
         }
       })
     );
     render({ lastRender: true });
-    return await result;
+    return result;
   } finally {
     clearInterval(renderInterval);
   }

package/dist/tools/eslint.mjs

@@ -15,10 +15,8 @@ export const eslint = {
   check: (root) => execAndParse(root, bin, args, parseOuptut),
   fix: (root) => execAndParse(root, bin, [...args, "--fix"], parseOuptut)
 };
-export const parseOuptut = ({ code, stdout, stderr }) => {
-  if (code === 0)
-    return { type: "success" };
-  const problems = `${stdout}
+export const parseOuptut = ({ stdout, stderr }) => {
+  return `${stdout}
 ${stderr}`.split(/\r?\n/).reduce((acc, line) => {
     const match = /^(.*?): line ([0-9]+), col ([0-9]+), (\S+) - (.*?) \((\S*?)\)$/.exec(
       line
@@ -37,8 +35,4 @@ ${stderr}`.split(/\r?\n/).reduce((acc, line) => {
     }
     return acc;
   }, []);
-  return {
-    type: problems.some((problem) => problem.kind === "error") ? "error" : "warning",
-    problems
-  };
 };

package/dist/tools/eslint.test.mjs

@@ -9,30 +9,27 @@ describe("ESLint", () => {
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual({
-      type: "error",
-      problems: [
-        {
-          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"
+    expect(parseOuptut({ 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
         },
-        {
-          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"
-        }
-      ]
-    });
+        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.mjs

@@ -2,4 +2,4 @@ import { eslint } from "./eslint.mjs";
 import { prettier } from "./prettier.mjs";
 import { typescript } from "./typescript.mjs";
 import { publint } from "./publint.mjs";
-export const ALL_TOOLS = [prettier, typescript, eslint, publint];
+export const ALL_TOOLS = [publint, prettier, typescript, eslint];

package/dist/tools/prettier.mjs

@@ -1,25 +1,19 @@
 import { execAndParse, isBinInstalled } from "../utils.mjs";
 const bin = "node_modules/.bin/prettier";
 const checkArgs = [".", "--list-different"];
-const fixArgs = [".", "--fix"];
+const fixArgs = [".", "-w"];
 export const prettier = {
   name: "Prettier",
   isInstalled: (root) => isBinInstalled(bin, root),
   check: (root) => execAndParse(root, bin, checkArgs, parseOuptut),
   fix: (root) => execAndParse(root, bin, fixArgs, parseOuptut)
 };
-export const parseOuptut = ({ code, stdout }) => {
-  if (code === 0)
-    return { type: "success" };
-  const problems = stdout.trim().split(/\r?\n/).map(
+export const parseOuptut = ({ stdout }) => {
+  return stdout.trim().split(/\r?\n/).filter((line) => !!line).map(
     (line) => ({
       file: line.trim(),
       kind: "warning",
       message: "Not formatted."
     })
   );
-  return {
-    type: "warning",
-    problems
-  };
 };

package/dist/tools/prettier.test.mjs

@@ -3,24 +3,27 @@ import { parseOuptut } from "./prettier.mjs";
 describe("Prettier", () => {
   it("should properly parse output", async () => {
     const stdout = `target/.rustc_info.json
-test.ts
-`;
+  test.ts
+  `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual({
-      type: "warning",
-      problems: [
-        {
-          file: "target/.rustc_info.json",
-          message: "Not formatted.",
-          kind: "warning"
-        },
-        {
-          file: "test.ts",
-          message: "Not formatted.",
-          kind: "warning"
-        }
-      ]
-    });
+    expect(parseOuptut({ 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(parseOuptut({ code, stdout, stderr })).toEqual([]);
   });
 });

package/dist/tools/publint.mjs

@@ -6,11 +6,9 @@ export const publint = {
   isInstalled: (root) => isBinInstalled(bin, root),
   check: (root) => execAndParse(root, bin, args, parseOuptut)
 };
-export const parseOuptut = ({ code, stdout, stderr }) => {
-  if (code === 0)
-    return { type: "success" };
+export const parseOuptut = ({ stdout }) => {
   let kind = "warning";
-  const problems = stdout.split(/\r?\n/).reduce((acc, line) => {
+  return stdout.split(/\r?\n/).reduce((acc, line) => {
     if (line.includes("Errors:")) {
       kind = "error";
       return acc;
@@ -25,8 +23,4 @@ export const parseOuptut = ({ code, stdout, stderr }) => {
     });
     return acc;
   }, []);
-  return {
-    type: kind,
-    problems
-  };
 };

package/dist/tools/publint.test.mjs

@@ -12,25 +12,22 @@ Errors:
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual({
-      type: "error",
-      problems: [
-        {
-          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"
-        }
-      ]
-    });
+    expect(parseOuptut({ 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.mjs

@@ -6,10 +6,8 @@ export const typescript = {
   isInstalled: (root) => isBinInstalled(bin, root),
   check: (root) => execAndParse(root, bin, checkArgs, parseOuptut)
 };
-export const parseOuptut = ({ code, stdout }) => {
-  if (code === 0)
-    return { type: "success" };
-  const problems = stdout.split(/\r?\n/).reduce((acc, line) => {
+export const parseOuptut = ({ stdout }) => {
+  return stdout.split(/\r?\n/).reduce((acc, line) => {
     const match = /^(\S+?)\(([0-9]+),([0-9]+)\): \w+? (TS[0-9]+): (.*)$/.exec(
       line
     );
@@ -27,8 +25,4 @@ export const parseOuptut = ({ code, stdout }) => {
     }
     return acc;
   }, []);
-  return {
-    type: "error",
-    problems
-  };
 };

package/dist/tools/typescript.test.mjs

@@ -7,30 +7,27 @@ test.ts(5,24): error TS7006: Parameter 'a' implicitly has an 'any' type.
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual({
-      type: "error",
-      problems: [
-        {
-          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"
+    expect(parseOuptut({ 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
         },
-        {
-          file: "test.ts",
-          message: "Parameter 'a' implicitly has an 'any' type.",
-          kind: "error",
-          location: {
-            line: 5,
-            column: 24
-          },
-          rule: "TS7006"
-        }
-      ]
-    });
+        rule: "TS2355"
+      },
+      {
+        file: "test.ts",
+        message: "Parameter 'a' implicitly has an 'any' type.",
+        kind: "error",
+        location: {
+          line: 5,
+          column: 24
+        },
+        rule: "TS7006"
+      }
+    ]);
   });
 });

package/dist/types.d.ts

@@ -1,6 +1,8 @@
 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;
     /**
@@ -24,23 +26,11 @@ export interface Tool {
     /**
      * Run the tool, only checking for problems.
      */
-    check: (root: string | undefined) => Promise<Output>;
+    check: (root: string | undefined) => Promise<Problem[]>;
     /**
      * Run the tool, but fix problems if possible. If the tool doesn't support fixing problems, `check` will be called instead.
      */
-    fix?: (root: string | undefined) => Promise<Output>;
-}
-export type Output = OutputSuccess | OutputWarning | OutputError;
-export interface OutputSuccess {
-    type: "success";
-}
-export interface OutputWarning {
-    type: "warning";
-    problems: Problem[];
-}
-export interface OutputError {
-    type: "error";
-    problems: Problem[];
+    fix?: (root: string | undefined) => Promise<Problem[]>;
 }
 export interface Problem {
     location?: CodeLocation;
@@ -58,4 +48,4 @@ export type OutputParser = (data: {
     code: number;
     stdout: string;
     stderr: string;
-}) => Output;
+}) => Problem[];

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
-import type { OutputParser, Output } from "./types";
+import type { OutputParser, Problem } from "./types";
 export declare function isBinInstalled(bin: string, root?: string): Promise<boolean>;
-export declare function execAndParse(root: string | undefined, bin: string, args: string[], parser: OutputParser): Promise<Output>;
+export declare function execAndParse(root: string | undefined, bin: string, args: string[], parser: OutputParser): Promise<Problem[]>;
 export declare function isDebug(): boolean;
 export declare const bold: (str: string) => string;
 export declare const dim: (str: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aklinker1/check",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "exports": {
     ".": {
@@ -10,18 +10,16 @@
   },
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "bin": {
     "check": "bin/check.mjs"
   },
-  "scripts": {
-    "build": "bunx unbuild",
-    "check": "bun src/cli.ts",
-    "prepublish": "bun build"
-  },
   "dependencies": {
     "@antfu/utils": "^0.7.7",
-    "citty": "^0.1.6"
+    "citty": "^0.1.6",
+    "ci-info": "^4.0.0"
   },
   "devDependencies": {
     "@types/bun": "latest",
@@ -40,5 +38,10 @@
       }
     ],
     "declaration": true
+  },
+  "scripts": {
+    "build": "bunx --bun unbuild",
+    "check": "bun src/cli.ts",
+    "prepublish": "bun run build"
   }
-}
+}