Skip to content

Commit 3a30a32

Browse files
committed
docs: update readme with latest coder guts maing.go link
1 parent 7134537 commit 3a30a32

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ interface SimpleType<T extends Comparable> {
3232

3333
`guts` is a library, not a command line utility. This is to allow configuration with code, and also helps with package resolution.
3434

35-
See the [simple example](./example/simple) for a basic usage of the library. A larger example can be found in the [Coder repository](https://github.com/coder/coder/blob/a632a841d4f5666c2c1690801f88cd1a1fcffc00/scripts/apitypings/main.go).
35+
See the [simple example](./example/simple) for a basic usage of the library. A larger example can be found in the [Coder repository](https://github.com/coder/coder/blob/main/scripts/apitypings/main.go).
3636

3737
```go
3838
// Step 1: Create a new Golang parser
@@ -87,6 +87,14 @@ And the output is:
8787
export type EnumString = "bar" | "baz" | "foo" | "qux";
8888
```
8989

90+
# Alternative solutions
91+
92+
The guts package was created to offer a more flexible, programmatic alternative to existing Go-to-TypeScript code generation tools out there.
93+
94+
The other solutions out there function as command-line utilities with yaml configurability. `guts` is a library, giving it a much more flexible and dynamic configuration that static generators can’t easily support.
95+
96+
Unlike many of its counterparts, guts leverages the official TypeScript compiler under the hood, ensuring that the generated TypeScript definitions are semantically correct, syntactically valid, and aligned with the latest language features.
97+
9098

9199
# Helpful notes
92100

0 commit comments

Comments
 (0)