vortix-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vortix Contributors
+
+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,80 @@
+# Vortix CLI
+
+[![npm](https://img.shields.io/npm/v/vortix-cli.svg)](https://www.npmjs.com/package/vortix-cli)
+[![CI](https://github.com/jannikmenzel/vortix-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/jannikmenzel/vortix-cli/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Node](https://img.shields.io/badge/node-%3E%3D20-339933?logo=node.js&logoColor=white)](package.json)
+
+Local, no-account CLI that audits static sites for performance, security, accessibility, bugs, SEO, maintainability & privacy issues. Auto-detects Astro, Eleventy, Next.js, Nuxt, SvelteKit, Gatsby, Docusaurus, VuePress, Gridsome, Vite, MkDocs, Zola, Hugo, Hexo, Jekyll — or any generator via its output folder.
+
+## Quick Start
+
+```bash
+npm install -D vortix-cli
+npx vortix init
+npx vortix check
+```
+
+Node.js `>=20` required. Chromium downloads automatically via `@playwright/browser-chromium`.
+
+## Commands
+
+```bash
+npx vortix check
+npx vortix check https://example.com
+npx vortix ci
+```
+
+Checks run in one of three modes: **static** (built files on disk), **dynamic** (headless browser), **live** (a real HTTP request — only when you pass a URL, otherwise shown as skipped).
+
+## Config
+
+`vortix init` writes `.vortix/config.json`:
+
+```json
+{
+  "target": { "adapter": "astro" },
+  "categories": { "performance": true, "security": true, "privacy": false },
+  "failOn": "error",
+  "performance": { "budgets": { "lcpMs": 2500, "cls": 0.1, "maxPageWeightKb": 1500 } },
+  "checks": ["./checks/no-todo-comments.js"]
+}
+```
+
+## Custom checks
+
+```js
+// ./checks/no-todo-comments.js
+import { defineCheck } from "vortix-cli";
+
+export default defineCheck({
+  id: "custom.no-todo-comments",
+  category: "maintainability",
+  mode: "static",
+  severity: "warn",
+  async run(ctx) {
+    const files = await ctx.glob("src/**/*.{astro,md}");
+    return files.filter((f) => ctx.readFile(f).includes("TODO")).map((f) => ctx.finding({ message: "Found a TODO", file: f }));
+  },
+});
+```
+
+Reference a local path or a published npm package in `checks: []`.
+
+## Included checks
+
+| Category | Checks |
+|---|---|
+| Performance | Core Web Vitals budget, page weight & image size, image formats, lazy loading, third-party impact |
+| Security | `npm audit`, mixed content, security headers, HTTPS enforcement, server info disclosure, cookie security |
+| Accessibility | WCAG 2.1 A/AA (axe-core), color contrast |
+| Bugs | Broken links/images/assets, dangling anchors, invalid nesting, viewport meta, console errors |
+| SEO | Meta/OG tags, OG images, canonical URL, structured data, robots.txt/sitemap |
+| Maintainability | Code duplication, outdated deps, dead CSS, license check |
+| Privacy | Tracking requests, external fonts/APIs, fingerprinting APIs |
+
+Each run ends in a 0–100 score (A–F), averaged per-check → per-category so no category drowns out another. Any `error`-severity finding caps the grade at "C", regardless of the average.
+
+## License
+
+[MIT](./LICENSE)

package/dist/adapters/index.d.ts

@@ -0,0 +1,5 @@
+import type { ResolvedConfig } from "@core/types.js";
+import type { Adapter } from "./types.js";
+export declare const BUILT_IN_ADAPTERS: Adapter[];
+export declare function detectAdapter(cwd: string): Adapter | undefined;
+export declare function resolveAdapter(cwd: string, target: ResolvedConfig["target"], build: boolean): Adapter;

package/dist/adapters/types.d.ts

@@ -0,0 +1,13 @@
+export interface Adapter {
+    name: string;
+    detect(cwd: string): boolean;
+    buildCommand: string;
+    outputDir: string;
+    /**
+     * Resolves the directory that is actually scanned and served, for build tools that nest the
+     * servable output in a subfolder of `outputDir` (e.g. Astro's SSR adapters split it into
+     * `dist/client` and `dist/server`). Called after the build with the resolved absolute
+     * `outputDir` and returns an absolute path. Defaults to `outputDir` when omitted.
+     */
+    resolveServeDir?(outputDir: string): string;
+}

package/dist/checks/accessibility/axe.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../../index.js").CheckDefinition;
+export default _default;

package/dist/checks/accessibility/color-contrast.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/accessibility/run-axe.d.ts

@@ -0,0 +1,6 @@
+import { AxeBuilder } from "@axe-core/playwright";
+import type { Severity } from "@core/types.js";
+import type { Page } from "playwright";
+export type AxeResults = Awaited<ReturnType<AxeBuilder["analyze"]>>;
+export declare const IMPACT_SEVERITY: Record<string, Severity>;
+export declare function runAxe(page: Page): Promise<AxeResults>;

package/dist/checks/bugs/anchor-links.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/bugs/broken-links.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/bugs/console-errors.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../..").CheckDefinition;
+export default _default;

package/dist/checks/bugs/nested-block-elements.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/bugs/viewport-meta.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/index.d.ts

@@ -0,0 +1,2 @@
+import type { CheckDefinition } from "@core/types.js";
+export declare const BUILT_IN_CHECKS: CheckDefinition[];

package/dist/checks/maintainability/dead-css.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/maintainability/duplication.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../..").CheckDefinition;
+export default _default;

package/dist/checks/maintainability/license-check.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/maintainability/outdated-dependencies.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../..").CheckDefinition;
+export default _default;

package/dist/checks/performance/asset-weight.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/performance/core-web-vitals.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/performance/image-format.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/performance/lazy-loading.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/performance/third-party-impact.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/privacy/external-fonts.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../../index.js").CheckDefinition;
+export default _default;

package/dist/checks/privacy/fingerprinting.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/privacy/match-domains.d.ts

@@ -0,0 +1,2 @@
+import type { CapturedNetworkRequest } from "@core/types.js";
+export declare function uniqueUrlsMatchingDomains(requests: CapturedNetworkRequest[], domains: string[]): string[];

package/dist/checks/privacy/tracker-requests.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../../index.js").CheckDefinition;
+export default _default;

package/dist/checks/security/cookie-security.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/security/dependency-vulnerabilities.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/security/https-enforced.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../..").CheckDefinition;
+export default _default;

package/dist/checks/security/mixed-content.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/security/security-headers.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/security/server-info-disclosure.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/seo/canonical-url.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/seo/meta-tags.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/seo/og-images.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/seo/robots-sitemap.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/checks/seo/structured-data.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@core/types.js").CheckDefinition;
+export default _default;

package/dist/chunk-KNVCFVGJ.js

@@ -0,0 +1,183 @@
+// src/messages/en.json
+var en_default = {
+  cli: {
+    description: "Swiss-army-knife CLI for quality checks on static websites.",
+    init: { description: "Interactively configure vortix for this project" },
+    config: { description: "Adjust vortix settings for this project" },
+    check: { description: "Run checks locally with a human-readable report" },
+    ci: { description: "Run checks non-interactively \u2014 JSON output + exit code for automation" }
+  },
+  errors: {
+    outputDirMissing: 'Output directory "{dir}" does not exist after the build. Check target.outputDir in .vortix/config.json.',
+    noPagesFound: 'No HTML pages found in "{dir}" \u2014 nothing to check. This usually means target.outputDir is misconfigured or the build produced no output.',
+    unknownAdapter: 'Unknown adapter "{name}". Available: {available}',
+    noGeneratorOutputDir: "No static site generator detected. Set target.outputDir manually in .vortix/config.json.",
+    noGeneratorBuildCommand: "No static site generator detected. Set target.buildCommand manually, or build: false if the output is already built.",
+    configRead: "Failed to read .vortix/config.json: {message}",
+    configParse: "Failed to parse .vortix/config.json: {message}",
+    checkCrashed: "Check crashed: {message}",
+    buildFailed: 'Build command "{command}" failed: {message}',
+    pageCrashed: 'Page "{url}" could not be loaded for dynamic checks: {message}'
+  },
+  progress: {
+    building: "Building project",
+    buildDone: "Build done",
+    staticStart: "Static checks ({index}/{total})",
+    staticRunning: "Static checks ({index}/{total}): {name}",
+    staticDone: "Static checks done ({total})",
+    dynamicStart: "Dynamic checks ({index}/{total})",
+    dynamicPageRunning: "Checking page {index}/{total}: {urlPath}",
+    dynamicPageDone: "Dynamic checks ({index}/{total})",
+    dynamicDone: "Dynamic checks done ({total} pages)",
+    playwrightMissing: "Playwright browsers not installed \u2014 run `npx playwright install chromium`",
+    liveStart: "Live checks against {url} ({total})",
+    liveRunning: "Live checks ({index}/{total}): {name}",
+    liveDone: "Live checks done ({total})",
+    liveNoUrl: "no live URL given \u2014 run `vortix check <url>` (or `vortix ci <url>`) to include this check"
+  },
+  init: {
+    intro: "Vortix init",
+    detectedStack: "Detected stack: {name}. Use it?",
+    noGeneratorDetected: "No known static site generator detected.",
+    pickStack: "Which stack are you using?",
+    manualOption: "Other / configure manually",
+    pickCategories: "Which categories should be enabled?",
+    pickFailOn: "At which severity level should `vortix ci` fail?",
+    failOnRecommended: "error (recommended)",
+    configExists: ".vortix/config.json already exists. Overwrite?",
+    aborted: "Aborted.",
+    abortedKept: "Aborted \u2014 existing config was not changed.",
+    done: "Configuration saved to .vortix/config.json. Get started with: {cmd}",
+    pickGithubWorkflow: "Set up a GitHub Actions workflow that runs `vortix ci` on every push and pull request?",
+    githubWorkflowExists: "{path} already exists. Overwrite?",
+    githubWorkflowDone: "GitHub Actions workflow written to {path}",
+    githubWorkflowSkipped: "Skipped \u2014 existing workflow was not changed."
+  },
+  config: {
+    intro: "Vortix config",
+    corrupt: ".vortix/config.json is corrupt, starting fresh.",
+    noConfig: "No config found. Let's set one up.",
+    done: "Configuration updated in .vortix/config.json"
+  },
+  report: {
+    header: "Vortix \u2014 adapter: {adapter} \xB7 static checks: {totalPages} pages \xB7 dynamic checks: {pagesChecked}/{totalPages} pages",
+    headerLiveSuffix: " \xB7 live checks: {url}",
+    moreFindingsSuffix: " (+{count} more)",
+    configErrorPrefix: "Custom check failed to load",
+    overallScoreLabel: "Overall score",
+    byCategoryLabel: "By category",
+    scoreCappedNote: "capped at C: at least one error-level finding",
+    scorePartialPagesNote: "based on {pagesChecked}/{totalPages} pages \u2014 some dynamic checks (accessibility, performance, console errors, tracking, fonts) were skipped. Use `vortix check` for a full-site score.",
+    scoreLiveSkippedNote: "live checks (security headers, HTTPS, cookies, ...) were skipped \u2014 pass a URL to include them, e.g. `vortix check https://example.com`.",
+    copyPrompt: "Copy report to clipboard?",
+    copied: "Report copied to clipboard",
+    copyFailed: "Could not copy report to clipboard \u2014 no clipboard utility found (install xclip, xsel, or wl-copy on Linux)",
+    detailSelectPrompt: "Select a check for details",
+    detailDoneOption: "Done \u2014 continue",
+    detailContinuePrompt: "Press Enter to continue",
+    detailBackOption: "Back to the check list",
+    detailStatusPass: "Status: passed",
+    detailStatusIssues: "Status: {summary}",
+    detailStatusSkipped: "Status: skipped \u2014 {reason}",
+    detailFindingsHeader: "Findings:",
+    detailNoFindings: "No issues found.",
+    detailValuesHeader: "Measured values:",
+    detailNoValues: "No measured values reported by this check."
+  }
+};
+
+// src/core/messages.ts
+function resolve(key) {
+  const value = key.split(".").reduce((node, segment) => node?.[segment], en_default);
+  if (typeof value !== "string") throw new Error(`Unknown message key: "${key}"`);
+  return value;
+}
+function t(key, params) {
+  const template = resolve(key);
+  if (!params) return template;
+  return template.replace(/{(\w+)}/g, (match, name) => name in params ? String(params[name]) : match);
+}
+
+// src/core/config.ts
+import { existsSync, readFileSync } from "fs";
+import path from "path";
+var CONFIG_DIR = ".vortix";
+var CONFIG_FILE = "config.json";
+var DEFAULTS = {
+  build: true,
+  failOn: "error",
+  target: {},
+  categories: {
+    performance: true,
+    security: true,
+    accessibility: true,
+    bugs: true,
+    seo: true,
+    maintainability: true,
+    privacy: true
+  },
+  checks: [],
+  disabledChecks: [],
+  severity: {},
+  performance: {
+    budgets: { lcpMs: 2500, cls: 0.1, maxPageWeightKb: 1500, maxImageKb: 300 }
+  },
+  privacy: { trackerDomains: [] }
+};
+function defineConfig(config) {
+  return config;
+}
+function getConfigPath(cwd) {
+  return path.join(cwd, CONFIG_DIR, CONFIG_FILE);
+}
+function loadConfig(cwd) {
+  const configPath = getConfigPath(cwd);
+  if (!existsSync(configPath)) {
+    return mergeConfig(cwd, {});
+  }
+  let raw;
+  try {
+    raw = readFileSync(configPath, "utf-8");
+  } catch (error) {
+    throw new Error(t("errors.configRead", { message: error.message }), { cause: error });
+  }
+  let userConfig;
+  try {
+    userConfig = JSON.parse(raw);
+  } catch (error) {
+    throw new Error(t("errors.configParse", { message: error.message }), { cause: error });
+  }
+  return mergeConfig(cwd, userConfig);
+}
+function mergeConfig(cwd, user) {
+  return {
+    cwd,
+    build: user.build ?? DEFAULTS.build,
+    failOn: user.failOn ?? DEFAULTS.failOn,
+    target: { ...DEFAULTS.target, ...user.target },
+    categories: { ...DEFAULTS.categories, ...user.categories },
+    checks: user.checks ?? DEFAULTS.checks,
+    disabledChecks: user.disabledChecks ?? DEFAULTS.disabledChecks,
+    severity: { ...DEFAULTS.severity, ...user.severity },
+    performance: {
+      budgets: { ...DEFAULTS.performance.budgets, ...user.performance?.budgets }
+    },
+    privacy: {
+      trackerDomains: [...DEFAULTS.privacy.trackerDomains, ...user.privacy?.trackerDomains ?? []]
+    }
+  };
+}
+
+// src/core/define-check.ts
+function defineCheck(def) {
+  return def;
+}
+
+export {
+  t,
+  CONFIG_DIR,
+  defineConfig,
+  getConfigPath,
+  loadConfig,
+  defineCheck
+};

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};