@data-vegle/rbxts-go 0.0.0-stage → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +181 -2
  3. package/README.rbxtsgo.md +169 -0
  4. package/THIRD_PARTY_NOTICES.md +745 -0
  5. package/cli/cli.go +454 -0
  6. package/compile/compile.go +388 -0
  7. package/compile/declarations.go +221 -0
  8. package/compile/incremental.go +349 -0
  9. package/compile/times.go +9 -0
  10. package/docs/plugin-api.md +243 -0
  11. package/go.mod +20 -0
  12. package/go.sum +24 -0
  13. package/internal/difftest/difftest.go +530 -0
  14. package/internal/plugintest/plugintest.go +181 -0
  15. package/luau/create.go +351 -0
  16. package/luau/doc.go +71 -0
  17. package/luau/globals.go +178 -0
  18. package/luau/jsnum.go +188 -0
  19. package/luau/kinds.go +128 -0
  20. package/luau/list.go +227 -0
  21. package/luau/nodes.go +479 -0
  22. package/luau/operators.go +46 -0
  23. package/luau/render.go +134 -0
  24. package/luau/render_expressions.go +264 -0
  25. package/luau/render_fields.go +81 -0
  26. package/luau/render_indexable.go +81 -0
  27. package/luau/render_state.go +134 -0
  28. package/luau/render_statements.go +235 -0
  29. package/luau/render_util.go +296 -0
  30. package/luau/solve_temp_ids.go +212 -0
  31. package/luau/typeguards.go +175 -0
  32. package/luau/util.go +184 -0
  33. package/luau/visit.go +138 -0
  34. package/npm/index.d.ts +3 -0
  35. package/npm/rbxts-go.sh +187 -0
  36. package/package.json +45 -5
  37. package/patches/typescript/0001-checker-exports.patch +40 -0
  38. package/patches/typescript/0002-iterable-arity.patch +15 -0
  39. package/patches/typescript/0003-context-sensitive-this.patch +15 -0
  40. package/patches/typescript/0004-printer-keep-parse-tree-parentheses.patch +26 -0
  41. package/pluginapi/host.go +31 -0
  42. package/pluginapi/pluginapi.go +153 -0
  43. package/plugins/LICENSE-rbxts-transformer-setget +18 -0
  44. package/plugins/apply.go +342 -0
  45. package/plugins/config.go +431 -0
  46. package/plugins/fallback.go +84 -0
  47. package/plugins/fixemit.go +60 -0
  48. package/plugins/native.go +271 -0
  49. package/plugins/session.go +236 -0
  50. package/plugins/setget.go +478 -0
  51. package/project/copy.go +333 -0
  52. package/project/include/Promise.lua +2068 -0
  53. package/project/include/RuntimeLib.lua +260 -0
  54. package/project/nodepath/nodepath.go +917 -0
  55. package/project/pathtranslator/pathtranslator.go +214 -0
  56. package/project/project.go +498 -0
  57. package/project/rojoresolver/json.go +248 -0
  58. package/project/rojoresolver/rojoresolver.go +559 -0
  59. package/project/shared/constants.go +83 -0
  60. package/project/shared/diagnostic.go +238 -0
  61. package/project/shared/diagnostics.go +388 -0
  62. package/project/shared/elapsed.go +14 -0
  63. package/project/shared/eol_other.go +6 -0
  64. package/project/shared/eol_windows.go +4 -0
  65. package/project/shared/kleur.go +40 -0
  66. package/project/shared/util.go +183 -0
  67. package/scripts/build-with-plugins.sh +130 -0
  68. package/scripts/setup-third-party.sh +75 -0
  69. package/transformer/add_index_diagnostics.go +21 -0
  70. package/transformer/add_one_if_array_type.go +15 -0
  71. package/transformer/array_binding_pattern_contains_hoists.go +25 -0
  72. package/transformer/assert_never.go +24 -0
  73. package/transformer/assignment.go +64 -0
  74. package/transformer/call_macros.go +70 -0
  75. package/transformer/check_variable_hoist.go +125 -0
  76. package/transformer/clean_module_name.go +28 -0
  77. package/transformer/constructor_macros.go +122 -0
  78. package/transformer/convert_to_indexable_expression.go +12 -0
  79. package/transformer/create_binary_from_operator.go +86 -0
  80. package/transformer/create_continue_statements.go +68 -0
  81. package/transformer/create_get_service.go +15 -0
  82. package/transformer/create_hoist_declaration.go +27 -0
  83. package/transformer/create_import_expression.go +220 -0
  84. package/transformer/create_string_from_literal.go +195 -0
  85. package/transformer/create_truthiness_checks.go +63 -0
  86. package/transformer/create_type_check.go +9 -0
  87. package/transformer/ensure_transform_order.go +53 -0
  88. package/transformer/expression_chain.go +27 -0
  89. package/transformer/expression_might_mutate.go +60 -0
  90. package/transformer/find_constructor.go +15 -0
  91. package/transformer/fixup_whitespace_and_decode_entities.go +377 -0
  92. package/transformer/get_accessor_for_binding_type.go +160 -0
  93. package/transformer/get_add_iterable_to_array_builder.go +363 -0
  94. package/transformer/get_assignable_value.go +15 -0
  95. package/transformer/get_constant_value_literal.go +20 -0
  96. package/transformer/get_declared_variables.go +34 -0
  97. package/transformer/get_extends_node.go +23 -0
  98. package/transformer/get_flags.go +21 -0
  99. package/transformer/get_kind_name.go +18 -0
  100. package/transformer/get_original_symbol_of_node.go +16 -0
  101. package/transformer/get_source_file_from_module_specifier.go +68 -0
  102. package/transformer/get_statements.go +12 -0
  103. package/transformer/has_multiple_definitions.go +18 -0
  104. package/transformer/hoist_functions_past_final_statement.go +43 -0
  105. package/transformer/identifier_macros.go +17 -0
  106. package/transformer/is_blocked_by_try_statement.go +19 -0
  107. package/transformer/is_method.go +104 -0
  108. package/transformer/is_symbol_mutable.go +26 -0
  109. package/transformer/is_symbol_of_value.go +11 -0
  110. package/transformer/is_used_as_statement.go +25 -0
  111. package/transformer/is_valid_method_index_without_call.go +36 -0
  112. package/transformer/macro_manager.go +92 -0
  113. package/transformer/object_accessor.go +32 -0
  114. package/transformer/offset.go +58 -0
  115. package/transformer/pointer.go +53 -0
  116. package/transformer/property_call_macros.go +1035 -0
  117. package/transformer/state.go +606 -0
  118. package/transformer/transform_array_assignment_pattern.go +65 -0
  119. package/transformer/transform_array_binding_pattern.go +49 -0
  120. package/transformer/transform_array_literal_expression.go +97 -0
  121. package/transformer/transform_await_expression.go +12 -0
  122. package/transformer/transform_binary_expression.go +221 -0
  123. package/transformer/transform_binding_name.go +25 -0
  124. package/transformer/transform_block.go +14 -0
  125. package/transformer/transform_boolean_literal.go +13 -0
  126. package/transformer/transform_break_statement.go +26 -0
  127. package/transformer/transform_call_expression.go +266 -0
  128. package/transformer/transform_class_constructor.go +125 -0
  129. package/transformer/transform_class_declaration.go +12 -0
  130. package/transformer/transform_class_expression.go +14 -0
  131. package/transformer/transform_class_like_declaration.go +355 -0
  132. package/transformer/transform_conditional_expression.go +70 -0
  133. package/transformer/transform_continue_statement.go +30 -0
  134. package/transformer/transform_decorators.go +253 -0
  135. package/transformer/transform_delete_expression.go +17 -0
  136. package/transformer/transform_do_statement.go +39 -0
  137. package/transformer/transform_element_access_expression.go +114 -0
  138. package/transformer/transform_entity_name.go +21 -0
  139. package/transformer/transform_enum_declaration.go +135 -0
  140. package/transformer/transform_export_assignment.go +57 -0
  141. package/transformer/transform_export_declaration.go +150 -0
  142. package/transformer/transform_expression.go +120 -0
  143. package/transformer/transform_expression_statement.go +71 -0
  144. package/transformer/transform_for_of_statement.go +461 -0
  145. package/transformer/transform_for_statement.go +599 -0
  146. package/transformer/transform_function_declaration.go +84 -0
  147. package/transformer/transform_function_expression.go +48 -0
  148. package/transformer/transform_identifier.go +194 -0
  149. package/transformer/transform_if_statement.go +44 -0
  150. package/transformer/transform_import_declaration.go +146 -0
  151. package/transformer/transform_import_equals_declaration.go +46 -0
  152. package/transformer/transform_import_expression.go +36 -0
  153. package/transformer/transform_initializer.go +22 -0
  154. package/transformer/transform_interpolated_string_part.go +12 -0
  155. package/transformer/transform_jsx.go +41 -0
  156. package/transformer/transform_jsx_attributes.go +110 -0
  157. package/transformer/transform_jsx_children.go +50 -0
  158. package/transformer/transform_jsx_element.go +14 -0
  159. package/transformer/transform_jsx_expression.go +20 -0
  160. package/transformer/transform_jsx_fragment.go +42 -0
  161. package/transformer/transform_jsx_self_closing_element.go +13 -0
  162. package/transformer/transform_jsx_tag_name.go +53 -0
  163. package/transformer/transform_logical.go +160 -0
  164. package/transformer/transform_logical_or_coalescing_assignment_expression.go +103 -0
  165. package/transformer/transform_method_declaration.go +102 -0
  166. package/transformer/transform_module_declaration.go +143 -0
  167. package/transformer/transform_new_expression.go +27 -0
  168. package/transformer/transform_no_substitution_template_literal.go +16 -0
  169. package/transformer/transform_numeric_literal.go +15 -0
  170. package/transformer/transform_object_assignment_pattern.go +86 -0
  171. package/transformer/transform_object_binding_pattern.go +49 -0
  172. package/transformer/transform_object_literal_expression.go +107 -0
  173. package/transformer/transform_omitted_expression.go +9 -0
  174. package/transformer/transform_optional_chain.go +312 -0
  175. package/transformer/transform_parameters.go +124 -0
  176. package/transformer/transform_parenthesized_expression.go +17 -0
  177. package/transformer/transform_property_access_expression.go +37 -0
  178. package/transformer/transform_property_declaration.go +33 -0
  179. package/transformer/transform_property_name.go +20 -0
  180. package/transformer/transform_return_statement.go +83 -0
  181. package/transformer/transform_source_file.go +230 -0
  182. package/transformer/transform_spread_element.go +35 -0
  183. package/transformer/transform_statement.go +84 -0
  184. package/transformer/transform_statement_list.go +90 -0
  185. package/transformer/transform_string_literal.go +22 -0
  186. package/transformer/transform_super_keyword.go +9 -0
  187. package/transformer/transform_switch_statement.go +145 -0
  188. package/transformer/transform_tagged_template_expression.go +34 -0
  189. package/transformer/transform_template_expression.go +35 -0
  190. package/transformer/transform_this_expression.go +33 -0
  191. package/transformer/transform_throw_statement.go +18 -0
  192. package/transformer/transform_try_statement.go +192 -0
  193. package/transformer/transform_type_expression.go +12 -0
  194. package/transformer/transform_unary_expression.go +79 -0
  195. package/transformer/transform_variable_statement.go +178 -0
  196. package/transformer/transform_void_expression.go +13 -0
  197. package/transformer/transform_while_statement.go +34 -0
  198. package/transformer/transform_writable.go +69 -0
  199. package/transformer/transform_yield_expression.go +56 -0
  200. package/transformer/type_guards.go +30 -0
  201. package/transformer/types.go +381 -0
  202. package/transformer/validate_identifier.go +17 -0
  203. package/transformer/validate_method_assignment.go +106 -0
  204. package/transformer/validate_not_any.go +37 -0
  205. package/transformer/wrap_expression_statement.go +20 -0
  206. package/transformer/wrap_return_if_lua_tuple.go +63 -0
  207. package/transformer/wrap_statements_as_generator.go +22 -0
  208. package/tsbridge/affected.go +141 -0
  209. package/tsbridge/config.go +71 -0
  210. package/tsbridge/diagnostics.go +128 -0
  211. package/tsbridge/doc.go +16 -0
  212. package/tsbridge/macros.go +207 -0
  213. package/tsbridge/macrospec.go +30 -0
  214. package/tsbridge/pool.go +142 -0
  215. package/tsbridge/project.go +137 -0
  216. package/tsbridge/reprint.go +120 -0
  217. package/tsbridge/update.go +128 -0
  218. package/watch/poll.go +126 -0
  219. package/watch/session.go +651 -0
  220. package/watch/watch.go +180 -0
