go2ts

module

v1.6.0 Latest Latest Go to latest Published: Feb 9, 2022 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-generalize/go2ts

Links

Open Source Insights

README ¶

go2ts

What is go2ts?

go2ts is a TypeScript interface generator from Go struct.
Automatically recognize the Go module in the directory

Installation

$ go get github.com/go-generalize/go2ts

Usage

// ./example/main.go
package main

import (
    "time"
)

type Status string

const (
    StatusOK Status = "OK"
    StatusFailure Status = "Failure"
)

type Param struct {
    Status    Status
    Version   int
    Action    string
    CreatedAt time.Time
}

$ go2ts ./example
export type Param = {
        Action: string;
        CreatedAt: string;
        Status: "Failure" | "OK";
        Version: number;
}

Known Issues

#18: enums in indirectly parsed packages are not recognized.

TODO

Handle MarshalJSON/UnmarshalJSON

Directories ¶

Path	Synopsis
cmd
go2ts Package main is a CLI for go2ts	Package main is a CLI for go2ts
example
pkg
generator Package generator is a generator for TypeScript interfaces Package generator is TypeScript generator from AST Package generator is TypeScript generator from AST	Package generator is a generator for TypeScript interfaces Package generator is TypeScript generator from AST Package generator is TypeScript generator from AST
parser Package parser provides a Go module parser for TypeScript AST Package parser provides a Go module parser for TypeScript AST	Package parser provides a Go module parser for TypeScript AST Package parser provides a Go module parser for TypeScript AST
parser/testutil Package testutil offers test utility for parser	Package testutil offers test utility for parser
types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types	Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types Package types contains structs/interfaces representing TypeScript types
util Package util is a helper library for go2ts	Package util is a helper library for go2ts

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL