Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: VS Code extension #159

Closed
KnorpelSenf opened this issue Dec 13, 2021 · 3 comments
Closed

feat: VS Code extension #159

KnorpelSenf opened this issue Dec 13, 2021 · 3 comments

Comments

@KnorpelSenf
Copy link
Member

We may want to have some sort of integration between the docs and the code editor in order to bring even better documentation into the workflow. This is a very hard task (unless someone shows up who has prior experience in creating VSCode extensions) but it may be pretty outstanding in the development experience.

As a starting point, we may want to bundle up the logic of #158 into the extension and display it when the user hovers the cursor over a filter query.

@code-withAshish
Copy link
Contributor

I was wondering about the implementation of the extension if it was to be made as grammy is written primarily in typescript which provides a robust IDE support and autocompletion out of the box.
So what exactly do we mean when we say

We may want to have some sort of integration between the docs and the code editor in order to bring even better documentation into the workflow.

@KnorpelSenf
Copy link
Member Author

That's explained in the next paragraph. For example, filter queries have no tooltip that explains which updates are matched by the respective query. We sometimes get questions regarding the differences between certain filter queries, because people have to derive this from the documentation website. Bringing #158 into the editor solves this.

We will also be able to provide grammY-aware autocomplete that can suggest commonly used code snippets. For example, bot.on could autocomplete to the entire

bot.on("", async (ctx) => {
  // TODO implement handler
})

and place the cursor between the "" and so on.

There might be more ways how the extension could assist you (automatically suggest and install plugins from a UI, project scaffolding, webhook integration generation, maybe even displaying doc pages inline in the editor by passing the Markdown from the repo to the editor's markdown preview so that you don't have to context-switch) but the original description of this issue would likely be a good start before anything else here is implemented.

@KnorpelSenf
Copy link
Member Author

Further things will be tracked in https://github.com/grammyjs/vscode.

@rojvv rojvv changed the title feat: VSCode extension feat: VS Code extension Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants