-
Notifications
You must be signed in to change notification settings - Fork 105
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: bun related docs (@stonega) #1129
base: main
Are you sure you want to change the base?
Conversation
- changed bot.ts to index.ts - mention bun at hosting docs
🚀 Deployed on https://672ba04b361fba2ac161c972--grammy.netlify.app |
Should we leave |
I have now wasted more time on this than I ever wanted, maybe I'll get back to this in a week or so |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bottom line of this is still that whatever we do with the tutorial, the output must look exactly like
website/site/docs/guide/getting-started.md
Lines 56 to 66 in 53c1efe
Create a new empty text file, e.g. called `bot.ts`. | |
Your folder structure should now look like this: | |
```asciiart:no-line-numbers | |
. | |
├── bot.ts | |
├── node_modules/ | |
├── package.json | |
├── package-lock.json | |
└── tsconfig.json | |
``` |
I'll get into this page in more detail tomorrow |
Remember to merge |
Scratch that, it already happened |
I even did it myself *facepalm* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still does not create the same TS config as tsc --init
if I understand this correctly
Unfortunately we can't fix it. We will have to ask the user to change it manually every time. |
Yeah but I don't want to go through all the code examples and make sure that they compile even with the non-standard TS config that bun introduces. It can be fixed very easily by running |
I am agree with @MasedMSD. I don't see any problem with the default generated tsconfig.json. Pretty sure it works well with our examples. |
Then please go through them and verify this. Also, please test all future changes to the docs for bun compatibility. I don't care what the config file contains, I just won't double the time I spend on code examples just to make a few bun users happy. |
Fine, so we going to use this solution? |
Co-authored-by: Qz <[email protected]> Co-authored-by: Winston H. <[email protected]>
Only as soon as we find somebody who actually puts in the work and makes sure that the code examples work. I don't want to merge docs that don't type-check because then I'm gonna be the one who has to deal with all the complaints. If somebody is willing to
then we can ship docs that use a new TS config setup. |
@KnorpelSenf It would be useful to create some package for easy unit testing of the bot. |
Is that in any way related to the current pull request? |
I mean that we should have some kind of tests to make sure that the bot and the code work. For example, as for the situation now, when we can't be sure that bun will pass all type-checks |
That's why you have to test it, or adjust the TS config. But I'm beginning to repeat myself a little |
It’ll be hard to write integration tests for Bun and grammY because the existing test suite is in Deno. We’d have to spend a lot of time instrumenting some Docker CI test just specifically for Bun, and I am not sure if it’s worth the effort. |
There's no need to actually run any tests, why do you think this? I can't follow |
Originally PR was created by @stonega, but it looks like he's not going to continue with this PR. So, I think we should mention Bun as a possible way to work with a bot, even though Bun has a large number of issues. Also Bun finally supports conversations plugin and a decent part of Russian language chat users use it for their projects.
I made some changes and added Bun mentions to the hosting files documentation