vize 0.41.0 → 0.43.0

package/pkl/vize.pkl

@@ -0,0 +1,122 @@
+/// Shared schema for `vize.config.pkl`.
+///
+/// Example:
+/// amends "node_modules/vize/pkl/vize.pkl"
+///
+/// compiler {
+///   sourceMap = true
+/// }
+module vize.Config
+
+typealias CompilerMode = "module" | "function"
+typealias ScriptExt = "ts" | "js"
+typealias RuleSeverity = "off" | "warn" | "error"
+typealias LintPreset = "happy-path" | "opinionated" | "essential" | "nuxt"
+typealias TrailingComma = "all" | "none" | "es5"
+typealias FilterPattern = String | Listing<String>
+typealias GlobalTypeValue = String | GlobalTypeDeclaration
+
+class CompilerConfig {
+  mode: CompilerMode? = null
+  vapor: Boolean? = null
+  ssr: Boolean? = null
+  sourceMap: Boolean? = null
+  prefixIdentifiers: Boolean? = null
+  hoistStatic: Boolean? = null
+  cacheHandlers: Boolean? = null
+  isTs: Boolean? = null
+  scriptExt: ScriptExt? = null
+  runtimeModuleName: String? = null
+  runtimeGlobalName: String? = null
+}
+
+class VitePluginConfig {
+  include: FilterPattern? = null
+  exclude: FilterPattern? = null
+  scanPatterns: Listing<String>? = null
+  ignorePatterns: Listing<String>? = null
+}
+
+class LinterConfig {
+  enabled: Boolean? = null
+  preset: LintPreset? = null
+  rules: Mapping<String, RuleSeverity>? = null
+  categories: Mapping<String, RuleSeverity>? = null
+}
+
+class TypeCheckerConfig {
+  enabled: Boolean? = null
+  strict: Boolean? = null
+  checkProps: Boolean? = null
+  checkEmits: Boolean? = null
+  checkTemplateBindings: Boolean? = null
+  tsconfig: String? = null
+  corsaPath: String? = null
+}
+
+class FormatterConfig {
+  printWidth: Int? = null
+  tabWidth: Int? = null
+  useTabs: Boolean? = null
+  semi: Boolean? = null
+  singleQuote: Boolean? = null
+  trailingComma: TrailingComma? = null
+}
+
+class LspConfig {
+  enabled: Boolean? = null
+  diagnostics: Boolean? = null
+  completion: Boolean? = null
+  hover: Boolean? = null
+  definition: Boolean? = null
+  formatting: Boolean? = null
+  codeActions: Boolean? = null
+  corsa: Boolean? = null
+}
+
+class MuseaViewport {
+  width: Number
+  height: Number
+  name: String? = null
+}
+
+class MuseaVrtConfig {
+  threshold: Number? = null
+  outDir: String? = null
+  viewports: Listing<MuseaViewport>? = null
+}
+
+class MuseaA11yConfig {
+  enabled: Boolean? = null
+  rules: Mapping<String, Boolean>? = null
+}
+
+class MuseaAutogenConfig {
+  enabled: Boolean? = null
+  maxVariants: Int? = null
+}
+
+class MuseaConfig {
+  include: Listing<String>? = null
+  exclude: Listing<String>? = null
+  basePath: String? = null
+  storybookCompat: Boolean? = null
+  inlineArt: Boolean? = null
+  vrt: MuseaVrtConfig?
+  a11y: MuseaA11yConfig?
+  autogen: MuseaAutogenConfig?
+}
+
+class GlobalTypeDeclaration {
+  type: String
+  defaultValue: String? = null
+}
+
+compiler: CompilerConfig?
+vite: VitePluginConfig?
+linter: LinterConfig?
+typeChecker: TypeCheckerConfig?
+formatter: FormatterConfig?
+lsp: LspConfig?
+musea: MuseaConfig?
+globalTypes: Mapping<String, GlobalTypeValue>? = null

package/schemas/vize.config.schema.json

