quarto-dev / quarto-dev/quarto

VS Code Extension: Add a public API

Open
#547 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
645
Forks
62
Avg merge
17h 42m
Merged PRs (30d)
13

Description

Initial Reasoning for Feature

In the VSCode Extension, I was trying to interface with it using the VSCode API. Specifically I was trying to run

vscode.extensions.getExtension("quarto.quarto").activate().then((quartoApi) => {
// Do something with api 
});

but I get undefined from the quartoApi variable.

Feature Request

Please add a public API to the VSCode Extension.

It would be very helpful to be able to integrate with the quarto.quarto VSCode extension through an API similar to how Microsoft has APIs for their VSCode extensions such as the vscjava.vscode-gradle VSCode extension

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the VS Code extension's activation entry point and reviewing how vscode.extensions.getExtension("quarto.quarto").activate() currently behaves. Compare the requested integration with the linked vscode-gradle Extension.ts API example, then define the public API scope and verify that activation returns it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.