Document roziscoding/grammy-autoquote

site/docs/.vuepress/config.ts

@@ -250,6 +250,10 @@ export default defineUserConfig({
                     text: "Useful Middleware",
                     link: "/plugins/middlewares.html",
                   },
+                  {
+                    text: "Autoquote",
+                    link: "/plugins/autoquote.html",
+                  },
                   {
                     text: "[Submit your PR!]",
                     link: "/plugins/#submitting-your-own-package-to-the-docs",

site/docs/plugins/autoquote.md

@@ -0,0 +1,146 @@
+# Always Replying to Messages
+
+It is sometimes necessary to always send messages as replies, especially for bots that are meant to be used in groups.
+We usually do this by adding the `reply_to_message_id` parameter to the methods that send the message: `sendText`, `reply`, `sendPhoto`, `replyWithPhoto` and etc.
+However, if you're doing this for every single message, it can get messy and boring.
+
+This plugin sets the `reply_to_message_id` parameter to `ctx.msg.message_id` for all `reply*` and `send*` methods that support it to make every message a reply to the message that triggered it.
+
+## Usage
+
+### In Specific Routes
+
+If you want all messages sent within a specific context (like a specific command), you can specifically apply the plugin to them:
+
+<CodeGroup>
+  <CodeGroupItem title="TypeScript" active>
+
+```ts
+import { Bot } from "grammy";
+import { addReplyParam } from "@roziscoding/grammy-autoquote";
+
+const bot = new Bot("");
+
+bot.command("demo", async (ctx) => {
+  ctx.api.config.use(addReplyParam(ctx));
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+  <CodeGroupItem title="JavaScript">
+
+```js
+const { Bot } = require("grammy");
+const { addReplyParam } = require("@roziscoding/grammy-autoquote");
+
+const bot = new Bot("");
+
+bot.command("demo", async (ctx) => {
+  ctx.api.config.use(addReplyParam(ctx));
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+  <CodeGroupItem title="Deno">
+
+```ts
+import { Bot } from "https://deno.land/x/grammy/mod.ts";
+import { addReplyParam } from "https://deno.land/x/grammy_autoquote/mod.ts";
+
+const bot = new Bot("");
+
+bot.command("demo", async (ctx) => {
+  ctx.api.config.use(addReplyParam(ctx));
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+</CodeGroup>
+
+### In for All Routes
+
+If you want every sent message to reply the messages that triggered them, you can apply the plugin this way:
+
+<CodeGroup>
+  <CodeGroupItem title="TypeScript" active>
+
+```ts
+import { Bot } from "grammy";
+import { autoQuote } from "@roziscoding/grammy-autoquote";
+
+const bot = new Bot("");
+
+bot.use(autoQuote);
+
+bot.command("demo", async (ctx) => {
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.command("hello", async (ctx) => {
+  await ctx.reply("Hi there :)"); // this quotes the user's message, too
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+  <CodeGroupItem title="JavaScript">
+
+```js
+const { Bot } = require("grammy");
+const { autoQuote } = require("@roziscoding/grammy-autoquote");
+
+const bot = new Bot("");
+
+bot.use(autoQuote);
+
+bot.command("demo", async (ctx) => {
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.command("hello", async (ctx) => {
+  await ctx.reply("Hi there :)"); // this quotes the user's message, too
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+  <CodeGroupItem title="Deno">
+
+```ts
+import { Bot } from "https://deno.land/x/grammy/mod.ts";
+import { autoQuote } from "https://deno.land/x/grammy_autoquote/mod.ts";
+
+const bot = new Bot("");
+
+bot.use(autoQuote);
+
+bot.command("demo", async (ctx) => {
+  await ctx.reply("Demo command!"); // this is going to quote the user's message
+});
+
+bot.command("hello", async (ctx) => {
+  await ctx.reply("Hi there :)"); // this quotes the user's message, too
+});
+
+bot.start();
+```
+
+</CodeGroupItem>
+</CodeGroup>
+
+## Plugin Summary
+
+- Name: Autoquote
+- Source: <https://github.com/roziscoding/grammy-autoquote>
+- Reference: <https://doc.deno.land/https://deno.land/x/grammy_autoquote/mod.ts>