@@ -0,0 +1,352 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/vize/schemas/vize.config.schema.json",
+  "title": "Vize Config",
+  "description": "Configuration file for Vize.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "JSON Schema reference for editor autocompletion."
+    },
+    "compiler": {
+      "$ref": "#/$defs/compilerConfig"
+    },
+    "vite": {
+      "$ref": "#/$defs/vitePluginConfig"
+    },
+    "linter": {
+      "$ref": "#/$defs/linterConfig"
+    },
+    "typeChecker": {
+      "$ref": "#/$defs/typeCheckerConfig"
+    },
+    "formatter": {
+      "$ref": "#/$defs/formatterConfig"
+    },
+    "lsp": {
+      "$ref": "#/$defs/lspConfig"
+    },
+    "musea": {
+      "$ref": "#/$defs/museaConfig"
+    },
+    "globalTypes": {
+      "$ref": "#/$defs/globalTypesConfig"
+    }
+  },
+  "$defs": {
+    "ruleSeverity": {
+      "type": "string",
+      "enum": ["off", "warn", "error"]
+    },
+    "lintPreset": {
+      "type": "string",
+      "enum": ["happy-path", "opinionated", "essential", "nuxt"]
+    },
+    "patternLike": {
+      "type": "string",
+      "description": "Pattern string used by non-JavaScript configs. JavaScript configs may also use RegExp values."
+    },
+    "compilerConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": ["module", "function"]
+        },
+        "vapor": {
+          "type": "boolean"
+        },
+        "ssr": {
+          "type": "boolean"
+        },
+        "sourceMap": {
+          "type": "boolean"
+        },
+        "prefixIdentifiers": {
+          "type": "boolean"
+        },
+        "hoistStatic": {
+          "type": "boolean"
+        },
+        "cacheHandlers": {
+          "type": "boolean"
+        },
+        "isTs": {
+          "type": "boolean"
+        },
+        "scriptExt": {
+          "type": "string",
+          "enum": ["ts", "js"]
+        },
+        "runtimeModuleName": {
+          "type": "string"
+        },
+        "runtimeGlobalName": {
+          "type": "string"
+        }
+      }
+    },
+    "vitePluginConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "include": {
+          "oneOf": [
+            { "$ref": "#/$defs/patternLike" },
+            {
+              "type": "array",
+              "items": { "$ref": "#/$defs/patternLike" }
+            }
+          ]
+        },
+        "exclude": {
+          "oneOf": [
+            { "$ref": "#/$defs/patternLike" },
+            {
+              "type": "array",
+              "items": { "$ref": "#/$defs/patternLike" }
+            }
+          ]
+        },
+        "scanPatterns": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "ignorePatterns": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "linterConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "preset": {
+          "$ref": "#/$defs/lintPreset"
+        },
+        "rules": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/$defs/ruleSeverity"
+          }
+        },
+        "categories": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "correctness": { "$ref": "#/$defs/ruleSeverity" },
+            "suspicious": { "$ref": "#/$defs/ruleSeverity" },
+            "style": { "$ref": "#/$defs/ruleSeverity" },
+            "perf": { "$ref": "#/$defs/ruleSeverity" },
+            "a11y": { "$ref": "#/$defs/ruleSeverity" },
+            "security": { "$ref": "#/$defs/ruleSeverity" }
+          }
+        }
+      }
+    },
+    "typeCheckerConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "strict": {
+          "type": "boolean"
+        },
+        "checkProps": {
+          "type": "boolean"
+        },
+        "checkEmits": {
+          "type": "boolean"
+        },
+        "checkTemplateBindings": {
+          "type": "boolean"
+        },
+        "tsconfig": {
+          "type": "string"
+        },
+        "corsaPath": {
+          "type": "string"
+        }
+      }
+    },
+    "formatterConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "printWidth": {
+          "type": "integer"
+        },
+        "tabWidth": {
+          "type": "integer"
+        },
+        "useTabs": {
+          "type": "boolean"
+        },
+        "semi": {
+          "type": "boolean"
+        },
+        "singleQuote": {
+          "type": "boolean"
+        },
+        "trailingComma": {
+          "type": "string",
+          "enum": ["all", "none", "es5"]
+        }
+      }
+    },
+    "lspConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "diagnostics": {
+          "type": "boolean"
+        },
+        "completion": {
+          "type": "boolean"
+        },
+        "hover": {
+          "type": "boolean"
+        },
+        "definition": {
+          "type": "boolean"
+        },
+        "formatting": {
+          "type": "boolean"
+        },
+        "codeActions": {
+          "type": "boolean"
+        },
+        "corsa": {
+          "type": "boolean"
+        }
+      }
+    },
+    "museaViewport": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "width": {
+          "type": "number"
+        },
+        "height": {
+          "type": "number"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": ["width", "height"]
+    },
+    "museaVrtConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "threshold": {
+          "type": "number"
+        },
+        "outDir": {
+          "type": "string"
+        },
+        "viewports": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/museaViewport"
+          }
+        }
+      }
+    },
+    "museaA11yConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "rules": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "boolean"
+          }
+        }
+      }
+    },
+    "museaAutogenConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "maxVariants": {
+          "type": "integer"
+        }
+      }
+    },
+    "museaConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "include": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "exclude": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "basePath": {
+          "type": "string"
+        },
+        "storybookCompat": {
+          "type": "boolean"
+        },
+        "inlineArt": {
+          "type": "boolean"
+        },
+        "vrt": {
+          "$ref": "#/$defs/museaVrtConfig"
+        },
+        "a11y": {
+          "$ref": "#/$defs/museaA11yConfig"
+        },
+        "autogen": {
+          "$ref": "#/$defs/museaAutogenConfig"
+        }
+      }
+    },
+    "globalTypeDeclaration": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "defaultValue": {
+          "type": "string"
+        }
+      },
+      "required": ["type"]
+    },
+    "globalTypesConfig": {
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          { "type": "string" },
+          { "$ref": "#/$defs/globalTypeDeclaration" }
+        ]
+      }
+    }
+  }
+}

