@alloy-js/go 0.3.0-dev.2 → 0.3.0

package/docs/api/types/GoNamedTypeScope.md

@@ -0,0 +1,16 @@
+# GoNamedTypeScope
+
+This scope contains NamedTypeSymbols for types that are declared in containers like packages. This scope is a member scope which whose member symbol is a NamedTypeSymbol.
+
+## Members
+
+Extends [GoScope](../goscope/)
+
+|                   |                                                                                                                                               |                                                                                                                  |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| constructor       | (ownerSymbol: NamedTypeSymbol, parentScope: GoNamedTypeScope \| GoSourceFileScope \| GoModuleScope \| undefined, options: OutputScopeOptions) | Constructs a new instance of the [`GoNamedTypeScope`](GoNamedTypeScope.md) class                                                        |
+| declarationSpaces | never\[]                                                                                                                                      |                                                                                                                  |
+| enclosingPackage  | import(”../index.js”).[PackageSymbol](../packagesymbol/) \| undefined                                                                         |                                                                                                                  |
+| members           | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                          |                                                                                                                  |
+| ownerSymbol       | [NamedTypeSymbol](../namedtypesymbol/)                                                                                                        |                                                                                                                  |
+| typeParameters    | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                          | For now, we stuff type parameters into the member scope. This is to ensure name conflicts are handled correctly. |

package/docs/api/types/GoPackageScope.md

@@ -0,0 +1,10 @@
+# GoPackageScope
+
+## Members
+
+Extends [GoNamedTypeScope](../gonamedtypescope/)
+
+|             |                                                                              |                                                         |
+| ----------- | ---------------------------------------------------------------------------- | ------------------------------------------------------- |
+| constructor | (packageSymbol: PackageSymbol, parentScope: GoPackageScope \| GoModuleScope) | Constructs a new instance of the [`GoPackageScope`](GoPackageScope.md) class |
+| ownerSymbol | [PackageSymbol](../packagesymbol/)                                           |                                                         |

package/docs/api/types/GoScope.md

@@ -0,0 +1,10 @@
+# GoScope
+
+## Members
+
+Extends [OutputScope](../../../core/types/outputscope/)
+
+|                  |                                                                           |                                                  |
+| ---------------- | ------------------------------------------------------------------------- | ------------------------------------------------ |
+| constructor      | (name: string, parent: GoScope \| undefined, options: OutputScopeOptions) | Constructs a new instance of the [`GoScope`](GoScope.md) class |
+| enclosingPackage | [PackageSymbol](../packagesymbol/) \| undefined                           |                                                  |

package/docs/api/types/GoSourceFileScope.md

@@ -0,0 +1,13 @@
+# GoSourceFileScope
+
+## Members
+
+Extends [GoLexicalScope](../golexicalscope/)
+
+|                  |                                                                               |                                                            |
+| ---------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| constructor      | (name: string, parent: GoPackageScope, options: OutputScopeOptions)           | Constructs a new instance of the [`GoSourceFileScope`](GoSourceFileScope.md) class |
+| addImport        | (import\_: PackageSymbol) => GoSymbol                                         |                                                            |
+| enclosingPackage | [PackageSymbol](../packagesymbol/) \| undefined                               |                                                            |
+| imports          | import(“@vue/reactivity”).ShallowReactive<[ImportRecords](../importrecords/)> |                                                            |
+| parent           | [GoPackageScope](../gopackagescope/)                                          |                                                            |

package/docs/api/types/GoSymbol.md

@@ -0,0 +1,17 @@
+# GoSymbol
+
+This is the base type for all symbols in Go.
+
+Many subtypes of this symbol exist for specific purposes. However, this symbol may be used in cases where a more specific symbol is not required.
+
+## Members
+
+Extends [OutputSymbol](../../../core/types/outputsymbol/)
+
+|                            |                                                                                                         |                                                   |
+| -------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
+| constructor                | (name: string \| Namekey, spaces: OutputSpace\[] \| OutputSpace \| undefined, options: GoSymbolOptions) | Constructs a new instance of the [`GoSymbol`](GoSymbol.md) class |
+| copy                       | () => OutputSymbol                                                                                      |                                                   |
+| enclosingPackage           | [PackageSymbol](../packagesymbol/) \| undefined                                                         |                                                   |
+| protected getGoCopyOptions | () => GoSymbolOptions                                                                                   |                                                   |
+| protected initializeGoCopy | (copy: GoSymbol) => void                                                                                |                                                   |

