-
Notifications
You must be signed in to change notification settings - Fork 7
/
tygoja.go
246 lines (199 loc) · 5.28 KB
/
tygoja.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
package tygoja
import (
"fmt"
"path/filepath"
"regexp"
"strings"
"golang.org/x/tools/go/packages"
)
// Tygoja is a generator for one or more input packages,
// responsible for linking them together if necessary.
type Tygoja struct {
conf *Config
parent *Tygoja
implicitPackages map[string][]string
generatedTypes map[string][]string
}
// New initializes a new Tygoja generator from the specified config.
func New(config Config) *Tygoja {
config.InitDefaults()
return &Tygoja{
conf: &config,
implicitPackages: map[string][]string{},
generatedTypes: map[string][]string{},
}
}
// Generate executes the generator and produces the related TS files.
func (g *Tygoja) Generate() (string, error) {
// extract config packages
configPackages := make([]string, 0, len(g.conf.Packages))
for p, types := range g.conf.Packages {
if len(types) == 0 {
continue // no typings
}
configPackages = append(configPackages, p)
}
// load packages info
pkgs, err := packages.Load(&packages.Config{
Mode: packages.NeedSyntax | packages.NeedFiles | packages.NeedDeps | packages.NeedImports | packages.NeedTypes,
}, configPackages...)
if err != nil {
return "", err
}
var s strings.Builder
// Heading
if g.parent == nil {
s.WriteString("// GENERATED CODE - DO NOT MODIFY BY HAND\n")
if g.conf.Heading != "" {
s.WriteString(g.conf.Heading)
}
// write base types
// ---
s.WriteString("type ")
s.WriteString(BaseTypeDict)
s.WriteString(" = { [key:string | number | symbol]: any; }\n")
s.WriteString("type ")
s.WriteString(BaseTypeAny)
s.WriteString(" = any\n")
// ---
}
for i, pkg := range pkgs {
if len(pkg.Errors) > 0 {
return "", fmt.Errorf("%+v", pkg.Errors)
}
if len(pkg.GoFiles) == 0 {
return "", fmt.Errorf("no input go files for package index %d", i)
}
if len(g.conf.Packages[pkg.ID]) == 0 {
// ignore the package as it has no typings
continue
}
pkgGen := &PackageGenerator{
conf: g.conf,
pkg: pkg,
types: g.conf.Packages[pkg.ID],
generatedTypes: map[string]struct{}{},
unknownTypes: map[string]struct{}{},
imports: map[string][]string{},
}
code, err := pkgGen.Generate()
if err != nil {
return "", err
}
for t := range pkgGen.generatedTypes {
g.generatedTypes[pkg.ID] = append(g.generatedTypes[pkg.ID], t)
}
for t := range pkgGen.unknownTypes {
parts := strings.Split(t, ".")
var tPkg string
var tName string
if len(parts) == 0 {
continue
}
if len(parts) == 2 {
// type from external package
tPkg = parts[0]
tName = parts[1]
} else {
// unexported type from the current package
tName = parts[0]
// already mapped for export
if pkgGen.isTypeAllowed(tName) {
continue
}
tPkg = packageNameFromPath(pkg.ID)
// add to self import later
pkgGen.imports[pkg.ID] = []string{tPkg}
}
for p, aliases := range pkgGen.imports {
for _, alias := range aliases {
if tName != "" && alias == tPkg && !g.isGenerated(p, tName) && !exists(g.implicitPackages[p], tName) {
if g.implicitPackages[p] == nil {
g.implicitPackages[p] = []string{}
}
g.implicitPackages[p] = append(g.implicitPackages[p], tName)
break
}
}
}
}
s.WriteString(code)
}
// recursively try to generate the found unknown types
if len(g.implicitPackages) > 0 {
subConfig := *g.conf
subConfig.Heading = ""
if (subConfig.TypeMappings) == nil {
subConfig.TypeMappings = map[string]string{}
}
// extract the nonempty package definitions
subConfig.Packages = make(map[string][]string, len(g.implicitPackages))
for p, types := range g.implicitPackages {
if len(types) == 0 {
continue
}
subConfig.Packages[p] = types
}
subGenerator := New(subConfig)
subGenerator.parent = g
subResult, err := subGenerator.Generate()
if err != nil {
return "", err
}
s.WriteString(subResult)
}
return s.String(), nil
}
func (g *PackageGenerator) markAsGenerated(t string) {
g.generatedTypes[t] = struct{}{}
}
func (g *Tygoja) isGenerated(pkg string, name string) bool {
if g.parent != nil && g.parent.isGenerated(pkg, name) {
return true
}
if len(g.generatedTypes[pkg]) == 0 {
return false
}
for _, t := range g.generatedTypes[pkg] {
if t == name {
return true
}
}
return false
}
// isTypeAllowed checks whether the provided type name is allowed by the generator "types".
func (g *PackageGenerator) isTypeAllowed(name string) bool {
name = strings.TrimSpace(name)
if name == "" {
return false
}
for _, t := range g.types {
if t == name || t == "*" {
return true
}
}
return false
}
var versionRegex = regexp.MustCompile(`^v\d+$`)
// packageNameFromPath extracts and normalizes the imported package identifier.
//
// For example:
//
// "github.com/labstack/echo/v5" -> "echo"
// "github.com/go-ozzo/ozzo-validation/v4" -> "ozzo_validation"
func packageNameFromPath(path string) string {
name := filepath.Base(strings.Trim(path, `"' `))
if versionRegex.MatchString(name) {
name = filepath.Base(filepath.Dir(path))
}
return strings.ReplaceAll(name, "-", "_")
}
// exists checks if search exists in list.
func exists[T comparable](list []T, search T) bool {
for _, v := range list {
if v == search {
return true
}
}
return false
}