Skip to content

Commit 3581f63

Browse files
authored
Add known issues
Signed-off-by: Cam McHenry <[email protected]>
1 parent 3ec49dc commit 3581f63

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/blog/2025-12-01-type-aware-alpha.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ bunx oxlint --type-aware -A all -D typescript/no-floating-promises
7676

7777
For more configuration options, see our [usage guide](/docs/guide/usage/linter/type-aware).
7878

79-
## What's New
79+
## What's new
8080

8181
### Support for type-checking while linting
8282

@@ -163,7 +163,7 @@ $ oxlint --type-aware
163163

164164
[Add performance benchmarks and comparisons]
165165

166-
## Technical Details
166+
## Technical details
167167

168168
### Architecture
169169

@@ -183,7 +183,7 @@ tsgolint (Go)
183183

184184
This design keeps Oxlint's core fast while leveraging TypeScript's type system through typescript-go. The frontend-backend separation means `oxlint` controls the user experience while `tsgolint` handles the heavy lifting of type analysis.
185185

186-
### TypeScript Compatibility
186+
### TypeScript compatibility
187187

188188
`tsgolint` is based on [typescript-go](https://github.com/microsoft/typescript-go), Microsoft's TypeScript v7.0 rewrite in Go, not the original TypeScript compiler. This means that you might encounter some features which are no longer supported.
189189

@@ -195,16 +195,20 @@ This design keeps Oxlint's core fast while leveraging TypeScript's type system t
195195

196196
If you're using deprecated features from TypeScript 6.0 or earlier, you'll need to migrate your codebase first. See the [TypeScript migration guide](https://github.com/microsoft/TypeScript/issues/62508#issuecomment-3348649259) for help updating deprecated tsconfig options.
197197

198-
### Implementation Details
198+
### Implementation details
199199

200200
`tsgolint` doesn't use typescript-go's public APIs. Instead, it compiles typescript-go by [shimming](https://github.com/oxc-project/tsgolint/tree/main/shim) internal APIs to make them accessible. We actively track typescript-go updates and fix breaking changes as needed.
201201

202202
Our typescript-go fork is synced regularly using renovatebot, ensuring we stay current with the latest improvements and fixes.
203203

204-
## What's Next
204+
### Known issues
205+
206+
While `tsgolint` is ready for testing in production codebases, you may encounter issues with running out of memory when working with very large codebases. We are working on optimizing the memory usage for the next milestone. We would love if you tried `tsgolint` and reported any out-of-memory issues to us in the [`tsgolint` repository](https://github.com/oxc-project/tsgolint) and included some details about your project to help us improve memory usage.
207+
208+
## What's next
205209

206210
[Add roadmap and future plans]
207211

208-
## Try It Out
212+
## Try it out
209213

210214
[Add call to action and community information]

0 commit comments

Comments
 (0)