package/docs/api/types/GoSymbolKinds.md

@@ -0,0 +1,5 @@
+# GoSymbolKinds
+
+```ts
+type GoSymbolKinds = "symbol" | "named-type" | "function" | "field" | "package";
+```

package/docs/api/types/GoSymbolOptions.md

@@ -0,0 +1,10 @@
+# GoSymbolOptions
+
+Options for creating a Go symbol.
+
+## Members
+
+Extends [OutputSymbolOptions](../../../core/types/outputsymboloptions/)
+
+|   |
+| - |

package/docs/api/types/ImportRecords.md

@@ -0,0 +1,5 @@
+# ImportRecords
+
+```ts
+type ImportRecords = Map<PackageSymbol, GoSymbol>;
+```

package/docs/api/types/InterfaceDescriptor.md

@@ -0,0 +1,9 @@
+# InterfaceDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |             |   |
+| ---- | ----------- | - |
+| kind | ”interface” |   |

package/docs/api/types/LibraryFrom.md

@@ -0,0 +1,5 @@
+# LibraryFrom
+
+```ts
+type LibraryFrom<T> = ResolveDescriptor<T> & LibrarySymbolReference;
+```

package/docs/api/types/MemberDescriptor.md

@@ -0,0 +1,8 @@
+# MemberDescriptor
+
+## Members
+
+|      |                                                                                                                                                                 |   |
+| ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | - |
+| kind | string                                                                                                                                                          |   |
+| type | optional [LibrarySymbolReference](../../../core/types/librarysymbolreference/) \| (() => [LibrarySymbolReference](../../../core/types/librarysymbolreference/)) |   |

package/docs/api/types/MethodDescriptor.md

@@ -0,0 +1,9 @@
+# MethodDescriptor
+
+## Members
+
+Extends [MemberDescriptor](../memberdescriptor/)
+
+|      |          |   |
+| ---- | -------- | - |
+| kind | ”method” |   |

package/docs/api/types/NamedTypeDescriptor.md

@@ -0,0 +1,8 @@
+# NamedTypeDescriptor
+
+## Members
+
+|         |        |   |
+| ------- | ------ | - |
+| kind    | string |   |
+| members | M      |   |

package/docs/api/types/NamedTypeSymbol.md

@@ -0,0 +1,17 @@
+# NamedTypeSymbol
+
+A symbol for a named type in Go such as a struct, interface, and so forth.
+
+## Members
+
+Extends [GoSymbol](../gosymbol/)
+
+|                |                                                                                                                                         |                                                          |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
+| constructor    | (name: string \| Namekey, spaces: OutputSpace\[] \| OutputSpace \| undefined, kind: NamedTypeTypeKind, options: NamedTypeSymbolOptions) | Constructs a new instance of the [`NamedTypeSymbol`](NamedTypeSymbol.md) class |
+| copy           | () => NamedTypeSymbol                                                                                                                   |                                                          |
+| members        | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                    |                                                          |
+| memberSpaces   | string\[]                                                                                                                               |                                                          |
+| symbolKind     | [NamedTypeSymbolKind](../namedtypesymbolkind/)                                                                                          |                                                          |
+| typeKind       | [NamedTypeTypeKind](../namedtypetypekind/)                                                                                              |                                                          |
+| typeParameters | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                    |                                                          |

package/docs/api/types/NamedTypeSymbolKind.md

@@ -0,0 +1,5 @@
+# NamedTypeSymbolKind
+
+```ts
+type NamedTypeSymbolKind = "named-type" | "package";
+```

package/docs/api/types/NamedTypeSymbolOptions.md

@@ -0,0 +1,9 @@
+# NamedTypeSymbolOptions
+
+## Members
+
+Extends [GoSymbolOptions](../gosymboloptions/)
+
+|                |                                      |   |
+| -------------- | ------------------------------------ | - |
+| typeParameters | optional [GoSymbol](../gosymbol/)\[] |   |

