vize 0.471.0 → 0.475.0

package/README.md

@@ -26,15 +26,18 @@ vp dlx vize setup
 The command:
 
 - installs `vize`, the Vite and Musea plugins, Oxlint, and `oxlint-plugin-vize`;
-- creates `vize.config.ts` and, for plain Vite projects, `oxlint.config.ts` when no supported config
-  already exists;
+- keeps Vue settings in the existing `vite.config.*`, creates `tsconfig.json` when absent,
+  and creates `oxlint.config.ts` for plain Vite projects when needed;
 - enables the Vize Oxlint preset in the `lint` block of a standard Vite+ config, so `vp lint`
   checks Vue files;
 - adds non-conflicting `vize:*` package scripts for build, format, lint, check, Musea, and `ready`;
 - replaces a canonical zero-option `@vitejs/plugin-vue` import with `@vizejs/vite-plugin`, then
   removes the old dependency.
 
-Setup is idempotent. It preserves existing config files and package scripts, and it leaves custom
+Setup is idempotent. It preserves existing config files and package scripts. Dedicated
+`vize.config.*` files are retired: setup leaves them unchanged and reports the migration to
+`vue:` in `vite.config.*` and `vueCompilerOptions` in `tsconfig.json`. A dedicated-only project
+must migrate before setup can complete. Setup leaves custom
 Vite plugin calls such as `vue({ ... })` unchanged because those options need a deliberate
 migration. Use `vize setup --no-install` to generate the files and scripts without changing
 dependencies.
@@ -95,22 +98,17 @@ For one-off local debugging, the installed binary is also available through npm
 vp exec vize lint --preset essential src
 ```
 
-Shared config discovery is supported for the npm package commands:
-
-- `vize.config.pkl`
-- `vize.config.ts`
-- `vize.config.js`
-- `vize.config.mjs`
-- `vize.config.json`
-
-Pkl config files require either `@pkl-community/pkl` installed in the project or a `pkl` binary on
-`PATH`. The Pkl runtime is optional so packages that only consume Vize through framework plugins do
-not install it by default.
+The npm commands read the selected project's `vite.config.ts`, `.mts`, `.cts`,
+`.js`, `.mjs` or `.cjs`. Put native Vue settings in `vue:`. With Vite+, keep your
+existing configuration and add native settings through the fluent helper:
 
 ```ts
-import { defineConfig } from "vize";
+// vite.config.ts
+import { defineConfig } from "@vizejs/vite-plugin/vite-plus";
+
+const vpConfig = { server: { port: 3000 } };
 
