https://github.com/jcs090218/vscode-vscode_api
[WIP] - Easier way to use VS Code API.
https://github.com/jcs090218/vscode-vscode_api
api tool vscode vscode-ex
Last synced: 23 days ago
JSON representation
[WIP] - Easier way to use VS Code API.
- Host: GitHub
- URL: https://github.com/jcs090218/vscode-vscode_api
- Owner: jcs090218
- License: mit
- Created: 2019-03-07T14:55:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T02:56:41.000Z (about 2 years ago)
- Last Synced: 2025-02-13T12:24:06.581Z (3 months ago)
- Topics: api, tool, vscode, vscode-ex
- Language: TypeScript
- Homepage:
- Size: 267 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.com/jcs090218/vscode_api)
[](https://opensource.org/licenses/MIT)
# VS Code - API
Easier way to use VS Code API.
## Getting Started
### 1. Import this Tool
Add this line to the code to start to use this tool.
```ts
import { vscode_api } from "./vscode_api";
```
### 2. Create API class.
Ensure you are in a valid text editor.
```ts
// Get the current text editor.
let editor = vscode.window.activeTextEditor;
if (!editor)
return;
// Create the API.
let api = new VSCodeAPI(editor);
```
### 3. Enjoy!~
Start using the API from this tool. For instance,
```ts
// Make cursor goto the end of the current line.
api.endOfLine();
```
*P.S. Check out the API section for more API informations!!*
## API
List of API that this tool provided.
## Development
Here are the following steps to contribute to this project.
### 1. Clone this repository
```bash
$ git clone https://github.com/jcs090218/vscode-vscode_api
```
### 2. Start the project with VSCode
```bash
# Goto the project directory.
$ cd vscode-vscode_api
# Start the VSCode and start developing the tool.
$ code .
```
### 3. Make a pull request
Lastly, make a pull request to submit what you had changed to
this project. There shouldn't be any issue by directly open the
project from VS Code and you can hit `F5` to start development
and test.