@xyd-js/sources 0.0.0-build

package/packages/ts/__fixtures__/react/react-a/src/TestAbc.tsx

@@ -0,0 +1,90 @@
+/**
+ * Props for the GuideCard component
+ */
+export interface GuideCardProps {
+    /** Content to be displayed in the card body */
+    children: React.ReactNode;
+
+    /** URL the card links to */
+    href: string
+
+    /** Title displayed at the top of the card */
+    title: string;
+
+    /** Optional icon displayed to the left of the content */
+    icon?: React.ReactNode;
+
+    /** Visual style variant of the card */
+    kind?: "secondary"
+
+    /** Size variant of the card */
+    size?: "sm" | "md"
+
+    /** Additional CSS class names to apply to the card */
+    className?: string
+
+    /** Additional props to pass to the link element */
+    as?: React.ElementType
+}
+
+/**
+ * A card component that displays content with a title and optional icon.
+ * The entire card is clickable and links to the specified URL.
+ * 
+ * @category Component
+ */
+export function GuideCard({
+    children,
+    href,
+    icon,
+    title,
+    kind,
+    size,
+    className,
+    as,
+}: GuideCardProps) {
+
+    return <div>
+        {children}
+    </div>
+}
+
+/**
+ * A container component for grouping multiple GuideCard components.
+ * Provides consistent spacing and layout for a list of guide cards.
+ */
+GuideCard.List = function GuideCardList({ children }: { children: React.ReactNode }) {
+    return <div>
+        {children}
+    </div>
+}
+
+/**
+ * Internal component that renders the arrow pointer icon.
+ */
+function $Pointer() {
+    return <div part="pointer">
+        <svg
+            xmlns="http://www.w3.org/2000/svg"
+            width={24}
+            height={24}
+            fill="currentColor"
+            viewBox="0 0 24 24"
+        >
+            <path
+                fillRule="evenodd"
+                d="M9.293 7.293a1 1 0 0 1 1.414 0l4 4a1 1 0 0 1 0 1.414l-4 4a1 1 0 0 1-1.414-1.414L12.586 12 9.293 8.707a1 1 0 0 1 0-1.414Z"
+                clipRule="evenodd"
+            />
+        </svg>
+    </div>
+}
+
+function $Link({ href, children, ...rest }) {
+    return <a
+        href={href}
+        {...rest}
+    >
+        {children}
+    </a>
+}

package/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx

@@ -0,0 +1,27 @@
+import type { PropsWithChildren, ReactElement, ReactNode } from "react";
+
+/**
+ * The props type for {@link TestBasicComponent}.
+ */
+export interface Props extends PropsWithChildren {
+    /** The name of the person. */
+    name: string
+
+    /** The age of the person. */
+    age: number
+
+    /** Whether the person is active. */
+    isActive: boolean
+
+    /** The date the person was created. */
+    createdAt: Date
+}
+
+/**
+ * TestBasicComponent is a React component that uses a basic props type.
+ * 
+ * @category Component
+ */
+export function TestBasicComponent(props: Props): ReactElement {
+    return <div>{props.children}</div>;
+}

package/packages/ts/__fixtures__/react/react-a/src/TestNamedParameters.tsx

@@ -0,0 +1,27 @@
+import type { PropsWithChildren, ReactElement, ReactNode } from "react";
+
+/**
+ * The props type for {@link TestNamedParameters}.
+ */
+export interface Props extends PropsWithChildren {
+    /** The name of the person. */
+    name: string
+
+    /** The age of the person. */
+    age: number
+
+    /** Whether the person is active. */
+    isActive: boolean
+
+    /** The date the person was created. */
+    createdAt: Date
+}
+
+/**
+ * TestNamedParameters is a React component that uses a named parameters.
+ * 
+ * @category Component
+ */
+export function TestNamedParameters({ name, age, isActive, createdAt, children }: Props): ReactElement {
+    return <div>{children}</div>;
+}

package/packages/ts/__fixtures__/react/react-a/src/TestNamedParameters2.tsx

@@ -0,0 +1,26 @@
+import type { ReactElement, ReactNode } from "react";
+
+
+/**
+ * TestNamedParameters is a React component that uses inline named parameters
+ * 
+ * @category Component
+ */
+export function TestNamedParameters2({ name, age, isActive, createdAt, children }: {
+    /** The name of the person. */  
+    name: string
+
+    /** The age of the person. */
+    age: number
+
+    /** Whether the person is active. */
+    isActive: boolean
+
+    /** The date the person was created. */
+    createdAt: Date
+
+    /** The children of the component. */
+    children: ReactNode
+}): ReactElement {
+    return <div>{children}</div>;
+}

package/packages/ts/__fixtures__/react/react-a/src/TestUnion.tsx

@@ -0,0 +1,32 @@
+import type { PropsWithChildren, ReactElement, ReactNode } from "react";
+
+type VariantGhost = "ghost"
+
+/**
+ * The props type for {@link TestUnionComponent}.
+ */
+export interface ComponentProps extends PropsWithChildren {
+    /** The theme of the card. Defaults to `primary`. */
+    variant: "primary" | "secondary" | "success" | "danger" | "light" | "dark" | VariantGhost | 10
+}
+
+export interface ComponentProps2 extends PropsWithChildren {
+    /** The theme of the card. Defaults to `primary`. */
+    otherVariant: "other"
+
+    label: string
+}
+
+/**
+ * The union type for {@link ComponentProps} and {@link ComponentProps2}.
+ */
+export type UnionProps = ComponentProps | ComponentProps2
+
+/**
+ * TestUnionComponent is a React component that uses a union type for its props.
+ * 
+ * @category Component
+ */
+export function TestUnionComponent(props: UnionProps): ReactElement {
+    return <div>{props.children}</div>;
+}

package/packages/ts/__fixtures__/react/react-a/src/index.ts

@@ -0,0 +1 @@
+export * from "./TestAbc";

package/packages/ts/__fixtures__/react/react-a/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "jsx": "react-jsx",
+    "skipLibCheck": true
+  }
+}
+

package/packages/ts/__fixtures__/references-output-project.json

@@ -0,0 +1,344 @@
+{
+  "schemaVersion": "2.0",
+  "id": 0,
+  "name": "@xyd-sources-examples/react",
+  "variant": "project",
+  "kind": 1,
+  "flags": {},
+  "children": [
+    {
+      "id": 4,
+      "name": "Props",
+      "variant": "declaration",
+      "kind": 256,
+      "flags": {},
+      "comment": {
+        "summary": [
+          {
+            "kind": "text",
+            "text": "The props type for "
+          },
+          {
+            "kind": "inline-tag",
+            "tag": "@link",
+            "text": "TestBasicComponent",
+            "target": 1
+          },
+          {
+            "kind": "text",
+            "text": "."
+          }
+        ]
+      },
+      "children": [
+        {
+          "id": 5,
+          "name": "name",
+          "variant": "declaration",
+          "kind": 1024,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "The name of the person."
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "TestBasic.tsx",
+              "line": 8,
+              "character": 4,
+              "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L8"
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "string"
+          }
+        },
+        {
+          "id": 6,
+          "name": "age",
+          "variant": "declaration",
+          "kind": 1024,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "The age of the person."
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "TestBasic.tsx",
+              "line": 11,
+              "character": 4,
+              "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L11"
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "number"
+          }
+        },
+        {
+          "id": 7,
+          "name": "isActive",
+          "variant": "declaration",
+          "kind": 1024,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "Whether the person is active."
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "TestBasic.tsx",
+              "line": 14,
+              "character": 4,
+              "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L14"
+            }
+          ],
+          "type": {
+            "type": "intrinsic",
+            "name": "boolean"
+          }
+        },
+        {
+          "id": 8,
+          "name": "createdAt",
+          "variant": "declaration",
+          "kind": 1024,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "The date the person was created."
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "TestBasic.tsx",
+              "line": 17,
+              "character": 4,
+              "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L17"
+            }
+          ],
+          "type": {
+            "type": "reference",
+            "target": {
+              "packageName": "typescript",
+              "packagePath": "lib/lib.es5.d.ts",
+              "qualifiedName": "Date"
+            },
+            "name": "Date",
+            "package": "typescript"
+          }
+        }
+      ],
+      "groups": [
+        {
+          "title": "Properties",
+          "children": [
+            5,
+            6,
+            7,
+            8
+          ]
+        }
+      ],
+      "sources": [
+        {
+          "fileName": "TestBasic.tsx",
+          "line": 6,
+          "character": 17,
+          "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L6"
+        }
+      ],
+      "extendedTypes": [
+        {
+          "type": "reference",
+          "target": {
+            "packageName": "@types/react",
+            "packagePath": "index.d.ts",
+            "qualifiedName": "React.PropsWithChildren"
+          },
+          "name": "PropsWithChildren",
+          "package": "@types/react",
+          "qualifiedName": "React.PropsWithChildren"
+        }
+      ]
+    },
+    {
+      "id": 1,
+      "name": "TestBasicComponent",
+      "variant": "declaration",
+      "kind": 64,
+      "flags": {},
+      "sources": [
+        {
+          "fileName": "TestBasic.tsx",
+          "line": 25,
+          "character": 16,
+          "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L25"
+        }
+      ],
+      "signatures": [
+        {
+          "id": 2,
+          "name": "TestBasicComponent",
+          "variant": "signature",
+          "kind": 4096,
+          "flags": {},
+          "comment": {
+            "summary": [
+              {
+                "kind": "text",
+                "text": "TestBasicComponent is a React component that uses a basic props type."
+              }
+            ],
+            "blockTags": [
+              {
+                "tag": "@category",
+                "content": [
+                  {
+                    "kind": "text",
+                    "text": "Component"
+                  }
+                ]
+              }
+            ]
+          },
+          "sources": [
+            {
+              "fileName": "TestBasic.tsx",
+              "line": 25,
+              "character": 16,
+              "url": "https://github.com/livesession/xyd/blob/f7723028e9645a625baf4e64224af48eb32d122f/packages/xyd-sources/packages/ts/__fixtures__/react/react-a/src/TestBasic.tsx#L25"
+            }
+          ],
+          "parameters": [
+            {
+              "id": 3,
+              "name": "props",
+              "variant": "param",
+              "kind": 32768,
+              "flags": {},
+              "type": {
+                "type": "reference",
+                "target": 4,
+                "name": "Props",
+                "package": "@xyd-sources-examples/react"
+              }
+            }
+          ],
+          "type": {
+            "type": "reference",
+            "target": {
+              "packageName": "@types/react",
+              "packagePath": "index.d.ts",
+              "qualifiedName": "React.ReactElement"
+            },
+            "name": "ReactElement",
+            "package": "@types/react",
+            "qualifiedName": "React.ReactElement"
+          }
+        }
+      ]
+    }
+  ],
+  "groups": [
+    {
+      "title": "Interfaces",
+      "children": [
+        4
+      ]
+    },
+    {
+      "title": "Functions",
+      "children": [
+        1
+      ]
+    }
+  ],
+  "categories": [
+    {
+      "title": "Component",
+      "children": [
+        1
+      ]
+    },
+    {
+      "title": "Other",
+      "children": [
+        4
+      ]
+    }
+  ],
+  "packageName": "@xyd-sources-examples/react",
+  "symbolIdMap": {
+    "0": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": ""
+    },
+    "1": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "TestBasicComponent"
+    },
+    "2": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "TestBasicComponent"
+    },
+    "3": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "props"
+    },
+    "4": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "Props"
+    },
+    "5": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "Props.name"
+    },
+    "6": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "Props.age"
+    },
+    "7": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "Props.isActive"
+    },
+    "8": {
+      "packageName": "@xyd-sources-examples/react",
+      "packagePath": "src/TestBasic.tsx",
+      "qualifiedName": "Props.createdAt"
+    }
+  },
+  "files": {
+    "entries": {
+      "1": "src/TestBasic.tsx"
+    },
+    "reflections": {
+      "1": 0
+    }
+  }
+}

