https://github.com/william-versatile/typescript-project-playground-

https://github.com/william-versatile/typescript-project-playground-

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/william-versatile/typescript-project-playground-
• Owner: William-versatile
• License: mit
• Created: 2024-02-04T06:13:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-04T06:16:01.000Z (over 2 years ago)
• Last Synced: 2025-04-05T07:28:27.618Z (about 1 year ago)
• Size: 926 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

          
# Code Samples for Playground Plugins

This is a series of example plugins, which are extremely well documented and aim to give you samples to build from depending on what you want to build.

### TS Compiler API

Uses [`@typescript/vfs`](https://www.npmjs.com/package/@typescript/vfs) to set up a TypeScript project in the browser, and then displays all of the top-level functions as AST nodes in the sidebar.

![./samples/ts-program/screenshot/img.png](./samples/ts-program/screenshot/img.png)

[Key source file](./samples/ts-program/src/index.ts).

### TS Transformers Demo

Uses a custom TypeScript transformer when emitting JavaScript from the current file in the Playground.

![./samples/transformer/screenshot/img.png](./samples/transformer/screenshot/img.png)

[Key source file](./samples/transformer/src/index.ts).

### Using a Web-ish npm Dependency

Uses a dependency which isn't entirely optimised for running in a web page, but doesn't have too big of a dependency tree that it this becomes an issue either.

![./samples/webish-npm-dep/screenshot/img.png](./samples/webish-npm-dep/screenshot/img.png)

[Rollup Config](./samples/webish-npm-dep/rollup.config.js), [Key source file](./samples/webish-npm-dep/src/index.ts).

### Presenting Information Inline 

Using a fraction of the extensive Monaco API (monaco is the text editor at the core of the Playground) to showcase what parts of a TypeScript file would be removed by a transpiler to make it a JS file.

![./samples/monaco-highlights/screenshot/img.png](./samples/monaco-highlights/screenshot/img.png)

[Key source file](./samples/monaco-highlights/src/index.ts).

## Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions

provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 

trademarks or logos is subject to and must follow 

[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).

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.