Repository files navigation

Not sure what this is? Read the announcement post!

This repo is very much under active development; as such there are no published artifacts at this time.Interested developers can clone and run locally to try out things as they become available.

This repo usesGo 1.24 or higher,Node.js with npm, andhereby.

For tests and code generation, this repo contains a git submodule to the main TypeScript repo pointing to the commit being ported.When cloning, you'll want to clone with submodules:

$git clone --recurse-submodules https://github.com/microsoft/typescript-go.git

If you have already cloned the repo, you can initialize the submodule with:

$git submodule update --init --recursive

With the submodule in place andnpm ci, you can run tasks viahereby, similar to the TypeScript repo:

$hereby build# Verify that the project builds$herebytest# Run all tests$hereby install-tools# Install additional tools such as linters$hereby lint# Run all linters$hereby format# Format all code$hereby generate# Generate all Go code (e.g. diagnostics, committed to repo)

Additional tasks are a work in progress.

hereby is not required to work on the repo; the regulargo tooling (e.g.,go build,go test ./...) will work as expected.hereby tasks are provided as a convenience for those familiar with the TypeScript repo.

After runninghereby build, you can runbuilt/local/tsgo, which behaves mostly the same astsc (respects tsconfig, but also prints out perf stats).This is mainly a testing entry point; for higher fidelity with regulartsc, runtsgo tsc [flags], which behaves more similarly totsc.

To try the prototype LSP experience:

• Run VS Code in the repo workspace (code .)
• Copy.vscode/launch.template.json to.vscode/launch.json
• F5 (orDebug: Start Debugging from the command palette)

This will launch a new VS Code instance which uses the Corsa LS as the backend. If correctly set up, you should see "typescript-go" as an option in the Output pane:

This is still a work in progress and is not yet at full feature parity with TypeScript. Bugs may exist. Please check this list carefully before logging a new issue or assuming an intentional change.

Status overview:

• Program creation (readlib,target,reference,import,files,include, andexclude):done. You should see thesame files, with modules resolved to thesame locations, as in a TypeScript 5.8 (TS5.8) invocation
  • Not all resolution modes are supported yet
• Parsing/scanning (read source text and determine syntax shape):done. You should see the exact samesyntax errors as in a TS5.8 invocation
• Commandline andtsconfig.json parsing:mostly done. Note that the entry point is slightly different (for now)
• Type resolution (resolve computed types to a concrete internal representation):done. You should see the same types as in TS5.8
• Type checking (check for problems in functions, classes, and statements):done. You should see the same errors, in the same locations, with the same messages, as TS 5.8
  • Types printback in errors may display slightly differently; this is in progress
• JavaScript-specific inference and JS Doc:not ready
• JSX:not ready
• Declaration emit:not ready. Coming soon!
• Emit (JS output):in progress.target: esnext (minimal downleveling) is well-supported but other targets may have gaps
• Watch mode:prototype (watches the correct files and rebuilds, but doesn't do incremental rechecking)
• Build mode / project references:not ready
• Incremental build:not ready
• Language service (LSP):prototype only, expect minimal functionality (errors, hover, go to def). More features soon!
  • ASCII files only for now
• API:not ready

Definitions:

• done aka "believed done": We're not currently aware of any deficits or major left work to do. OK to log bugs
• in progress: currently being worked on; some features may work and some might not. OK to log panics, but nothing else please
• prototype: proof-of-concept only; do not log bugs
• not ready: either haven't even started yet, or far enough from ready that you shouldn't bother messing with it yet

Long-term, we expect this repo is that its contents will be merged intomicrosoft/TypeScript.As a result, the repo and issue tracker for typescript-go will eventually be closed, so treat discussions/issues accordingly.

For a list of intentional changes with respect to TypeScript 5.7, see CHANGES.md.

This project welcomes contributions and suggestions. Most contributions require you to agree to aContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant usthe rights to use your contribution. For details, visitContributor License Agreements.

When you submit a pull request, a CLA bot will automatically determine whether you need to providea CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructionsprovided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsofttrademarks or logos is subject to and must followMicrosoft's Trademark & Brand Guidelines.Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.Any use of third-party trademarks or logos are subject to those third-party's policies.