cleanup types

Author: jycouet

packages/sv-utils/api-surface.md

@@ -0,0 +1,13 @@
+import dedentImpl from 'dedent';
+
+/**
+ * Template-tag or single-string dedent helper (same behavior as the `dedent` package).
+ * Types are hand-written so the public `.d.mts` does not inline `dedent`'s full declarations.
+ */
+export type Dedent = {
+	(strings: TemplateStringsArray, ...values: unknown[]): string;
+	(source: string): string;
+};
+
+const dedent: Dedent = dedentImpl as Dedent;
+export default dedent;

packages/sv-utils/src/dedent.ts

@@ -1,8 +1,3 @@
-import {
-	resolveCommand as _resolveCommand,
-	type Agent,
-	type Command
-} from 'package-manager-detector';
 import {
 	parseCss,
 	parseHtml,
@@ -14,22 +9,19 @@ import {
 } from './tooling/parsers.ts';
 
 // External re-exports
-export { default as dedent } from 'dedent';
+export { default as dedent } from './dedent.ts';
 export * as Walker from 'zimmerframe';
+
+// Package managers (delegates to `package-manager-detector`; see `pm.ts`)
 export {
 	AGENTS,
 	type AgentName,
 	COMMANDS,
 	constructCommand,
 	detect,
-	resolveCommand
-} from 'package-manager-detector';
-
-/** Resolves a package manager command and returns it as a string array (command + args). */
-export function resolveCommandArray(agent: Agent, command: Command, args: string[]): string[] {
-	const cmd = _resolveCommand(agent, command, args)!;
-	return [cmd.command, ...cmd.args];
-}
+	resolveCommand,
+	resolveCommandArray
+} from './pm.ts';
 
 // Parsing & language namespaces
 export * as css from './tooling/css/index.ts';
@@ -106,3 +98,4 @@ export { color } from './color.ts';
 // Types
 export type { Comments, AstTypes, SvelteAst } from './tooling/index.ts';
 export type { TransformFn } from './tooling/transforms.ts';
+export type { YamlDocument } from './tooling/parsers.ts';

packages/sv-utils/src/index.ts

@@ -0,0 +1,23 @@
+/**
+ * Thin wrapper around [`package-manager-detector`](https://github.com/antfu/package-manager-detector).
+ * Only the symbols re-exported from the package root are public — we keep this module small and
+ * avoid exposing the full upstream surface.
+ */
+import {
+	resolveCommand as _resolveCommand,
+	type Agent,
+	type Command
+} from 'package-manager-detector';
+export {
+	AGENTS,
+	type AgentName,
+	COMMANDS,
+	constructCommand,
+	detect,
+	resolveCommand
+} from 'package-manager-detector';
+
+export function resolveCommandArray(agent: Agent, command: Command, args: string[]): string[] {
+	const cmd = _resolveCommand(agent, command, args)!;
+	return [cmd.command, ...cmd.args];
+}

packages/sv-utils/src/pm.ts

@@ -1,6 +1,15 @@
 import type { TomlTable } from 'smol-toml';
 import * as utils from './index.ts';
 
+/**
+ * Minimal shape for YAML document roots from `parse.yaml` — avoids re-exporting the full `yaml` types.
+ * At runtime this is the library’s document type; only `get` / `set` are part of the public contract.
+ */
+export type YamlDocument = {
+	get(key: string): unknown;
+	set(key: string, value: unknown): void;
+};
+
 type ParseBase = {
 	source: string;
 	/**
@@ -52,14 +61,13 @@ export function parseJson(source: string): { data: any } & ParseBase {
 	return { data, source, generateCode };
 }
 
-export function parseYaml(
-	source: string
-): { data: ReturnType<typeof utils.parseYaml> } & ParseBase {
+export function parseYaml(source: string): { data: YamlDocument } & ParseBase {
 	if (!source) source = '';
 	const data = utils.parseYaml(source);
-	const generateCode = () => utils.serializeYaml(data);
+	const generateCode = () =>
+		utils.serializeYaml(data as Parameters<typeof utils.serializeYaml>[0]);
 
-	return { data, source, generateCode };
+	return { data: data as YamlDocument, source, generateCode };
 }
 
 export function parseSvelte(source: string): { ast: utils.SvelteAst.Root } & ParseBase {

packages/sv-utils/src/tooling/parsers.ts

@@ -12,7 +12,8 @@ import {
 	parseScript,
 	parseSvelte,
 	parseToml,
-	parseYaml
+	parseYaml,
+	type YamlDocument
 } from './parsers.ts';
 import { type RootWithInstance, ensureScript } from './svelte/index.ts';
 import * as svelteNs from './svelte/index.ts';
@@ -190,7 +191,7 @@ export const transforms = {
 	 * Return `false` from the callback to abort - the original content is returned unchanged.
 	 */
 	yaml(
-		cb: (file: { data: ReturnType<typeof parseYaml>['data']; content: string }) => void | false,
+		cb: (file: { data: YamlDocument; content: string }) => void | false,
 		options?: TransformOptions
 	): TransformFn {
 		return (content) => {

packages/sv-utils/src/tooling/transforms.ts

@@ -1,8 +1,8 @@
 import {
 	color,
-	resolveCommandArray,
 	text,
 	transforms,
+	resolveCommandArray,
 	fileExists,
 	loadPackageJson,
 	sanitizeName

packages/sv/src/addons/sveltekit-adapter.ts

@@ -1,5 +1,5 @@
 import * as p from '@clack/prompts';
-import { color, resolveCommandArray, commonFilePaths, loadPackageJson } from '@sveltejs/sv-utils';
+import { color, commonFilePaths, loadPackageJson, resolveCommandArray } from '@sveltejs/sv-utils';
 import { Command, Option } from 'commander';
 import fs from 'node:fs';
 import path from 'node:path';

packages/sv/src/cli/create.ts

@@ -1,9 +1,9 @@
 import * as p from '@clack/prompts';
 import {
-	type AgentName,
 	color,
-	resolveCommandArray,
-	isVersionUnsupportedBelow
+	isVersionUnsupportedBelow,
+	type AgentName,
+	resolveCommandArray
 } from '@sveltejs/sv-utils';
 import type { Argument, Command, Help, HelpConfiguration, Option } from 'commander';
 import fs from 'node:fs';

packages/sv/src/core/common.ts

@@ -2,12 +2,12 @@ import * as p from '@clack/prompts';
 import {
 	color,
 	commonFilePaths,
-	resolveCommand,
-	type AgentName,
 	fileExists,
 	loadFile,
 	loadPackageJson,
-	saveFile
+	saveFile,
+	resolveCommand,
+	type AgentName
 } from '@sveltejs/sv-utils';
 import { NonZeroExitError, exec } from 'tinyexec';
 import { createLoadedAddon } from '../cli/add.ts';