package/docs/api/types/NamedTypeTypeKind.md

@@ -0,0 +1,5 @@
+# NamedTypeTypeKind
+
+```ts
+type NamedTypeTypeKind = "import" | "function" | "var" | "type" | "struct" | "struct-member" | "interface" | "interface-member" | "package";
+```

package/docs/api/types/PackageDescriptor.md

@@ -0,0 +1,12 @@
+# PackageDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|         |                 |   |
+| ------- | --------------- | - |
+| kind    | ”package”       |   |
+| members | M               |   |
+| name    | optional string |   |
+| path    | optional string |   |

package/docs/api/types/PackageSymbol.md

@@ -0,0 +1,15 @@
+# PackageSymbol
+
+A symbol for a package in Go.
+
+## Members
+
+Extends [NamedTypeSymbol](../namedtypesymbol/)
+
+|                    |                                                                             |                                                        |
+| ------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------ |
+| constructor        | (name: string, parentPackage: PackageSymbol, options: PackageSymbolOptions) | Constructs a new instance of the [`PackageSymbol`](PackageSymbol.md) class |
+| builtin            | boolean                                                                     |                                                        |
+| copy               | () => PackageSymbol                                                         |                                                        |
+| fullyQualifiedName | string                                                                      |                                                        |
+| symbolKind         |                                                                             |                                                        |

package/docs/api/types/PackageSymbolOptions.md

@@ -0,0 +1,10 @@
+# PackageSymbolOptions
+
+## Members
+
+Extends [OutputSymbolOptions](../../../core/types/outputsymboloptions/)
+
+|         |                  |   |
+| ------- | ---------------- | - |
+| builtin | optional boolean |   |
+| path    | optional string  |   |

package/docs/api/types/ResolveDescriptor.md

@@ -0,0 +1,7 @@
+# ResolveDescriptor
+
+```ts
+type ResolveDescriptor<D> = D extends NamedTypeDescriptor<infer M> ? LibrarySymbolReference & {
+    [K in keyof M]: ResolveDescriptor<M[K]>;
+} : LibrarySymbolReference;
+```

package/docs/api/types/SourceFileHeaderProps.md

@@ -0,0 +1,9 @@
+# SourceFileHeaderProps
+
+## Members
+
+|               |                                                    |   |
+| ------------- | -------------------------------------------------- | - |
+| header        | optional [Children](../../../core/types/children/) |   |
+| headerComment | optional string                                    |   |
+| package       | string                                             |   |

package/docs/api/types/StrictDescriptor.md

@@ -0,0 +1,5 @@
+# StrictDescriptor
+
+```ts
+type StrictDescriptor = PackageDescriptor<Record<string, StrictDescriptor>> | FieldDescriptor | FunctionDescriptor | MethodDescriptor | VariableDescriptor | StructDescriptor<Record<string, StrictDescriptor>> | InterfaceDescriptor<Record<string, StrictDescriptor>> | TypeDescriptor<Record<string, StrictDescriptor>> | EmbedDescriptor;
+```

package/docs/api/types/StructDescriptor.md

@@ -0,0 +1,9 @@
+# StructDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |          |   |
+| ---- | -------- | - |
+| kind | ”struct” |   |

package/docs/api/types/TypeDescriptor.md

@@ -0,0 +1,9 @@
+# TypeDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |        |   |
+| ---- | ------ | - |
+| kind | ”type” |   |

package/docs/api/types/VariableDescriptor.md

@@ -0,0 +1,9 @@
+# VariableDescriptor
+
+## Members
+
+Extends [MemberDescriptor](../memberdescriptor/)
+
+|      |       |   |
+| ---- | ----- | - |
+| kind | ”var” |   |

package/docs/api/types/index.md

