grammyjs / grammyjs/vscode

chore: snippets missing documentation on use, not showing in ctrl+space menu, snippets design, sidebar docs

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
TypeScript
Stars
24
Forks
2
PR merge metrics
No merged PRs in 30d

Description

- [ ] add more clear documentation to snippet usage
- [ ] add snippets list in the grammy sidebar menu
- [ ] add snippets to show in the ctrl+space menu inside the text editor
- [ ] add toggleable snippets for most used / popular pluggins
example: if using and toggle the commands plugin, instead of bot.command etcetc,
should do (on every _word_ it means the cursor-tab write selection thing)
```ts
_commandsName_.command('_name_', '_description_', (ctx) => { ctx._method_ (_cursorEndsHere_)} )
```
example2:
```ts
const _menu_ = new Menu("_my-menu-identifier_")
._text_(_cursorEndsHere_)
```
- [ ] improve snippet flexibility using tab write to ctx._method_ instead of fixed ctx.reply('example')
```yaml
"body": [
"bot.command('${1:command}', (ctx) => {",
"",
"ctx._method_(_cursorEndsHere_),
"});",
]
```
-[ ] add to the grammy sidebar menu a tab for checking / unchecking the plugins you are using, so the snippets change based on that? In the same list it could have a links to the docs for that plugin?

I'll do a pr when I have time

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.