package/packages/ts/__fixtures__/references-output-react.json

@@ -0,0 +1,68 @@
+[
+  {
+    "title": "TestBasicComponent",
+    "canonical": "@xyd-sources-examples/react/components/TestBasicComponent",
+    "description": "TestBasicComponent is a React component that uses a basic props type.\n",
+    "context": {
+      "symbolId": "1",
+      "symbolName": "TestBasicComponent",
+      "symbolKind": 64,
+      "packageName": "@xyd-sources-examples/react",
+      "fileName": "TestBasic.tsx",
+      "fileFullPath": "src/TestBasic.tsx",
+      "line": 25,
+      "col": 16,
+      "signatureText": {
+        "code": "export function TestBasicComponent(props: Props): ReactElement;",
+        "lang": "ts"
+      },
+      "sourcecode": {
+        "code": "export function TestBasicComponent(props: Props): ReactElement {\n    return <div>{props.children}</div>;\n}",
+        "lang": "ts"
+      },
+      "category": "Component",
+      "group": [
+        "@xyd-sources-examples",
+        "react",
+        "Component"
+      ]
+    },
+    "examples": {
+      "groups": []
+    },
+    "definitions": [
+      {
+        "title": "Props",
+        "properties": [
+          {
+            "name": "name",
+            "type": "string",
+            "description": "The name of the person.\n"
+          },
+          {
+            "name": "age",
+            "type": "number",
+            "description": "The age of the person.\n"
+          },
+          {
+            "name": "isActive",
+            "type": "boolean",
+            "description": "Whether the person is active.\n"
+          },
+          {
+            "name": "createdAt",
+            "type": "Date",
+            "description": "The date the person was created.\n"
+          }
+        ],
+        "meta": [
+          {
+            "name": "type",
+            "value": "parameters"
+          }
+        ],
+        "variants": []
+      }
+    ]
+  }
+]