-export default defineConfig({
+export default defineConfig(vpConfig).withVue({
   compiler: {
     sourceMap: true,
     vapor: false,
@@ -126,22 +124,38 @@ export default defineConfig({
     strictSlotChildren: false,
     serverScript: false,
   },
-  vite: {
-    scanPatterns: ["src/**/*.vue"],
-  },
-  linter: {
-    preset: "opinionated",
-  },
+  vite: { scanPatterns: ["src/**/*.vue"] },
+  linter: { preset: "opinionated" },
   typeChecker: {
     enabled: true,
-    strict: true,
     // Large cold LSP projects can raise the default 60-second Corsa request bound.
     lspRequestTimeoutMs: 90000,
   },
 });
 ```
 
-Override config discovery with `--config`, or disable it with `--no-config`.
+For ordinary Vite, use `defineConfig` from `vite`, keep `plugins: [vize()]`, and
+place the same native settings in `vue: { ... }`.
+
+Keep TypeScript strictness and Vue template options in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": { "strict": true, "noEmit": true },
+  "vueCompilerOptions": { "strictTemplates": true },
+  "include": ["src/**/*"]
+}
+```
+
+Standard TypeScript `extends` and project `references` remain supported. There is
+no Vize-specific config `extends`; import ordinary JavaScript settings and pass
+them to `defineConfig(vpConfig).withVue(vueConfig)` instead.
+
+Dedicated `vize.config.*` files and top-level `vize:` are no longer supported.
+A stale dedicated file beside a Vite config is ignored; a dedicated-only project
+receives a migration error. Override Vite configuration selection with `--config`,
+select a TypeScript project with `--tsconfig`, or disable shared Vue config with
+`--no-config`. CLI, Vite integration and editor use the same project settings.
 
 ## Static Analysis
 
@@ -304,18 +318,21 @@ tool coverage, and upstream RFC links.
 
 ## Programmatic Config Helpers
 
-```ts
-import { defineConfig, loadConfig } from "vize";
+Use the Vite+ helper shown above to define `vite.config.ts`. A separate script
+can read its normalized native settings without defining another config file:
 
-export default defineConfig({
-  linter: {
-    preset: "happy-path",
-  },
-});
+```ts
+// scripts/read-vue-settings.ts
+import { loadConfig } from "vize/config";
 
-const config = await loadConfig(process.cwd());
+const config = await loadConfig(process.cwd(), { mode: "auto" });
+console.log(config?.linter.preset);
 ```
 
+The `defineConfig` export from `vize` only types a native options payload for API
+callers; it is distinct from the Vite+ composition helper. Do not use it to create
+a dedicated configuration file.
+
 ## Related Packages
 
 - `@vizejs/vite-plugin`

package/dist/cli.mjs

@@ -75,8 +75,11 @@ function readManifest(filename) {
 const VIZE_CONFIG_FILES = [
 	"vize.config.pkl",
 	"vize.config.ts",
+	"vize.config.mts",
+	"vize.config.cts",
 	"vize.config.js",
 	"vize.config.mjs",
+	"vize.config.cjs",
 	"vize.config.json"
 ];
 /** Config filenames Oxlint 1.64 auto-discovers. */
@@ -212,6 +215,11 @@ function isJsonObject(value) {
 function isNodeError(value) {
 	return value instanceof Error;
 }
+/** Preserve removed config files, but do not present an unusable project as ready. */
+function requireSharedConfig(root, viteConfigs) {
+	const dedicated = VIZE_CONFIG_FILES.find((name) => fs.existsSync(path.join(root, name)));
+	if (dedicated !== void 0 && viteConfigs.length === 0) throw new Error(`${dedicated} is no longer supported; move Vue settings to vue: in vite.config.* and TypeScript settings to tsconfig.json (vueCompilerOptions). The existing file was left unchanged.`);
+}
 //#endregion
 //#region src/init/templates.ts
 /**
@@ -756,7 +764,7 @@ function bundlerOffer(detection) {
 	};
 }
 function fmtOffer(detection) {
-	const configured = detection.vizeConfig !== null && "vize:fmt" in detection.scripts;
+	const configured = "vize:fmt" in detection.scripts;
 	return {
 		id: "fmt",
 		label: "fmt (vize fmt)",
@@ -767,7 +775,7 @@ function fmtOffer(detection) {
 	};
 }
 function typecheckOffer(detection) {
-	const configured = detection.tsconfig !== null && detection.vizeConfig !== null && "vize:check" in detection.scripts;
+	const configured = detection.tsconfig !== null && "vize:check" in detection.scripts;
 	return {
 		id: "typecheck",
 		label: "typecheck (vize check)",
@@ -920,8 +928,10 @@ const NUXT_CONFIG_FILES = [
 const VITE_CONFIG_FILES$1 = [
 	"vite.config.ts",
 	"vite.config.mts",
+	"vite.config.cts",
 	"vite.config.js",
-	"vite.config.mjs"
+	"vite.config.mjs",
+	"vite.config.cjs"
 ];
 /**
 * Package-manager detection.
@@ -1326,7 +1336,7 @@ const FEATURE_SCRIPTS = {
 *
 * CLI tools use project settings and sensible defaults without a dedicated
 * config. Only typechecking needs a tsconfig scaffold; existing project and Vize
-* configs keep their exact contents.
+* configs keep their exact contents; removed dedicated files are never rewritten.
 */
 function planToolSettings(detection, selection, draft) {
 	if (selection.typecheck && detection.tsconfig === null) {
@@ -1347,7 +1357,7 @@ function planToolSettings(detection, selection, draft) {
 		draft.features.push({
 			id,
 			outcome: scaffoldsTsconfig || addsScripts ? "configured" : "unchanged",
-			detail: detection.vizeConfig === null ? detail : `${detail}; ${detection.vizeConfig} already exists and was left unchanged`,
+			detail: detection.vizeConfig === null ? detail : `${detail}; ${detection.vizeConfig} is no longer read; move settings to vue: in vite.config.*`,
 			snippet: null
 		});
 	}
@@ -1616,15 +1626,17 @@ const PREFIX = "[vize init]";
 * missing lockfile.
 */
 function renderDetection(detection) {
-	return `${[
+	const lines = [
 		`${PREFIX} detected in ${detection.root}:`,
 		`  framework:       ${describeFramework(detection)}`,
 		`  package manager: ${detection.packageManager ?? "none detected (defaulting to npm)"}`,
 		`  language:        ${detection.typescript ? "TypeScript" : "JavaScript"}${detection.tsconfig === null ? " (no tsconfig.json)" : " (tsconfig.json)"}`,
 		`  lint command:    ${detection.usesVitePlus ? "vp lint" : "oxlint"}`,
-		`  vize config:     ${detection.vizeConfig ?? "none"}`,
+		`  Vue settings:    ${detection.viteConfigs.length > 0 ? "vue: in vite.config.*" : "defaults"}`,
 		`  oxlint config:   ${describeOxlintConfig(detection)}`
-	].join("\n")}\n`;
+	];
+	if (detection.vizeConfig !== null) lines.push(`  removed config:  ${detection.vizeConfig} (not read; migrate to vue: in vite.config.*)`);
+	return `${lines.join("\n")}\n`;
 }
 function describeFramework(detection) {
 	if (detection.framework === "nuxt") return `Nuxt (${detection.nuxtConfig ?? "nuxt dependency, no nuxt.config"})`;
@@ -1738,8 +1750,10 @@ async function resolveSelection(detection, args, deps) {
 async function initProject(options) {
 	const args = parseInitArgs(options.args ?? []);
 	const output = options.output ?? ((chunk) => process.stdout.write(chunk));
-	const detection = withFramework(detectProject(path.resolve(args.root ?? options.root)), args.bundlerOverride);
+	const root = path.resolve(args.root ?? options.root);
+	const detection = withFramework(detectProject(root), args.bundlerOverride);
 	output(renderDetection(detection));
+	requireSharedConfig(root, detection.viteConfigs);
 	const selection = await resolveSelection(detection, args, {
 		output,
 		stdin: options.stdin ?? process.stdin,
@@ -1810,8 +1824,10 @@ function runInitCommand(command) {
 const VITE_CONFIG_FILES = [
 	"vite.config.ts",
 	"vite.config.mts",
+	"vite.config.cts",
 	"vite.config.js",
-	"vite.config.mjs"
+	"vite.config.mjs",
+	"vite.config.cjs"
 ];
 const VITE_PLUS_LINT_IMPORT = "import { createVizeLintConfig } from \"oxlint-plugin-vize\";\n";
 const VITE_PLUS_LINT_BLOCK = `  lint: createVizeLintConfig({
@@ -1911,7 +1927,12 @@ function setupProject(options) {
 	const preservedFiles = [];
 	const plannedFiles = [];
 	const detection = detectProject(root);
-	for (const filename of VIZE_CONFIG_FILES) if (fs.existsSync(path.join(root, filename))) preservedFiles.push(filename);
+	requireSharedConfig(root, detection.viteConfigs);
+	const migrationWarnings = [];
+	for (const filename of VIZE_CONFIG_FILES) if (fs.existsSync(path.join(root, filename))) {
+		preservedFiles.push(filename);
+		migrationWarnings.push(`${filename} is no longer read; keep Vue settings in vue: in vite.config.*`);
+	}
 	planGeneratedConfig(root, ["tsconfig.json"], "tsconfig.json", renderTypecheckTsconfig(detection.typescript, detection.framework === "nuxt" ? detection.nuxtMajor : void 0), plannedFiles, createdFiles, preservedFiles);
 	const existingOxlintConfig = DISCOVERED_OXLINT_CONFIG_FILES.find((candidate) => fs.existsSync(path.join(root, candidate)));
 	const viteMigration = planViteMigration(root, existingOxlintConfig === void 0);
@@ -1951,6 +1972,7 @@ function setupProject(options) {
 	}
 	return {
 		root,
+		migrationWarnings,
 		createdFiles,
 		preservedFiles,
 		addedScripts,
@@ -1997,6 +2019,7 @@ Options:
 }
 function printSetupResult(result, install) {
 	let dependenciesMissing = false;
+	for (const warning of result.migrationWarnings) process.stdout.write(`[vize setup] ${warning}\n`);
 	for (const filename of result.createdFiles) process.stdout.write(`[vize setup] created ${filename}\n`);
 	if (result.migratedViteConfig) process.stdout.write(`[vize setup] migrated ${result.migratedViteConfig} to @vizejs/vite-plugin\n`);
 	if (result.enabledVitePlusLint) process.stdout.write("[vize setup] enabled oxlint-plugin-vize for vp lint\n");