microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-12 12:57:11 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Updated Writing a Language Service Plugin (markdown)

Orta Therox 2022-01-06 15:26:41 +00:00
parent 8270593cb4
commit 09d8552359
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Writing-a-Language-Service-Plugin.md

@ -19,6 +19,10 @@ Examples of things language plugins cannot do:
Developers using the plugin will `npm install --save-dev your_plugin_name` and edit their `tsconfig.json` file to enable your plugin.
## Kickstart your plugin
There is a template repo which shows a working development environment for a TSServer Plugin here: https://github.com/orta/TypeScript-TSServer-Plugin-Template
## Overview: Writing a Simple Plugin
Let's write a simple plugin. Our plugin will remove a user-configurable list of property names from the completion list. You might use this sort of plugin on your team to help remind you which APIs are 'banned' (for example, using the `caller` property of `function` is discouraged).