package/watch/watch.go ADDED
@@ -0,0 +1,180 @@
1
+ // Package watch is the port of src/Project/functions/setupProjectWatchProgram.ts from roblox-ts 3.0.0: `rbxtsc -w`.
2
+ //
3
+ // The messages and the order of work match upstream. How a rebuild works doesn't: see
4
+ // docs/watch-and-incremental.md.
5
+ package watch
6
+
7
+ import (
8
+ "context"
9
+ "fmt"
10
+ "io"
11
+ "os"
12
+ "path/filepath"
13
+ "runtime"
14
+ "strings"
15
+ "time"
16
+
17
+ "github.com/microsoft/TypeScript/tsc/internal/diagnostics"
18
+ "github.com/microsoft/TypeScript/tsc/internal/execute/watchmanager"
19
+ "github.com/microsoft/TypeScript/tsc/internal/tspath"
20
+ "github.com/microsoft/TypeScript/tsc/internal/vfs/osvfs"
21
+ "github.com/microsoft/TypeScript/tsc/rbxtsgo/compile"
22
+ "github.com/microsoft/TypeScript/tsc/rbxtsgo/plugins"
23
+ "github.com/microsoft/TypeScript/tsc/rbxtsgo/project/shared"
24
+ )
25
+
26
+ // DefaultDebounce is how long a change has to stay quiet before a rebuild starts. fswatch already coalesces for 50ms,
27
+ // so this only has to catch what spills over. Upstream's chokidar and its timer wait 150ms between them.
28
+ const DefaultDebounce = 20 * time.Millisecond
29
+
30
+ // maxDebounce bounds the wait while events keep coming, so something rewriting files all the time can't starve a
31
+ // rebuild.
32
+ const maxDebounce = 500 * time.Millisecond
33
+
34
+ // pollInterval is chokidar's default interval.
35
+ const pollInterval = 100 * time.Millisecond
36
+
37
+ // Config says what to watch and how.
38
+ type Config struct {
39
+ // Load reads the project options and data. It runs at the start and again after a config file changes.
40
+ Load func() (*shared.ProjectData, error)
41
+ // Checkers is the pool size. Zero means up to 8, more than a build uses, because a rebuild is all about latency.
42
+ Checkers int
43
+ // UsePolling walks the watched folders on a timer instead of using native notifications.
44
+ UsePolling bool
45
+ // Debounce replaces DefaultDebounce when it's positive.
46
+ Debounce time.Duration
47
+ // Output receives what upstream writes through ts.sys.write. Nil means stdout.
48
+ Output io.Writer
49
+ // OnCycle runs after each compile and its report. Tests use it. It must not keep Cycle.Result's diagnostics.
50
+ OnCycle func(*Cycle)
51
+ // Backend replaces the file watching backend. Tests use it.
52
+ Backend watchmanager.WatchBackend
53
+ // FullRebuilds turns off everything kept between compiles: each one checks and lowers every file. Tests use it to
54
+ // compare the two, and RBXTSGO_WATCH_FULL=1 sets it, to measure what the shortcuts save.
55
+ FullRebuilds bool
56
+ // PluginOptions are the plugin settings from the command line.
57
+ PluginOptions plugins.Options
58
+ // BeforeCompile runs after a cycle has taken its events, just before it compiles. Tests use it.
59
+ BeforeCompile func()
60
+ }
61
+
62
+ // Run watches until ctx ends. It returns an error only if the first load fails or if watching can't start. Compile
63
+ // errors are reported, and the watcher goes on.
64
+ func Run(ctx context.Context, config Config) error {
65
+ if config.Output == nil {
66
+ config.Output = os.Stdout
67
+ }
68
+ if config.Debounce <= 0 {
69
+ config.Debounce = DefaultDebounce
70
+ }
71
+ if config.Checkers == 0 {
72
+ // Measured on the generated project: 4 to 8 took a mid-size edit from 227ms to 171ms and a wide one from 406ms to
73
+ // 278ms, for about 40 MB. 16 gained less, and took more memory. A leaf edit stayed the same. See the benchmarks.
74
+ config.Checkers = min(8, runtime.NumCPU())
75
+ }
76
+ fsys := osvfs.FS()
77
+ manager := watchmanager.NewWatchManager(os.Stderr, func(dir tspath.RootedDirectoryPath) bool {
78
+ return fsys.DirectoryExists(dir)
79
+ }, fsys.CaseSensitivity())
80
+ switch {
81
+ case config.Backend != nil:
82
+ manager.SetBackend(config.Backend)
83
+ case config.UsePolling:
84
+ manager.SetBackend(newPollingBackend(pollInterval))
85
+ default:
86
+ manager.EnsureDefaultBackend()
87
+ }
88
+ defer manager.CloseAllWatches()
89
+
90
+ s, err := newSession(config, manager)
91
+ if err != nil {
92
+ return err
93
+ }
94
+ // Watching starts before the first compile, as upstream waits for chokidar's "ready", so a save during it counts.
95
+ if err := s.reconcileWatches(); err != nil {
96
+ return err
97
+ }
98
+
99
+ report := func(started time.Time, debounce time.Duration) {
100
+ result := s.runCompile()
101
+ s.reportEmitResult(result, time.Since(started))
102
+ s.finishCycle(started, debounce, result)
103
+ }
104
+ s.reportText("Starting compilation in watch mode...")
105
+ report(time.Now(), 0)
106
+
107
+ for {
108
+ select {
109
+ case <-ctx.Done():
110
+ return nil
111
+ case <-manager.DoCycleCh():
112
+ }
113
+ // This is openEventCollection, closeEventCollection and upstream's 100ms timer.
114
+ changed, overflow := manager.DrainEvents()
115
+ s.collect(changed, overflow)
116
+ if !s.hasPending() {
117
+ continue
118
+ }
119
+ started := time.Now()
120
+ s.reportText("File change detected. Starting incremental compilation...")
121
+ s.waitForQuiet(ctx, manager, config.Debounce)
122
+ if ctx.Err() != nil {
123
+ return nil
124
+ }
125
+ // Anything saved from here on raises a new signal, so it can't be lost: it gets the next cycle.
126
+ changed, overflow = manager.DrainEvents()
127
+ s.collect(changed, overflow)
128
+ report(started, time.Since(started))
129
+ }
130
+ }
131
+
132
+ // waitForQuiet returns once no event has come for quiet, or after maxDebounce.
133
+ func (s *session) waitForQuiet(ctx context.Context, manager *watchmanager.WatchManager, quiet time.Duration) {
134
+ deadline := time.NewTimer(maxDebounce)
135
+ defer deadline.Stop()
136
+ timer := time.NewTimer(quiet)
137
+ defer timer.Stop()
138
+ for {
139
+ select {
140
+ case <-ctx.Done():
141
+ return
142
+ case <-deadline.C:
143
+ return
144
+ case <-timer.C:
145
+ return
146
+ case <-manager.DoCycleCh():
147
+ changed, overflow := manager.DrainEvents()
148
+ s.collect(changed, overflow)
149
+ timer.Reset(quiet)
150
+ }
151
+ }
152
+ }
153
+
154
+ // reportText is watchReporter: ts.createWatchStatusReporter(ts.sys, true).
155
+ func (s *session) reportText(message string) {
156
+ fmt.Fprintf(s.config.Output, "[\x1b[90m%s\x1b[0m] %s%s%s", time.Now().Format("3:04:05 PM"), message, shared.EOL, shared.EOL)
157
+ }
158
+
159
+ // reportEmitResult is reportEmitResult, plus how long the build took, which JS doesn't print.
160
+ func (s *session) reportEmitResult(result *compile.EmitResult, elapsed time.Duration) {
161
+ cwd := shared.ProcessCwd()
162
+ caseSensitivity := osvfs.FS().CaseSensitivity()
163
+ amtErrors := 0
164
+ for _, d := range result.Diagnostics {
165
+ fmt.Fprint(s.config.Output, shared.FormatDiagnostics([]*shared.Diagnostic{d}, cwd, caseSensitivity, shared.EOL), shared.EOL)
166
+ if d.Category() == diagnostics.CategoryError {
167
+ amtErrors++
168
+ }
169
+ }
170
+ plural := "s"
171
+ if amtErrors == 1 {
172
+ plural = ""
173
+ }
174
+ s.reportText(fmt.Sprintf("Found %d error%s. Watching for file changes. (%s)", amtErrors, plural, shared.FormatElapsed(elapsed)))
175
+ }
176
+
177
+ // eventPath puts a path from fswatch in the form the project uses: forward slashes, no trailing one.
178
+ func eventPath(path tspath.RootedPath) string {
179
+ return strings.TrimSuffix(filepath.ToSlash(path.AsString()), "/")
180
+ }