@geoql/vue-doctor 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vinayak Kulkarni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# `@geoql/vue-doctor`
+
+> Your agent writes bad Vue. This catches it.
+
+CLI auditor for Vue 3 apps. Detects anti-patterns, AI-slop, and best-practice violations via a hybrid pass over `@vue/compiler-sfc` template ASTs and `oxlint` (with its built-in `vue` plugin) for script-level rules.
+
+## Quickstart
+
+```bash
+npx -y @geoql/vue-doctor ./src
+```
+
+## CLI
+
+```
+vue-doctor [path] [--format text|json] [--config doctor.config.ts] [--fail-on error|warning]
+```
+
+| Flag        | Description                                                                |
+| ----------- | -------------------------------------------------------------------------- |
+| `--format`  | `text` (default) or `json`                                                 |
+| `--config`  | Path to `doctor.config.ts`. Defaults to `./doctor.config.ts` if it exists. |
+| `--fail-on` | `error` (default) or `warning` — threshold for non-zero exit code.         |
+
+Exit codes:
+
+| Code | Meaning                                                      |
+| ---- | ------------------------------------------------------------ |
+| 0    | No findings at/above `--fail-on` threshold (default: error). |
+| 1    | Findings at/above threshold.                                 |
+| 2    | Configuration error or scan failure.                         |
+
+## Architecture
+
+See [`docs/ARCHITECTURE.md`](../../docs/ARCHITECTURE.md).
+
+## License
+
+MIT © Vinayak Kulkarni

package/bin/vue-doctor.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from '../dist/index.js';
+const code = await run(process.argv);
+process.exit(code);

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+//#region src/cli.d.ts
+declare function run(argv?: string[]): Promise<number>;
+//#endregion
+export { run };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,44 @@
+import { resolve } from "node:path";
+import process from "node:process";
+import { audit, format, loadAuditConfig } from "@geoql/doctor-core";
+import { cac } from "cac";
+//#region src/cli.ts
+function isReporter(v) {
+	return v === "text" || v === "json";
+}
+function isSeverity(v) {
+	return v === "error" || v === "warning";
+}
+async function run(argv = process.argv) {
+	const cli = cac("vue-doctor");
+	cli.command("[path]", "Audit a Vue project").option("--format <kind>", "Output format (text|json)", { default: "text" }).option("--config <path>", "Path to doctor.config.ts").option("--fail-on <level>", "Exit non-zero on this severity or worse (error|warning)", { default: "error" }).action(async (path, flags) => {
+		const reporter = flags.format && isReporter(flags.format) ? flags.format : "text";
+		const failOn = flags.failOn && isSeverity(flags.failOn) ? flags.failOn : "error";
+		const rootDir = resolve(path ?? ".");
+		try {
+			const { config } = await loadAuditConfig(rootDir, flags.config);
+			const report = await audit({
+				...config,
+				rootDir,
+				failOn
+			});
+			const out = format(report, reporter);
+			process.stdout.write(out);
+			process.stdout.write("\n");
+			process.exitCode = report.exitCode;
+		} catch (err) {
+			const msg = err instanceof Error ? err.message : String(err);
+			process.stderr.write(`vue-doctor: ${msg}\n`);
+			process.exitCode = 2;
+		}
+	});
+	cli.help();
+	cli.version("0.0.0");
+	cli.parse(argv, { run: false });
+	await cli.runMatchedCommand();
+	return process.exitCode ?? 0;
+}
+//#endregion
+export { run };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["import { resolve } from 'node:path';\nimport process from 'node:process';\nimport {\n  audit,\n  format,\n  loadAuditConfig,\n  type ReporterFormat,\n} from '@geoql/doctor-core';\nimport { cac } from 'cac';\n\ninterface CliFlags {\n  format?: string;\n  config?: string;\n  failOn?: string;\n}\n\nfunction isReporter(v: string): v is ReporterFormat {\n  return v === 'text' || v === 'json';\n}\n\nfunction isSeverity(v: string): v is 'error' | 'warning' {\n  return v === 'error' || v === 'warning';\n}\n\nexport async function run(argv: string[] = process.argv): Promise<number> {\n  const cli = cac('vue-doctor');\n\n  cli\n    .command('[path]', 'Audit a Vue project')\n    .option('--format <kind>', 'Output format (text|json)', { default: 'text' })\n    .option('--config <path>', 'Path to doctor.config.ts')\n    .option(\n      '--fail-on <level>',\n      'Exit non-zero on this severity or worse (error|warning)',\n      {\n        default: 'error',\n      },\n    )\n    .action(async (path: string | undefined, flags: CliFlags) => {\n      const reporter =\n        flags.format && isReporter(flags.format) ? flags.format : 'text';\n      const failOn =\n        flags.failOn && isSeverity(flags.failOn) ? flags.failOn : 'error';\n      const rootDir = resolve(path ?? '.');\n\n      try {\n        const { config } = await loadAuditConfig(rootDir, flags.config);\n        const report = await audit({ ...config, rootDir, failOn });\n        const out = format(report, reporter);\n        process.stdout.write(out);\n        process.stdout.write('\\n');\n        process.exitCode = report.exitCode;\n      } catch (err) {\n        const msg = err instanceof Error ? err.message : String(err);\n        process.stderr.write(`vue-doctor: ${msg}\\n`);\n        process.exitCode = 2;\n      }\n    });\n\n  cli.help();\n  cli.version('0.0.0');\n  cli.parse(argv, { run: false });\n  await cli.runMatchedCommand();\n  return process.exitCode ?? 0;\n}\n"],"mappings":";;;;;AAgBA,SAAS,WAAW,GAAgC;CAClD,OAAO,MAAM,UAAU,MAAM;;AAG/B,SAAS,WAAW,GAAqC;CACvD,OAAO,MAAM,WAAW,MAAM;;AAGhC,eAAsB,IAAI,OAAiB,QAAQ,MAAuB;CACxE,MAAM,MAAM,IAAI,aAAa;CAE7B,IACG,QAAQ,UAAU,sBAAsB,CACxC,OAAO,mBAAmB,6BAA6B,EAAE,SAAS,QAAQ,CAAC,CAC3E,OAAO,mBAAmB,2BAA2B,CACrD,OACC,qBACA,2DACA,EACE,SAAS,SACV,CACF,CACA,OAAO,OAAO,MAA0B,UAAoB;EAC3D,MAAM,WACJ,MAAM,UAAU,WAAW,MAAM,OAAO,GAAG,MAAM,SAAS;EAC5D,MAAM,SACJ,MAAM,UAAU,WAAW,MAAM,OAAO,GAAG,MAAM,SAAS;EAC5D,MAAM,UAAU,QAAQ,QAAQ,IAAI;EAEpC,IAAI;GACF,MAAM,EAAE,WAAW,MAAM,gBAAgB,SAAS,MAAM,OAAO;GAC/D,MAAM,SAAS,MAAM,MAAM;IAAE,GAAG;IAAQ;IAAS;IAAQ,CAAC;GAC1D,MAAM,MAAM,OAAO,QAAQ,SAAS;GACpC,QAAQ,OAAO,MAAM,IAAI;GACzB,QAAQ,OAAO,MAAM,KAAK;GAC1B,QAAQ,WAAW,OAAO;WACnB,KAAK;GACZ,MAAM,MAAM,eAAe,QAAQ,IAAI,UAAU,OAAO,IAAI;GAC5D,QAAQ,OAAO,MAAM,eAAe,IAAI,IAAI;GAC5C,QAAQ,WAAW;;GAErB;CAEJ,IAAI,MAAM;CACV,IAAI,QAAQ,QAAQ;CACpB,IAAI,MAAM,MAAM,EAAE,KAAK,OAAO,CAAC;CAC/B,MAAM,IAAI,mBAAmB;CAC7B,OAAO,QAAQ,YAAY"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@geoql/vue-doctor",
+  "version": "0.1.0-alpha.0",
+  "private": false,
+  "description": "CLI auditor for Vue 3 apps. Detects anti-patterns, AI-slop, and best-practice violations via @vue/compiler-sfc + oxlint. Run with `npx -y @geoql/vue-doctor`.",
+  "keywords": [
+    "audit",
+    "cli",
+    "doctor",
+    "geoql",
+    "lint",
+    "oxlint",
+    "vue",
+    "vue3"
+  ],
+  "homepage": "https://github.com/geoql/doctor#readme",
+  "bugs": {
+    "url": "https://github.com/geoql/doctor/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Vinayak Kulkarni",
+    "email": "inbox.vinayak@gmail.com",
+    "url": "https://vinayakkulkarni.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/geoql/doctor.git",
+    "directory": "packages/vue-doctor"
+  },
+  "bin": {
+    "vue-doctor": "./bin/vue-doctor.mjs"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "cac": "^7.0.0",
+    "kolorist": "^1.8.0",
+    "oxlint": "^1.67.0",
+    "@geoql/doctor-core": "^0.1.0-alpha.0",
+    "@geoql/oxlint-plugin-vue-doctor": "0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "vp lint src",
+    "lint:fix": "vp lint src --fix",
+    "format": "vp fmt",
+    "format:check": "vp fmt --check",
+    "build": "vp pack",
+    "test": "vitest run"
+  }
+}