@@ -0,0 +1,38 @@
+# go — types
+
+- [CreateTypeParameterSymbolOptions](CreateTypeParameterSymbolOptions.md) — Extends [GoSymbolOptions](../gosymboloptions/)
+- [Descriptor](Descriptor.md) — type Descriptor = PackageDescriptor<any> | FieldDescriptor | FunctionDescriptor | MethodDescriptor | VariableDescriptor
+- [EmbedDescriptor](EmbedDescriptor.md) — Extends [MemberDescriptor](../memberdescriptor/)
+- [FieldDescriptor](FieldDescriptor.md) — Extends [MemberDescriptor](../memberdescriptor/)
+- [FunctionDescriptor](FunctionDescriptor.md) — Extends [MemberDescriptor](../memberdescriptor/)
+- [FunctionSymbol](FunctionSymbol.md) — A symbol for a function in Go, including receivers.
+- [GoElements](GoElements.md) — type GoElements = "parameter" | "type-parameter" | "function" | "type" | "variable" | "struct-member" | "interface-membe
+- [GoFunctionScope](GoFunctionScope.md) — Extends [GoLexicalScope](../golexicalscope/)
+- [GoLexicalScope](GoLexicalScope.md) — Extends [GoScope](../goscope/)
+- [GoModuleScope](GoModuleScope.md) — Extends [GoScope](../goscope/)
+- [GoNamedTypeScope](GoNamedTypeScope.md) — This scope contains NamedTypeSymbols for types that are declared in containers like packages.
+- [GoPackageScope](GoPackageScope.md) — Extends [GoNamedTypeScope](../gonamedtypescope/)
+- [GoScope](GoScope.md) — Extends [OutputScope](../../../core/types/outputscope/)
+- [GoSourceFileScope](GoSourceFileScope.md) — Extends [GoLexicalScope](../golexicalscope/)
+- [GoSymbol](GoSymbol.md) — This is the base type for all symbols in Go.
+- [GoSymbolKinds](GoSymbolKinds.md) — type GoSymbolKinds = "symbol" | "named-type" | "function" | "field" | "package";
+- [GoSymbolOptions](GoSymbolOptions.md) — Options for creating a Go symbol.
+- [ImportRecords](ImportRecords.md) — type ImportRecords = Map<PackageSymbol, GoSymbol>;
+- [InterfaceDescriptor](InterfaceDescriptor.md) — Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+- [LibraryFrom](LibraryFrom.md) — type LibraryFrom<T> = ResolveDescriptor<T> & LibrarySymbolReference;
+- [MemberDescriptor](MemberDescriptor.md)
+- [MethodDescriptor](MethodDescriptor.md) — Extends [MemberDescriptor](../memberdescriptor/)
+- [NamedTypeDescriptor](NamedTypeDescriptor.md)
+- [NamedTypeSymbol](NamedTypeSymbol.md) — A symbol for a named type in Go such as a struct, interface, and so forth.
+- [NamedTypeSymbolKind](NamedTypeSymbolKind.md) — type NamedTypeSymbolKind = "named-type" | "package";
+- [NamedTypeSymbolOptions](NamedTypeSymbolOptions.md) — Extends [GoSymbolOptions](../gosymboloptions/)
+- [NamedTypeTypeKind](NamedTypeTypeKind.md) — type NamedTypeTypeKind = "import" | "function" | "var" | "type" | "struct" | "struct-member" | "interface" | "interface-
+- [PackageDescriptor](PackageDescriptor.md) — Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+- [PackageSymbol](PackageSymbol.md) — A symbol for a package in Go.
+- [PackageSymbolOptions](PackageSymbolOptions.md) — Extends [OutputSymbolOptions](../../../core/types/outputsymboloptions/)
+- [ResolveDescriptor](ResolveDescriptor.md) — type ResolveDescriptor<D> = D extends NamedTypeDescriptor<infer M> ?
+- [SourceFileHeaderProps](SourceFileHeaderProps.md)
+- [StrictDescriptor](StrictDescriptor.md) — type StrictDescriptor = PackageDescriptor<Record<string, StrictDescriptor>> | FieldDescriptor | FunctionDescriptor | Met
+- [StructDescriptor](StructDescriptor.md) — Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+- [TypeDescriptor](TypeDescriptor.md) — Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+- [VariableDescriptor](VariableDescriptor.md) — Extends [MemberDescriptor](../memberdescriptor/)

package/docs/api/variables/index.md

@@ -0,0 +1,3 @@
+# go — variables
+
+- [std](std.md) — std: {