@powerlines/plugin-alloy 0.16.0 → 0.16.2

package/dist/tsdoc-CWCdJ1Uj.mjs

@@ -0,0 +1,456 @@
+import { n as usePowerlines } from "./context-eP3fitqj.mjs";
+import { r as stringifyDefaultValue } from "./utilities-C6eipB1q.mjs";
+import { createComponent, createIntrinsic, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
+import { isSetString } from "@stryke/type-checks/is-set-string";
+import { For, List, Prose, Show, childrenArray, splitProps } from "@powerlines/plugin-alloy/vendor";
+import { isUndefined } from "@stryke/type-checks/is-undefined";
+
+//#region src/typescript/components/tsdoc.tsx
+/**
+* Generates a TypeScript interface for the given reflection class.
+*/
+function TSDoc(props) {
+	const [{ children, heading }] = splitProps(props, ["children", "heading"]);
+	return [
+		"/**",
+		createIntrinsic("align", {
+			string: " * ",
+			get children() {
+				return [
+					createIntrinsic("hbr", {}),
+					createComponent(Show, {
+						get when() {
+							return !isUndefined(heading);
+						},
+						get children() {
+							return [
+								heading,
+								createIntrinsic("hbr", {}),
+								createComponent(Show, {
+									get when() {
+										return memo(() => !!!isUndefined(children))() && childrenArray(() => children).length > 0;
+									},
+									get children() {
+										return createIntrinsic("hbr", {});
+									}
+								})
+							];
+						}
+					}),
+					createComponent(Show, {
+						get when() {
+							return memo(() => !!!isUndefined(children))() && childrenArray(() => children).length > 0;
+						},
+						get children() {
+							return createComponent(List, { get children() {
+								return childrenArray(() => children);
+							} });
+						}
+					})
+				];
+			}
+		}),
+		createIntrinsic("hbr", {}),
+		` */`,
+		createIntrinsic("hbr", {})
+	];
+}
+/**
+* Create a TSDoc `@<props.tag>` tag.
+*/
+function TSDocTag(props) {
+	const [{ children, tag }] = splitProps(props, ["children", "tag"]);
+	return [
+		`@${tag} `,
+		createComponent(Show, {
+			get when() {
+				return Boolean(children);
+			},
+			get children() {
+				return createIntrinsic("align", {
+					width: 2,
+					get children() {
+						return createComponent(Prose, { children });
+					}
+				});
+			}
+		}),
+		createIntrinsic("hbr", {})
+	];
+}
+/**
+* A component that creates a TSDoc block with `@param` tags for each parameter.
+*/
+function TSDocParams(props) {
+	return createComponent(For, {
+		each: normalizeParametersForDoc(props.parameters),
+		children: (param) => createComponent(TSDocParam, {
+			get name() {
+				return param.name;
+			},
+			get optional() {
+				return param.optional;
+			},
+			get children() {
+				return param.doc;
+			}
+		})
+	});
+}
+function normalizeParametersForDoc(parameters) {
+	if (parameters.some((p) => typeof p === "string")) return [];
+	return parameters;
+}
+/**
+* Create a TSDoc `@title` tag.
+*/
+function TSDocTitle(props) {
+	const [{ children }, rest] = splitProps(props, ["children"]);
+	return createComponent(TSDocTag, mergeProps(rest, {
+		tag: "title",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@domain` tag.
+*/
+function TSDocDomain(props) {
+	const [{ children }, rest] = splitProps(props, ["children"]);
+	return createComponent(TSDocTag, mergeProps(rest, {
+		tag: "domain",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@alias` tag.
+*/
+function TSDocAlias(props) {
+	const [{ children }, rest] = splitProps(props, ["children"]);
+	return createComponent(TSDocTag, mergeProps(rest, {
+		tag: "alias",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@permission` tag.
+*/
+function TSDocPermission(props) {
+	const [{ children }, rest] = splitProps(props, ["children"]);
+	return createComponent(TSDocTag, mergeProps(rest, {
+		tag: "permission",
+		children
+	}));
+}
+/**
+* Create a TSDoc `@defaultValue` tag.
+*/
+function TSDocDefaultValue(props) {
+	return [
+		"@defaultValue ",
+		createComponent(Show, {
+			get when() {
+				return !isUndefined(props.value);
+			},
+			get children() {
+				return createIntrinsic("align", {
+					width: 2,
+					get children() {
+						return createComponent(Prose, { get children() {
+							return stringifyDefaultValue(props.value);
+						} });
+					}
+				});
+			}
+		}),
+		createIntrinsic("hbr", {})
+	];
+}
+/**
+* Create a TSDoc `@remarks` tag.
+*/
+function TSDocRemarks(props) {
+	return [
+		"@remarks ",
+		createIntrinsic("hbr", {}),
+		createComponent(List, {
+			hardline: true,
+			get children() {
+				return childrenArray(() => props.children);
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc `@see` tag.
+*/
+function TSDocLink(props) {
+	return createComponent(TSDocTag, mergeProps(props, { tag: "see" }));
+}
+/**
+* Create a TSDoc `@example` tag.
+*/
+function TSDocExample(props) {
+	const [{ tsx, fenced = true, language, children }] = splitProps(props, [
+		"tsx",
+		"fenced",
+		"language",
+		"children"
+	]);
+	return [
+		"@example ",
+		createIntrinsic("hbr", {}),
+		createComponent(Show, {
+			when: fenced,
+			get children() {
+				return [
+					"```",
+					language || (tsx ? "tsx" : "ts"),
+					createIntrinsic("hbr", {})
+				];
+			}
+		}),
+		children,
+		createComponent(Show, {
+			when: fenced,
+			get children() {
+				return [createIntrinsic("hbr", {}), "```"];
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc `@readonly` tag.
+*/
+function TSDocReadonly() {
+	return createComponent(TSDocTag, { tag: "readonly" });
+}
+/**
+* Create a TSDoc `@internal` tag.
+*/
+function TSDocInternal() {
+	return createComponent(TSDocTag, { tag: "internal" });
+}
+/**
+* Create a TSDoc `@ignore` tag.
+*/
+function TSDocIgnore() {
+	return createComponent(TSDocTag, { tag: "ignore" });
+}
+/**
+* Create a TSDoc `@hidden` tag.
+*/
+function TSDocHidden() {
+	return createComponent(TSDocTag, { tag: "hidden" });
+}
+/**
+* Generates a TypeScript interface property for the given reflection class.
+*/
+function TSDocAttributesTags(props) {
+	const [{ title, alias, permission, domain, readonly, internal, ignore, hidden, defaultValue }] = splitProps(props, [
+		"title",
+		"alias",
+		"permission",
+		"domain",
+		"readonly",
+		"internal",
+		"ignore",
+		"hidden",
+		"defaultValue"
+	]);
+	return [
+		createComponent(Show, {
+			get when() {
+				return isSetString(title);
+			},
+			get children() {
+				return createComponent(TSDocTitle, { children: title });
+			}
+		}),
+		createComponent(Show, {
+			get when() {
+				return !isUndefined(alias) && alias.length > 0;
+			},
+			get children() {
+				return createComponent(For, {
+					each: alias ?? [],
+					children: (alias$1) => createComponent(TSDocAlias, { children: alias$1 })
+				});
+			}
+		}),
+		createComponent(Show, {
+			get when() {
+				return isSetString(domain);
+			},
+			get children() {
+				return createComponent(TSDocDomain, { children: domain });
+			}
+		}),
+		createComponent(Show, {
+			get when() {
+				return !isUndefined(permission) && permission.length > 0;
+			},
+			get children() {
+				return createComponent(For, {
+					each: permission ?? [],
+					children: (permission$1) => createComponent(TSDocPermission, { children: permission$1 })
+				});
+			}
+		}),
+		createComponent(Show, {
+			when: readonly === true,
+			get children() {
+				return createComponent(TSDocReadonly, {});
+			}
+		}),
+		createComponent(Show, {
+			when: internal === true,
+			get children() {
+				return createComponent(TSDocInternal, {});
+			}
+		}),
+		createComponent(Show, {
+			when: ignore === true,
+			get children() {
+				return createComponent(TSDocIgnore, {});
+			}
+		}),
+		createComponent(Show, {
+			when: hidden === true,
+			get children() {
+				return createComponent(TSDocHidden, {});
+			}
+		}),
+		createComponent(Show, {
+			get when() {
+				return !isUndefined(defaultValue);
+			},
+			get children() {
+				return createComponent(TSDocDefaultValue, { value: defaultValue });
+			}
+		})
+	];
+}
+/**
+* Create a TSDoc parameter set off with `@param`.
+*/
+function TSDocParam(props) {
+	return [
+		"@param ",
+		createComponent(TSDocParamName, {
+			get name() {
+				return props.name;
+			},
+			get optional() {
+				return props.optional;
+			},
+			get defaultValue() {
+				return props.defaultValue;
+			}
+		}),
+		createComponent(TSDocParamDescription, { get children() {
+			return props.children;
+		} })
+	];
+}
+function TSDocParamName(props) {
+	return [
+		createComponent(Show, {
+			get when() {
+				return props.optional;
+			},
+			children: "["
+		}),
+		memo(() => props.name),
+		createComponent(Show, {
+			get when() {
+				return Boolean(props.defaultValue);
+			},
+			get children() {
+				return ["=", memo(() => props.defaultValue)];
+			}
+		}),
+		createComponent(Show, {
+			get when() {
+				return props.optional;
+			},
+			children: "]"
+		})
+	];
+}
+function TSDocParamDescription(props) {
+	return createComponent(Show, {
+		get when() {
+			return Boolean(props.children);
+		},
+		get children() {
+			return [" - ", createIntrinsic("align", {
+				width: 2,
+				get children() {
+					return createComponent(Prose, { get children() {
+						return props.children;
+					} });
+				}
+			})];
+		}
+	});
+}
+/**
+* Create a TSDoc `@returns` tag.
+*/
+function TSDocReturns(props) {
+	return createComponent(TSDocTag, mergeProps(props, { tag: "returns" }));
+}
+/**
+* Create a TSDoc `@throws` tag.
+*/
+function TSDocThrows(props) {
+	return createComponent(TSDocTag, mergeProps(props, { tag: "throws" }));
+}
+/**
+* Generates a TSDoc `@module` tag for the given module name.
+*/
+function TSDocModule(props) {
+	const [{ children, name, prefix }] = splitProps(props, [
+		"children",
+		"name",
+		"prefix"
+	]);
+	const context = usePowerlines();
+	return [
+		"/**",
+		createIntrinsic("align", {
+			string: " * ",
+			get children() {
+				return [
+					createIntrinsic("hbr", {}),
+					createComponent(Show, {
+						get when() {
+							return Boolean(children);
+						},
+						get children() {
+							return [
+								createComponent(List, {
+									hardline: true,
+									get children() {
+										return childrenArray(() => children);
+									}
+								}),
+								createIntrinsic("hbr", {}),
+								createIntrinsic("hbr", {})
+							];
+						}
+					}),
+					"@module ",
+					memo(() => prefix || context?.config.output.builtinPrefix),
+					":",
+					name
+				];
+			}
+		}),
+		createIntrinsic("hbr", {}),
+		` */`
+	];
+}
+
+//#endregion
+export { TSDocReturns as _, TSDocDomain as a, TSDocTitle as b, TSDocIgnore as c, TSDocModule as d, TSDocParam as f, TSDocRemarks as g, TSDocReadonly as h, TSDocDefaultValue as i, TSDocInternal as l, TSDocPermission as m, TSDocAlias as n, TSDocExample as o, TSDocParams as p, TSDocAttributesTags as r, TSDocHidden as s, TSDoc as t, TSDocLink as u, TSDocTag as v, TSDocThrows as y };

package/dist/tsdoc-C_2VzSk_.d.cts

@@ -0,0 +1,152 @@
+import { n as ComponentProps } from "./components-DkVeQ5Yn.cjs";
+import { Children } from "@powerlines/plugin-alloy/vendor";
+import { JSDocExampleProps, ParameterDescriptor } from "@alloy-js/typescript";
+
+//#region src/typescript/components/tsdoc.d.ts
+interface TSDocProps extends ComponentProps {
+  heading?: Children;
+}
+/**
+ * Generates a TypeScript interface for the given reflection class.
+ */
+declare function TSDoc(props: TSDocProps): Children;
+interface TSDocTagProps extends ComponentProps {
+  tag: string;
+}
+/**
+ * Create a TSDoc `@<props.tag>` tag.
+ */
+declare function TSDocTag(props: TSDocTagProps): Children;
+interface TSDocParamsProps {
+  parameters: ParameterDescriptor[] | string[];
+}
+/**
+ * A component that creates a TSDoc block with `@param` tags for each parameter.
+ */
+declare function TSDocParams(props: TSDocParamsProps): Children;
+/**
+ * Create a TSDoc `@title` tag.
+ */
+declare function TSDocTitle(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@domain` tag.
+ */
+declare function TSDocDomain(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@alias` tag.
+ */
+declare function TSDocAlias(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@permission` tag.
+ */
+declare function TSDocPermission(props: ComponentProps): Children;
+interface TSDocDefaultValueProps extends ComponentProps {
+  value: any;
+}
+/**
+ * Create a TSDoc `@defaultValue` tag.
+ */
+declare function TSDocDefaultValue(props: TSDocDefaultValueProps): Children;
+/**
+ * Create a TSDoc `@remarks` tag.
+ */
+declare function TSDocRemarks(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@see` tag.
+ */
+declare function TSDocLink(props: ComponentProps): Children;
+interface TSDocExampleProps extends JSDocExampleProps {
+  /**
+   * Whether the file is a TSX file.
+   *
+   * @defaultValue false
+   */
+  tsx?: boolean;
+}
+/**
+ * Create a TSDoc `@example` tag.
+ */
+declare function TSDocExample(props: TSDocExampleProps): Children;
+/**
+ * Create a TSDoc `@readonly` tag.
+ */
+declare function TSDocReadonly(): Children;
+/**
+ * Create a TSDoc `@internal` tag.
+ */
+declare function TSDocInternal(): Children;
+/**
+ * Create a TSDoc `@ignore` tag.
+ */
+declare function TSDocIgnore(): Children;
+/**
+ * Create a TSDoc `@hidden` tag.
+ */
+declare function TSDocHidden(): Children;
+interface TSDocAttributesTagsProps {
+  title?: string;
+  alias?: string[];
+  permission?: string[];
+  domain?: string;
+  readonly?: boolean;
+  internal?: boolean;
+  ignore?: boolean;
+  hidden?: boolean;
+  defaultValue?: any;
+}
+/**
+ * Generates a TypeScript interface property for the given reflection class.
+ */
+declare function TSDocAttributesTags(props: TSDocAttributesTagsProps): Children;
+interface TSDocParamProps {
+  name: Children;
+  children?: Children;
+  optional?: boolean;
+  defaultValue?: Children;
+}
+/**
+ * Create a TSDoc parameter set off with `@param`.
+ */
+declare function TSDocParam(props: TSDocParamProps): Children;
+/**
+ * Create a TSDoc `@returns` tag.
+ */
+declare function TSDocReturns(props: ComponentProps): Children;
+/**
+ * Create a TSDoc `@throws` tag.
+ */
+declare function TSDocThrows(props: ComponentProps): Children;
+interface TSDocModuleProps extends ComponentProps {
+  /**
+   * the prefix for the builtin module name
+   *
+   * @defaultValue "storm"
+   */
+  prefix?: string;
+  /**
+   * The name of the module
+   *
+   * @remarks
+   * This will be used in the `@module` tag as well as the import path for the module, e.g. `storm:<name>`.
+   *
+   * @example
+   * ```ts
+   * import { MyModule } from "storm:my-module";
+   * ```
+   */
+  name: Children;
+}
+/**
+ * Generates a TSDoc `@module` tag for the given module name.
+ */
+declare function TSDocModule(props: TSDocModuleProps): Children;
+declare type __ΩTSDocProps = any[];
+declare type __ΩTSDocTagProps = any[];
+declare type __ΩTSDocParamsProps = any[];
+declare type __ΩTSDocDefaultValueProps = any[];
+declare type __ΩTSDocExampleProps = any[];
+declare type __ΩTSDocAttributesTagsProps = any[];
+declare type __ΩTSDocParamProps = any[];
+declare type __ΩTSDocModuleProps = any[];
+//#endregion
+export { __ΩTSDocDefaultValueProps as A, TSDocRemarks as C, TSDocThrows as D, TSDocTagProps as E, __ΩTSDocProps as F, __ΩTSDocTagProps as I, __ΩTSDocModuleProps as M, __ΩTSDocParamProps as N, TSDocTitle as O, __ΩTSDocParamsProps as P, TSDocReadonly as S, TSDocTag as T, TSDocParamProps as _, TSDocDefaultValue as a, TSDocPermission as b, TSDocExample as c, TSDocIgnore as d, TSDocInternal as f, TSDocParam as g, TSDocModuleProps as h, TSDocAttributesTagsProps as i, __ΩTSDocExampleProps as j, __ΩTSDocAttributesTagsProps as k, TSDocExampleProps as l, TSDocModule as m, TSDocAlias as n, TSDocDefaultValueProps as o, TSDocLink as p, TSDocAttributesTags as r, TSDocDomain as s, TSDoc as t, TSDocHidden as u, TSDocParams as v, TSDocReturns as w, TSDocProps as x, TSDocParamsProps as y };