@qds.dev/tools 0.6.2 → 0.7.5

package/lib/vite/component-props.qwik.mjs

@@ -1,315 +0,0 @@
-import { parseSync } from "oxc-parser";
-import { walk } from "oxc-walker";
-import { existsSync } from "node:fs";
-import { dirname, join, relative } from "node:path";
-import { mkdir, readFile, writeFile } from "node:fs/promises";
-
-//#region vite/component-props.ts
-/**
-* Vite plugin that extracts component prop types and generates metadata JSON files
-*/ const componentProps = (options) => {
-	const { componentsDir, outputDir } = options;
-	return {
-		name: "vite-plugin-qds-component-props",
-		enforce: "pre",
-		async buildStart() {
-			await generateAllComponentMetadata(componentsDir, outputDir);
-		},
-		async handleHotUpdate(ctx) {
-			if (ctx.file.includes(componentsDir) && ctx.file.endsWith(".tsx")) {
-				const componentName = extractComponentName(ctx.file, componentsDir);
-				if (componentName) await generateComponentMetadata(componentName, componentsDir, outputDir);
-			}
-		}
-	};
-};
-/**
-* Generate metadata for all components
-*/ async function generateAllComponentMetadata(componentsDir, outputDir) {
-	const componentDirs = await findComponentDirs(componentsDir);
-	for (const componentName of componentDirs) await generateComponentMetadata(componentName, componentsDir, outputDir);
-}
-/**
-* Generate metadata for a single component
-*/ async function generateComponentMetadata(componentName, componentsDir, outputDir) {
-	try {
-		const metadata = {
-			componentName,
-			pieces: await parseComponentPieces(componentName, componentsDir)
-		};
-		const outputPath = join(outputDir, `${componentName}.json`);
-		await mkdir(dirname(outputPath), { recursive: true });
-		await writeFile(outputPath, JSON.stringify(metadata, null, 2), "utf-8");
-	} catch (error) {
-		console.error(`Error generating metadata for ${componentName}:`, error);
-	}
-}
-/**
-* Parse all component pieces for a component
-*/ async function parseComponentPieces(componentName, componentsDir) {
-	const pieces = [];
-	const componentPath = join(componentsDir, componentName);
-	const rootPath = join(componentPath, `${componentName}-root.tsx`);
-	if (existsSync(rootPath)) {
-		const rootProps = await parseComponentFile(rootPath, "Root");
-		if (rootProps.length > 0) pieces.push({
-			name: "Root",
-			props: rootProps
-		});
-	}
-	const pieceFiles = [
-		{
-			file: `${componentName}-trigger.tsx`,
-			name: "Trigger"
-		},
-		{
-			file: `${componentName}-label.tsx`,
-			name: "Label"
-		},
-		{
-			file: `${componentName}-indicator.tsx`,
-			name: "Indicator"
-		},
-		{
-			file: `${componentName}-description.tsx`,
-			name: "Description"
-		},
-		{
-			file: `${componentName}-error.tsx`,
-			name: "Error"
-		},
-		{
-			file: `${componentName}-input.tsx`,
-			name: "Input"
-		},
-		{
-			file: `${componentName}-content.tsx`,
-			name: "Content"
-		},
-		{
-			file: `${componentName}-item.tsx`,
-			name: "Item"
-		}
-	];
-	for (const { file, name } of pieceFiles) {
-		const filePath = join(componentPath, file);
-		if (existsSync(filePath)) {
-			const props = await parseComponentFile(filePath, name);
-			if (props.length > 0) pieces.push({
-				name,
-				props
-			});
-		}
-	}
-	return pieces;
-}
-/**
-* Parse a component file and extract prop types
-*/ async function parseComponentFile(filePath, pieceName) {
-	const source = await readFile(filePath, "utf-8");
-	const ast = parseSync(filePath, source);
-	if (ast.errors.length > 0) {
-		console.warn(`Parse errors in ${filePath}:`, ast.errors);
-		return [];
-	}
-	const props = [];
-	let bindableProps = /* @__PURE__ */ new Set();
-	const publicPropsType = findPublicPropsType(ast.program, source);
-	if (!publicPropsType) return props;
-	bindableProps = findBindableProps(ast.program, source);
-	extractPropsFromType(publicPropsType, source, bindableProps, props);
-	return props;
-}
-/**
-* Find Public*Props type definition
-*/ function findPublicPropsType(program, source) {
-	let foundType = null;
-	walk(program, { enter(node) {
-		if (node.type === "TSTypeAliasDeclaration") {
-			const typeName = "id" in node && "name" in node.id ? node.id.name : "";
-			if (typeName.startsWith("Public") && typeName.endsWith("Props")) {
-				if ("typeAnnotation" in node && node.typeAnnotation) {
-					const typeAnnotation = node.typeAnnotation;
-					if (typeAnnotation.type === "TSTypeLiteral") foundType = typeAnnotation;
-					else if (typeAnnotation.type === "TSIntersectionType" && "types" in typeAnnotation) {
-						for (const type of typeAnnotation.types) if (type.type === "TSTypeLiteral") {
-							foundType = type;
-							break;
-						}
-					}
-				}
-			}
-		}
-	} });
-	return foundType;
-}
-/**
-* Find BindableProps and extract bindable prop names
-*/ function findBindableProps(program, source) {
-	const bindableProps = /* @__PURE__ */ new Set();
-	let bindableTypeName = null;
-	walk(program, { enter(node) {
-		if (node.type === "TSTypeAliasDeclaration") {
-			const typeName = "id" in node && "name" in node.id ? node.id.name : "";
-			if (typeName.startsWith("Public") && typeName.endsWith("Props")) {
-				const typeAnnotation = "typeAnnotation" in node ? node.typeAnnotation : null;
-				if (typeAnnotation && typeAnnotation.type === "TSIntersectionType") {
-					const types = "types" in typeAnnotation ? typeAnnotation.types : [];
-					for (const type of types) if (type.type === "TSTypeReference") {
-						const typeNameNode = "typeName" in type ? type.typeName : null;
-						if (typeNameNode && "name" in typeNameNode && typeNameNode.name === "BindableProps") {
-							const typeParams = "typeParameters" in type && type.typeParameters && typeof type.typeParameters === "object" && "params" in type.typeParameters && Array.isArray(type.typeParameters.params) ? type.typeParameters.params : [];
-							if (typeParams.length > 0 && typeParams[0].type === "TSTypeReference") {
-								const refTypeName = "typeName" in typeParams[0] ? typeParams[0].typeName : null;
-								if (refTypeName && "name" in refTypeName) bindableTypeName = refTypeName.name;
-							}
-						}
-					}
-				}
-			}
-		}
-	} });
-	if (bindableTypeName) walk(program, { enter(node) {
-		if (node.type === "TSTypeAliasDeclaration") {
-			if (("id" in node && "name" in node.id ? node.id.name : "") === bindableTypeName) {
-				const typeAnnotation = "typeAnnotation" in node ? node.typeAnnotation : null;
-				if (typeAnnotation && typeAnnotation.type === "TSTypeLiteral") extractPropNames(typeAnnotation, bindableProps);
-			}
-		}
-	} });
-	return bindableProps;
-}
-/**
-* Extract prop names from a TSTypeLiteral
-*/ function extractPropNames(typeLiteral, props) {
-	if (!("members" in typeLiteral)) return;
-	for (const member of typeLiteral.members) if (member.type === "TSPropertySignature") {
-		const keyNode = "key" in member ? member.key : null;
-		const key = keyNode && "name" in keyNode ? typeof keyNode.name === "string" ? keyNode.name : keyNode.name.name : null;
-		if (key) props.add(key);
-	}
-}
-/**
-* Extract props from a TSTypeLiteral
-*/ function extractPropsFromType(typeLiteral, source, bindableProps, props) {
-	if (!("members" in typeLiteral)) return;
-	for (const member of typeLiteral.members) if (member.type === "TSPropertySignature") {
-		const prop = extractPropFromSignature(member, source, bindableProps);
-		if (prop) props.push(prop);
-	}
-}
-/**
-* Extract a single prop from a TSPropertySignature
-*/ function extractPropFromSignature(signature, source, bindableProps) {
-	const keyNode = "key" in signature ? signature.key : null;
-	const key = keyNode && "name" in keyNode ? typeof keyNode.name === "string" ? keyNode.name : keyNode.name.name : null;
-	if (!key) return null;
-	if (key.endsWith("$") || key === "onChange$") return null;
-	const typeAnnotation = "typeAnnotation" in signature ? signature.typeAnnotation : null;
-	if (!typeAnnotation) return null;
-	const type = typeAnnotation.typeAnnotation;
-	signature.optional;
-	const comment = extractComment(signature, source);
-	const propType = parseType(type, source);
-	return {
-		name: key,
-		type: propType.type,
-		unionValues: propType.unionValues,
-		isBindable: bindableProps.has(key),
-		defaultValue: propType.defaultValue,
-		comment: comment || void 0
-	};
-}
-/**
-* Extract JSDoc comment from a node
-*/ function extractComment(node, source) {
-	if (!("leadingComments" in node) || !node.leadingComments || !Array.isArray(node.leadingComments)) return null;
-	for (const comment of node.leadingComments) if (comment.type === "CommentBlock" && comment.value.startsWith("*")) return comment.value.split("\n").map((line) => line.replace(/^\s*\*\s?/, "").trim()).filter((line) => line && !line.startsWith("@")).join(" ").trim() || null;
-	return null;
-}
-/**
-* Parse a TypeScript type into our PropType format
-*/ function parseType(type, source) {
-	if (type.type === "TSUnionType") {
-		const unionTypes = "types" in type ? type.types : [];
-		const stringLiterals = [];
-		for (const unionType of unionTypes) if (unionType.type === "TSLiteralType" && "literal" in unionType) {
-			const literal = unionType.literal;
-			if (literal && typeof literal === "object" && "type" in literal && "value" in literal) {
-				if (literal.type === "StringLiteral") {
-					const value = typeof literal.value === "string" ? literal.value : null;
-					if (value) stringLiterals.push(value);
-				}
-			}
-		}
-		const hasBoolean = unionTypes.some((t) => t.type === "TSBooleanKeyword" || t.type === "TSLiteralType" && "literal" in t && "value" in t.literal && typeof t.literal.value === "boolean");
-		if (stringLiterals.length > 0) return {
-			type: "union",
-			unionValues: stringLiterals
-		};
-		if (hasBoolean && unionTypes.length === 2) return {
-			type: "union",
-			unionValues: [
-				"false",
-				"true",
-				...stringLiterals
-			]
-		};
-	}
-	if (type.type === "TSBooleanKeyword") return {
-		type: "boolean",
-		defaultValue: false
-	};
-	if (type.type === "TSStringKeyword") return {
-		type: "string",
-		defaultValue: ""
-	};
-	if (type.type === "TSNumberKeyword") return {
-		type: "number",
-		defaultValue: 0
-	};
-	if (type.type === "TSLiteralType") {
-		const literal = "literal" in type ? type.literal : null;
-		if (literal && typeof literal === "object" && "type" in literal && "value" in literal) {
-			const literalType = literal.type;
-			if (literalType === "StringLiteral") return {
-				type: "union",
-				unionValues: [typeof literal.value === "string" ? literal.value : ""]
-			};
-			if (literalType === "BooleanLiteral") return {
-				type: "boolean",
-				defaultValue: typeof literal.value === "boolean" ? literal.value : false
-			};
-		}
-	}
-	return { type: "unknown" };
-}
-/**
-* Extract component name from file path
-*/ function extractComponentName(filePath, componentsDir) {
-	const match = relative(componentsDir, filePath).match(/^([^/]+)\//);
-	return match ? match[1] : null;
-}
-/**
-* Find all component directories
-*/ async function findComponentDirs(componentsDir) {
-	const commonComponents = [
-		"checkbox",
-		"switch",
-		"toggle",
-		"field",
-		"button",
-		"input",
-		"select",
-		"menu",
-		"modal",
-		"tabs",
-		"carousel"
-	];
-	const components = [];
-	for (const name of commonComponents) if (existsSync(join(componentsDir, name))) components.push(name);
-	return components;
-}
-
-//#endregion
-export { componentProps };

package/lib-types/docs/component-props.d.ts

@@ -1,25 +0,0 @@
-import type { Plugin as VitePlugin } from "vite";
-export type PropType = {
-    name: string;
-    type: "boolean" | "string" | "number" | "union" | "function" | "unknown";
-    unionValues?: string[];
-    isBindable: boolean;
-    isFunction?: boolean;
-    initialValue?: unknown;
-    comment?: string;
-};
-export type ComponentPiece = {
-    name: string;
-    props: PropType[];
-};
-export type ComponentMetadata = {
-    componentName: string;
-    pieces: ComponentPiece[];
-};
-export type ComponentPropsPluginOptions = {
-    componentsDir: string;
-    outputDir: string;
-    debug?: boolean;
-};
-export declare const componentProps: (options: ComponentPropsPluginOptions) => VitePlugin;
-export declare function generateComponentMetadata(componentName: string, componentsDir: string, outputDir: string, debug: (message: string, ...data: unknown[]) => void): Promise<void>;

package/lib-types/docs/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./component-props";
-export type { ComponentMetadata, ComponentPiece, PropType } from "./component-props";

package/lib-types/linter/qds-internal.d.ts

@@ -1,7 +0,0 @@
-/**
- * Oxlint plugin for Qwik Design System
- *
- * Custom linting rules specific to Qwik patterns and conventions
- */
-declare const qdsPlugin: import("oxlint").Plugin;
-export default qdsPlugin;

package/lib-types/linter/qds-internal.unit.d.ts

@@ -1 +0,0 @@
-export {};

package/lib-types/linter/rule-tester.d.ts

@@ -1,100 +0,0 @@
-import type { Ranged, Rule } from "oxlint";
-export interface ValidTestCase {
-    /** The code that should not trigger any errors */
-    code: string;
-    /** Optional filename (defaults to test.tsx) */
-    filename?: string;
-    /** Optional description for the test case */
-    description?: string;
-}
-export interface InvalidTestCase {
-    /** The code that should trigger errors */
-    code: string;
-    /** Expected error messages or count */
-    errors: number | string[] | Array<string | {
-        message: string;
-        line?: number;
-        column?: number;
-    } | {
-        messageId: string;
-        data?: Record<string, string>;
-    }>;
-    /** Optional filename (defaults to test.tsx) */
-    filename?: string;
-    /** Optional description for the test case */
-    description?: string;
-}
-export interface RuleTesterConfig {
-    /** Default filename for test cases */
-    filename?: string;
-}
-interface ReportedError {
-    node: Ranged;
-    messageId?: string;
-    message?: string;
-    data?: Record<string, string>;
-}
-/**
- * RuleTester - Test utility for oxlint rules
- *
- * @example
- * ```ts
- * import { RuleTester } from './rule-tester';
- * import myRule from './my-rule';
- *
- * const ruleTester = new RuleTester();
- *
- * ruleTester.run('my-rule', myRule, {
- *   valid: [
- *     'const x = 1;',
- *     { code: 'const y = 2;', filename: 'test.ts' }
- *   ],
- *   invalid: [
- *     {
- *       code: 'var x = 1;',
- *       errors: ['Use const instead of var']
- *     }
- *   ]
- * });
- * ```
- */
-export declare class RuleTester {
-    private config;
-    constructor(config?: RuleTesterConfig);
-    run(ruleName: string, rule: Rule, tests: {
-        valid?: Array<string | ValidTestCase>;
-        invalid?: Array<string | InvalidTestCase>;
-    }): void;
-    private runRule;
-    private createMockContext;
-    private normalizeValidTestCase;
-    private formatErrorMessage;
-    private validateStringArrayErrors;
-}
-/**
- * Creates explicit test helpers for better DX
- * Inspired by eslint-vitest-rule-tester but with our intuitive error format
- */
-export declare function createRuleTester(options: {
-    name: string;
-    rule: Rule;
-    filename?: string;
-}): {
-    valid: (code: string | ValidTestCase) => void;
-    invalid: (testCase: string | {
-        code: string;
-        errors: number | string[] | Array<string | {
-            message: string;
-            line?: number;
-            column?: number;
-        } | {
-            messageId: string;
-            data?: Record<string, string>;
-        }>;
-        filename?: string;
-        output?: string;
-    }) => {
-        errors: ReportedError[];
-    };
-};
-export {};

package/lib-types/rolldown/index.d.ts

@@ -1,3 +0,0 @@
-export { inlineCssPlugin } from "./inline-css";
-export { qdsTransformPlugin } from "./qds-transform";
-export { qwikRolldown } from "./qwik-rolldown";

package/lib-types/rolldown/inline-css.d.ts

@@ -1,16 +0,0 @@
-/**
- * Rolldown plugin to handle CSS imports with ?inline query parameter
- * Mimics Vite's ?inline behavior by returning CSS content as a string
- */
-interface PluginContext {
-    error: (msg: string) => void;
-}
-export declare function inlineCssPlugin(): {
-    name: string;
-    resolveId(source: string, _importer?: string, _options?: unknown): null;
-    load(this: PluginContext, id: string): {
-        code: string;
-        map: null;
-    } | null;
-};
-export {};

package/lib-types/rolldown/qds-transform.d.ts

@@ -1,11 +0,0 @@
-/**
- * This plugin transforms hooks and patterns used in our libraries to improve developer experience.
- */
-export declare function qdsTransformPlugin(): {
-    name: string;
-    enforce: "pre";
-    transform(code: string, id: string): {
-        code: string;
-        map: import("magic-string").SourceMap;
-    } | null;
-};

package/lib-types/rolldown/qds-transform.unit.d.ts

@@ -1 +0,0 @@
-export {};

package/lib-types/rolldown/qwik-rolldown.d.ts

@@ -1,9 +0,0 @@
-import type { OutputOptions } from "rolldown";
-/**
- * Plugin to ensure .qwik.mjs extension and correct output dir
- * Runs after qwikRollup to override its settings
- */
-export declare function qwikRolldown(): {
-    name: string;
-    outputOptions(outputOpts: OutputOptions): OutputOptions;
-};

package/lib-types/src/generate/icon-types.d.ts

@@ -1,25 +0,0 @@
-#!/usr/bin/env node
-export { sanitizeIconName, generateIconTypes, generateRuntimeProxies };
-import { discoverAllIconifyCollections, toPascalCase } from "../../utils/icons/naming.ts";
-export { discoverAllIconifyCollections, toPascalCase };
-/**
- * Sanitize icon name (handle leading digits, etc.)
- * @param name - Icon name in kebab-case
- * @returns Sanitized PascalCase name
- */
-declare function sanitizeIconName(name: string): string;
-/**
- * Generate type declarations for all icons in configured packs
- * @param packs - Icon packs to generate types for (defaults to all discovered packs)
- */
-declare function generateIconTypes(packs?: Record<string, {
-    iconifyPrefix: string;
-}>): Promise<void>;
-/**
- * Generate runtime proxy exports for all icon packs
- * @param outputPath - Path to write the generated file
- * @param packs - Icon packs to generate proxies for (defaults to all discovered packs)
- */
-declare function generateRuntimeProxies(outputPath?: string, packs?: Record<string, {
-    iconifyPrefix: string;
-}>): Promise<void>;

package/lib-types/src/index.d.ts

@@ -1 +0,0 @@
-export type { AsChildTypes } from "../vite";

package/lib-types/src/vite.d.ts

@@ -1 +0,0 @@
-export type { AsChildTypes } from "../vite";

package/lib-types/tools/rolldown/qds-transform.d.ts

@@ -1,11 +0,0 @@
-/**
- * This plugin transforms hooks and patterns used in our libraries to improve developer experience.
- */
-export declare function qdsTransformPlugin(): {
-    name: string;
-    enforce: "pre";
-    transform(code: string, id: string): {
-        code: string;
-        map: import("magic-string").SourceMap;
-    } | null;
-};

package/lib-types/tools/rolldown/qds-transform.unit.d.ts

@@ -1 +0,0 @@
-export {};

package/lib-types/tools/vite/as-child.d.ts

@@ -1,13 +0,0 @@
-import type { Plugin as VitePlugin } from "vite";
-export type AsChildTypes = {
-    asChild?: true;
-};
-export type AsChildPluginOptions = {
-    debug?: boolean;
-};
-/**
- * Vite plugin that transforms JSX elements with asChild prop by moving child element props to the parent
- * @param options - Plugin configuration options
- * @returns Vite plugin object
- */
-export declare const asChild: (options?: AsChildPluginOptions) => VitePlugin;

package/lib-types/tools/vite/icons.d.ts

@@ -1,19 +0,0 @@
-import type { Plugin as VitePlugin } from "vite";
-export type PacksMap = Record<string, {
-    iconifyPrefix: string;
-    sanitizeIcon?: (pascal: string) => string;
-}>;
-export type IconsPluginOptions = {
-    debug?: boolean;
-    /**
-     * The sources to scan for imports. By default this includes QDS, you can also add your own when creating library wrappers.
-     */
-    importSources?: string[];
-    packs?: PacksMap;
-};
-/**
- * Vite plugin that transforms icon JSX elements to direct <svg /> calls
- * @param options - Plugin configuration options
- * @returns Vite plugin object
- */
-export declare const icons: (options?: IconsPluginOptions) => VitePlugin;

package/lib-types/utils/ast/core.d.ts

@@ -1,4 +0,0 @@
-import type { Node } from "@oxc-project/types";
-export declare function getNodeText(node: Node, source: string): string;
-export declare function isCallExpressionWithName(node: Node, source: string, name: string): boolean;
-export declare function isIdentifierWithName(node: Node, source: string, name: string): boolean;

package/lib-types/utils/ast/imports.d.ts

@@ -1,19 +0,0 @@
-import type { ImportDeclaration, Node } from "@oxc-project/types";
-import type MagicString from "magic-string";
-import type { parseSync } from "oxc-parser";
-export declare function getImportSource(importNode: ImportDeclaration, source: string): string;
-export declare function findImportBySource(ast: ReturnType<typeof parseSync>, source: string, importSource: string): Node | null;
-/**
- * Checks if a type import specifier exists in an import declaration
- */
-export declare function hasImportSpecifier(importDecl: ImportDeclaration, specifierName: string): boolean;
-/**
- * Injects a type import specifier into an existing import or creates a new import statement
- */
-export declare function injectTypeImport(options: {
-    ast: ReturnType<typeof parseSync>;
-    magicString: MagicString;
-    importSource: string;
-    specifierName: string;
-    existingImportNode?: Node | null;
-}): void;

package/lib-types/utils/ast/jsx-helpers.d.ts

@@ -1,3 +0,0 @@
-import type { Node } from "@oxc-project/types";
-export declare function getJSXElementName(node: Node, source: string): string | null;
-export declare function isJSXElementWithName(node: Node, source: string, name: string): boolean;

package/lib-types/utils/ast/qwik.d.ts

@@ -1,13 +0,0 @@
-import type { Node } from "@oxc-project/types";
-/**
- * Checks if a node is a Render JSX element
- */
-export declare function isRenderElement(node: Node, code: string): boolean;
-/**
- * Checks if a callback function returns a Render component
- */
-export declare function returnsRenderComponent(callback: Node, code: string): boolean;
-/**
- * Detects if the source code uses the Render component pattern within a component$
- */
-export declare function detectsRenderComponentUsage(sourceCode: string): boolean;

package/lib-types/utils/fs.d.ts

@@ -1,4 +0,0 @@
-/**
- * Recursively walks a directory and yields all files with the specified extension
- */
-export declare function walkFiles(dir: string, extension: string): AsyncGenerator<string>;