- Notifications
You must be signed in to change notification settings - Fork928
feat: Switch packages for typescript generation code#1196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
18 commits Select commitHold shift + click to select a range
ee71acd
feat: Switch packages for typescript generation code
Emyrkb0b17d0
Add enum functionality
Emyrk28c2811
Handle reused types
Emyrk710b427
Add comment
Emyrk071026d
Allow ignoring types for autogen
Emyrk2741efa
Fix ignore, add optional fields
Emyrkc62feeb
Add map support
Emyrk462ebeb
Handle unknown types better
Emyrk21d1687
Add comments, run gen
Emyrk9a3d7e3
Add basic readme
Emyrk1afaa5d
Merge remote-tracking branch 'origin/main' into stevenmasley/redo_typ…
Emyrk7cfba41
Reorder imports
Emyrk0127e6d
Sort all output
Emyrk0d943f1
Add 'DO NOT EDIT' to the top
Emyrk2379c21
Go linting
Emyrk3865f36
Fix typescript linter
Emyrk176b481
Use correct array size for allocation
Emyrk0d37eeb
Update readme
EmyrkFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 2 additions & 0 deletionscodersdk/client.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionsgo.mod
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionsgo.sum
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletionsscripts/apitypings/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
#APITypings | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. praise: Wonderful documentation! | ||
This main.go generates typescript types from the codersdk types in Go. | ||
#Features | ||
- Supports Go types | ||
-[x] Basics (string/int/etc) | ||
-[x] Maps | ||
-[x] Slices | ||
-[x] Enums | ||
-[x] Pointers | ||
-[ ] External Types (uses`any` atm) | ||
- Some custom external types are hardcoded in (eg: time.Time) | ||
##Type overrides | ||
```golang | ||
typeFoostruct { | ||
// Force the typescript type to be a number | ||
CreatedAt time.Duration`json:"created_at" typescript:"number"` | ||
} | ||
``` | ||
##Ignore Types | ||
Do not generate ignored types. | ||
```golang | ||
// @typescript-ignore InternalType | ||
typeInternalTypestruct { | ||
// ... | ||
} | ||
``` | ||
#Future Ideas | ||
- Should`omitempty` in the`json` tag indicate optional? | ||
- Use a yaml config for overriding certain types |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.