package/src/cli.ts

@@ -1,5 +1,6 @@
 import { createRequire } from "module";
 import { readFileSync } from "fs";
+import { loadConfig } from "./config.js";
 
 const require = createRequire(import.meta.url);
 
@@ -103,9 +104,23 @@ interface LintResult {
   timeMs: number;
 }
 
-function runLint(args: string[]): void {
+interface SharedConfigOptions {
+  configFile?: string;
+  configMode: "root" | "none";
+}
+
+interface ParsedLintCommand {
+  patterns: string[];
+  options: LintOptions;
+  sharedConfig: SharedConfigOptions;
+}
+
+function parseLintCommand(args: string[]): ParsedLintCommand {
   const patterns: string[] = [];
   const options: LintOptions = {};
+  const sharedConfig: SharedConfigOptions = {
+    configMode: "root",
+  };
 
   for (let i = 0; i < args.length; i++) {
     const arg = args[i];
@@ -121,11 +136,44 @@ function runLint(args: string[]): void {
       options.helpLevel = args[++i];
     } else if (arg === "--preset") {
       options.preset = args[++i];
+    } else if (arg === "--config" || arg === "-c") {
+      const configFile = args[++i];
+      if (!configFile) {
+        throw new Error("Missing path after --config");
+      }
+      sharedConfig.configFile = configFile;
+    } else if (arg === "--no-config") {
+      sharedConfig.configMode = "none";
     } else if (!arg.startsWith("-")) {
       patterns.push(arg);
     }
   }
 
+  return { patterns, options, sharedConfig };
+}
+
+async function runLint(args: string[]): Promise<void> {
+  const { patterns, options, sharedConfig } = parseLintCommand(args);
+  const config = await loadConfig(process.cwd(), {
+    mode: sharedConfig.configMode,
+    configFile: sharedConfig.configFile,
+    env: {
+      mode: process.env.NODE_ENV ?? "development",
+      command: "lint",
+    },
+  });
+
+  if (sharedConfig.configFile && !config) {
+    throw new Error(`Could not find config file: ${sharedConfig.configFile}`);
+  }
+
+  if (config?.linter?.enabled === false) {
+    process.stderr.write("[vize] Skipping lint because linter.enabled is false in vize.config.\n");
+    return;
+  }
+
+  options.preset ??= config?.linter?.preset;
+
   if (patterns.length === 0) {
     patterns.push(".");
   }
@@ -169,7 +217,7 @@ function runLint(args: string[]): void {
 
 const NAPI_COMMANDS = new Set(["lint"]);
 
-function main(): void {
+async function main(): Promise<void> {
   const args = process.argv.slice(2);
   const command = args[0];
 
@@ -183,7 +231,7 @@ function main(): void {
     const commandArgs = args.slice(1);
     switch (command) {
       case "lint":
-        runLint(commandArgs);
+        await runLint(commandArgs);
         break;
     }
   } else {
@@ -195,4 +243,7 @@ function main(): void {
   }
 }
 
-main();
+void main().catch((error) => {
+  console.error(error instanceof Error ? error.message : String(error));
+  process.exit(1);
+});