@aklinker1/check 1.4.4 → 2.0.0-alpha.1

package/README.md

@@ -23,9 +23,6 @@ This project is built using [`bun`](https://bun.sh). Demo project uses PNPM.
 ```sh
 # Setup
 bun i
-pushd demo
-    pnpm i
-popd
 
 # Build NPM package
 bun run build
@@ -33,7 +30,6 @@ bun run build
 # Run checks
 bun check --help
 bun check
-bun check demo
 ```
 
 ### Adding Tools

package/dist/index.mjs

@@ -11,22 +11,23 @@ import {
   yellow
 } from "./utils.mjs";
 import { createTaskList } from "./tasklist/index.mjs";
-import { relative, resolve, sep } from "node:path";
+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(),
-    binDir = "node_modules/.bin"
-  } = 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, binDir }));
-  const tools = await findInstalledTools({ root, binDir });
+  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!");
@@ -103,7 +104,7 @@ export async function check(options = {}) {
 async function findInstalledTools(opts) {
   const status = await p(ALL_TOOLS).map(async (def) => {
     const tool = await def(opts);
-    const isInstalled = await tool.isInstalled();
+    const isInstalled = !!opts.packageJson.devDependencies?.[tool.packageName];
     return { tool, isInstalled };
   }).promise;
   if (isDebug()) {

package/dist/tools/eslint.d.ts

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

package/dist/tools/eslint.mjs

@@ -1,7 +1,6 @@
-import { isBinInstalled, execAndParse } from "../utils.mjs";
-import { resolve } from "node:path";
-export const eslint = ({ binDir, root }) => {
-  const bin = resolve(root, binDir, "eslint");
+import { execAndParse } from "../utils.mjs";
+export const eslint = ({ root }) => {
+  const bin = "eslint";
   const checkArgs = [
     ".",
     "--ext",
@@ -14,12 +13,12 @@ export const eslint = ({ binDir, root }) => {
   const fixArgs = [...checkArgs, "--fix"];
   return {
     name: "ESLint",
-    isInstalled: () => isBinInstalled(bin),
-    check: () => execAndParse(bin, checkArgs, root, parseOuptut),
-    fix: () => execAndParse(bin, fixArgs, root, parseOuptut)
+    packageName: "eslint",
+    check: () => execAndParse(bin, checkArgs, root, parseOutput),
+    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
   };
 };
-export const parseOuptut = ({ stdout, stderr }) => {
+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(

package/dist/tools/eslint.test.mjs

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "bun:test";
-import { parseOuptut } from "./eslint.mjs";
+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)
@@ -9,7 +9,7 @@ describe("ESLint", () => {
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    expect(parseOutput({ code, stdout, stderr })).toEqual([
       {
         file: "/path/to/check/demo/test.ts",
         message: "'test' is assigned a value but never used.",

package/dist/tools/oxlint.d.ts

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

package/dist/tools/oxlint.mjs

@@ -1,10 +1,10 @@
-import { execAndParse, isBinInstalled } from "../utils.mjs";
-import { resolve } from "node:path";
-export const oxlint = ({ binDir, root }) => {
-  const bin = resolve(root, binDir, "oxlint");
+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/**'",
@@ -13,12 +13,12 @@ export const oxlint = ({ binDir, root }) => {
   const fixArgs = [...checkArgs, "--fix"];
   return {
     name: "Oxlint",
-    isInstalled: () => isBinInstalled(bin),
-    check: () => execAndParse(bin, checkArgs, root, parseOuptut),
-    fix: () => execAndParse(bin, fixArgs, root, parseOuptut)
+    packageName: "oxlint",
+    check: () => execAndParse(bin, checkArgs, root, parseOutput),
+    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
   };
 };
-export const parseOuptut = ({ stdout, stderr }) => {
+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(

package/dist/tools/oxlint.test.mjs

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "bun:test";
-import { parseOuptut } from "./oxlint.mjs";
+import { parseOutput } from "./oxlint.mjs";
 describe("Oxlint", () => {
   it("should properly parse output", async () => {
     const stdout = `
@@ -12,7 +12,7 @@ test.ts:8:7: Missing initializer in const declaration [Error]
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    expect(parseOutput({ code, stdout, stderr })).toEqual([
       {
         file: "test.ts",
         message: "Variable 'test' is declared but never used.",

package/dist/tools/prettier.d.ts

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

package/dist/tools/prettier.mjs

@@ -1,17 +1,16 @@
-import { execAndParse, isBinInstalled } from "../utils.mjs";
-import { resolve } from "node:path";
-export const prettier = ({ binDir, root }) => {
-  const bin = resolve(root, binDir, "prettier");
+import { execAndParse } from "../utils.mjs";
+export const prettier = ({ root }) => {
+  const bin = "prettier";
   const checkArgs = [".", "--list-different"];
   const fixArgs = [".", "-w"];
   return {
     name: "Prettier",
-    isInstalled: () => isBinInstalled(bin),
-    check: () => execAndParse(bin, checkArgs, root, parseOuptut),
-    fix: () => execAndParse(bin, fixArgs, root, parseOuptut)
+    packageName: "prettier",
+    check: () => execAndParse(bin, checkArgs, root, parseOutput),
+    fix: () => execAndParse(bin, fixArgs, root, parseOutput)
   };
 };
-export const parseOuptut = ({ stdout, stderr }) => {
+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(

package/dist/tools/prettier.test.mjs

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "bun:test";
-import { parseOuptut } from "./prettier.mjs";
+import { parseOutput } from "./prettier.mjs";
 describe("Prettier", () => {
   it("should properly parse output", async () => {
     const stdout = `target/.rustc_info.json
@@ -7,7 +7,7 @@ describe("Prettier", () => {
   `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    expect(parseOutput({ code, stdout, stderr })).toEqual([
       {
         file: "target/.rustc_info.json",
         message: "Not formatted.",
@@ -24,7 +24,7 @@ describe("Prettier", () => {
     const stdout = "";
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([]);
+    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)
@@ -45,7 +45,7 @@ describe("Prettier", () => {
   .github/workflows/validate.yml 4ms
   .prettierrc.yml 0ms`;
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    expect(parseOutput({ code, stdout, stderr })).toEqual([
       {
         file: "src/components/CommitDiff.ts",
         message: "SyntaxError: Declaration or statement expected.",
@@ -73,6 +73,6 @@ describe("Prettier", () => {
 .github/workflows/validate.yml 4ms
 .prettierrc.yml 0ms`;
     const code = 0;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([]);
+    expect(parseOutput({ code, stdout, stderr })).toEqual([]);
   });
 });

package/dist/tools/publint.d.ts

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

package/dist/tools/publint.mjs

@@ -1,17 +1,14 @@
-import { isBinInstalled, execAndParse } from "../utils.mjs";
-import { resolve } from "node:path";
-const bin = "publint";
-const args = [];
-export const publint = ({ binDir, root }) => {
-  const bin2 = resolve(root, binDir, "publint");
-  const args2 = [];
+import { execAndParse } from "../utils.mjs";
+export const publint = ({ root }) => {
+  const bin = "publint";
+  const args = [];
   return {
     name: "Publint",
-    isInstalled: () => isBinInstalled(bin2),
-    check: () => execAndParse(bin2, args2, root, parseOuptut)
+    packageName: "publint",
+    check: () => execAndParse(bin, args, root, parseOutput)
   };
 };
-export const parseOuptut = ({ stdout }) => {
+export const parseOutput = ({ stdout }) => {
   let kind = "warning";
   return stdout.split(/\r?\n/).reduce((acc, line) => {
     if (line.includes("Errors:")) {

package/dist/tools/publint.test.mjs

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "bun:test";
-import { parseOuptut } from "./publint.mjs";
+import { parseOutput } from "./publint.mjs";
 describe("Publint", () => {
   it("should properly parse output", async () => {
     const stdout = `@aklinker1/check lint results:
@@ -12,7 +12,7 @@ Errors:
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    expect(parseOutput({ code, stdout, stderr })).toEqual([
       {
         file: "package.json",
         message: "Consider being better lolz.",

package/dist/tools/typescript.d.ts

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

package/dist/tools/typescript.mjs

@@ -1,30 +1,31 @@
-import { debug, execAndParse, isBinInstalled } from "../utils.mjs";
-import { resolve } from "node:path";
+import { debug, execAndParse } from "../utils.mjs";
 export const typescript = async ({
   root,
-  binDir
+  packageJson
 }) => {
   const tsc = {
-    bin: resolve(root, binDir, "tsc"),
+    name: "TypeScript",
+    bin: "tsc",
+    packageName: "typescript",
     args: ["--noEmit", "--pretty", "false"]
   };
   const vueTsc = {
-    bin: resolve(root, binDir, "vue-tsc"),
+    name: "TypeScript (Vue)",
+    bin: "vue-tsc",
+    packageName: "vue-tsc",
     args: ["--noEmit", "--pretty", "false"]
   };
-  const isVueTsc = await isBinInstalled(vueTsc.bin);
+  const isVueTsc = packageJson.devDependencies?.["vue-tsc"] !== void 0;
   debug("TypeScript: Is vue-tsc installed? " + isVueTsc);
   const cmd = isVueTsc ? vueTsc : tsc;
-  const name = isVueTsc ? "TypeScript (Vue)" : "Typescript";
   return {
-    name,
-    // Always check if tsc is installed
-    isInstalled: () => isBinInstalled(tsc.bin),
+    name: cmd.name,
+    packageName: cmd.packageName,
     // Execute the other TSC binary if necessary
-    check: async () => execAndParse(cmd.bin, cmd.args, root, parseOuptut)
+    check: async () => execAndParse(cmd.bin, cmd.args, root, parseOutput)
   };
 };
-export const parseOuptut = ({ stdout }) => {
+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

package/dist/tools/typescript.test.mjs

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "bun:test";
-import { parseOuptut } from "./typescript.mjs";
+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.
@@ -7,7 +7,7 @@ test.ts(5,24): error TS7006: Parameter 'a' implicitly has an 'any' type.
 `;
     const stderr = "";
     const code = 1;
-    expect(parseOuptut({ code, stdout, stderr })).toEqual([
+    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.",
@@ -35,7 +35,7 @@ test.ts(5,24): error TS7006: Parameter 'a' implicitly has an 'any' type.
       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(parseOuptut({ code, stdout, stderr })).toEqual([
+    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<...>'.`,

package/dist/types.d.ts

@@ -13,11 +13,10 @@ export interface CheckOptions {
      * Set to true to enable debug logs.
      */
     debug?: boolean;
-    binDir?: string;
 }
 export type ToolDefinition = (opts: {
     root: string;
-    binDir: string;
+    packageJson: any;
 }) => Promise<Tool> | Tool;
 export interface Tool {
     /**
@@ -25,9 +24,9 @@ export interface Tool {
      */
     name: string;
     /**
-     * Check if the tool is installed.
+     * The name of the package in your `package.json`. If present, this tool will be ran.
      */
-    isInstalled: () => Promise<boolean>;
+    packageName: string;
     /**
      * Run the tool, only checking for problems.
      */

package/dist/utils.d.ts

@@ -1,5 +1,4 @@
 import type { OutputParser, Problem } from "./types";
-export declare function isBinInstalled(bin: string): Promise<boolean>;
 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;

package/dist/utils.mjs

@@ -1,15 +1,4 @@
 import { spawn } from "node:child_process";
-import { stat } from "fs/promises";
-export async function isBinInstalled(bin) {
-  try {
-    if (isDebug())
-      debug(`Checking if binary exists: ${bin}`);
-    await stat(bin);
-    return true;
-  } catch (err) {
-    return false;
-  }
-}
 function exec(cmd, args, opts) {
   return new Promise((resolve, reject) => {
     const child = spawn(cmd, args, { ...opts, shell: true });

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@aklinker1/check",
-  "version": "1.4.4",
+  "version": "2.0.0-alpha.1",
+  "packageManager": "bun@1.2.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/aklinker1/check"
@@ -34,6 +35,12 @@
   "bin": {
     "check": "bin/check.mjs"
   },
+  "scripts": {
+    "build": "bunx --bun unbuild",
+    "check": "bun src/cli.ts",
+    "prepack": "bun run build",
+    "prepublish": "bun run build"
+  },
   "dependencies": {
     "@antfu/utils": "^0.7.7",
     "citty": "^0.1.6",
@@ -42,11 +49,9 @@
   "devDependencies": {
     "@types/bun": "latest",
     "publint": "^0.2.7",
+    "typescript": "^5.0.0",
     "unbuild": "latest"
   },
-  "peerDependencies": {
-    "typescript": "^5.0.0"
-  },
   "unbuild": {
     "entries": [
       {
@@ -61,10 +66,5 @@
     "excludeAuthors": [
       "aaronklinker1@gmail.com"
     ]
-  },
-  "scripts": {
-    "build": "bunx --bun unbuild",
-    "check": "bun src/cli.ts",
-    "prepublish": "bun run build"
   }
-}
+}

package/bin/check.mjs

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import "../dist/cli.mjs";