Skip to content

Commit

Permalink
Configure Markdownlint (#810)
Browse files Browse the repository at this point in the history
Co-authored-by: Habemuscode <habemuscode@protonmail.com>
Co-authored-by: Roj <rojvv@icloud.com>
Co-authored-by: Ciki Momogi <cikimomogi@protonmail.com>
Co-authored-by: grammyz <grammyz@users.noreply.github.com>
  • Loading branch information
5 people authored Oct 2, 2023
1 parent 608bca3 commit 81d2070
Show file tree
Hide file tree
Showing 51 changed files with 1,923 additions and 2,269 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ jobs:
- name: Check Formatting
run: deno fmt --check

lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: actions/setup-node@v3
with:
node-version: latest

- name: Check Linting
working-directory: ./site
run: |
npm ci
npm run docs:lint
links:
runs-on: ubuntu-latest
steps:
Expand Down
7 changes: 7 additions & 0 deletions site/.markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"line-length": false,
"link-fragments": false,
"no-trailing-punctuation": {
"punctuation": ".,;:。,;:" // everything except exclamation points
}
}
2 changes: 2 additions & 0 deletions site/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ features:
details: grammY has you covered when your bot gets popular and the traffic increases.
---

<!-- markdownlint-disable no-inline-html -->

<HomeContent>

## Quickstart
Expand Down
2 changes: 2 additions & 0 deletions site/docs/es/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ features:
details: grammY te tiene cubierto cuando tu bot se vuelve popular y el tráfico se incrementa.
---

<!-- markdownlint-disable no-inline-html -->

<HomeContent>

## Quickstart
Expand Down
2 changes: 2 additions & 0 deletions site/docs/es/guide/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- markdownlint-disable first-line-heading -->

![grammY](/images/grammY.svg)

# Resumen
Expand Down
2 changes: 1 addition & 1 deletion site/docs/es/guide/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Los comandos son entidades especiales en los mensajes de Telegram, que sirven como instrucciones para los bots.

# Uso
## Uso

> Revisa la sección de comandos en las [Características de los bots de Telegram](https://core.telegram.org/bots/features#commands) escrita por el equipo de Telegram.
Expand Down
37 changes: 13 additions & 24 deletions site/docs/es/guide/filter-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,35 +120,24 @@ bot.on(":file"); // archivos en mensajes o mensajes del canal
bot.on("edit:file"); // ediciones de mensajes de archivos o mensajes de canales de archivos
```

### Consejos útiles
### Azúcar sintáctico

Hay dos casos especiales para las partes de consulta que hacen más cómodo el filtrado para usuarios.
Puedes detectar bots en las consultas con la parte de consulta `:is_bot`.
El azúcar sintáctico `:me` se puede utilizar para referirse a tu bot desde una consulta, que comparará los identificadores de usuario por ti.
El azúcar sintáctico `:me` se puede utilizar para referirse a su bot desde dentro de una consulta, que comparará los identificadores de usuario para usted.

```ts
bot.on("message:new_chat_members:is_bot"); // un bot se ha unido al chat
bot.on("message:left_chat_member:me"); // tu bot abandonó el chat (fue eliminado)
// Un mensaje de servicio sobre un bot que se unió al chat
bot.on("message:new_chat_members:is_bot");
// Un mensaje de servicio sobre un bot que se ha dado de baja
bot.on("message:left_chat_member:me");
```

::: tip Filtrar por propiedades del usuario

Si quieres filtrar por otras propiedades de un usuario, necesitas realizar una petición adicional, por ejemplo `await ctx.getAuthor()` para el autor del mensaje.
Las consultas de filtrado no realizarán secretamente otras peticiones a la API por ti.
Sigue siendo sencillo realizar este tipo de filtrado:

```ts
bot.on("message").filter(
async (ctx) => {
const user = await ctx.getAuthor();
return user.status === "creator" || user.status === "administrator";
},
(ctx) => {
// Maneja mensajes de creadores y administradores.
},
);
```

:::
Ten en cuenta que, aunque este azúcar sintáctico es útil para trabajar con mensajes de servicio, no debe utilizarse para detectar si alguien se une o abandona un chat.
Los mensajes de servicio son mensajes que informan a los usuarios en el chat, y algunos de ellos no serán visibles en todos los casos.
Por ejemplo, en los grupos grandes, no habrá mensajes de servicio sobre los usuarios que se unen o abandonan el chat.
Por lo tanto, es posible que tu bot no se dé cuenta de ello.
En su lugar, deberías escuchar las [actualizaciones de los miembros del chat](#actualizaciones-de-los-miembros-del-chat).

## Combinación de varias consultas

Expand Down Expand Up @@ -304,7 +293,7 @@ Análogamente, puedes hacer uso de los tipos de consulta de filtro que grammY ut

### Reutilización de los tipos de consulta de filtro

Internamente, `matchFilter` utiliza los [type predicates] de TypeScript (https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) para acotar el tipo de `ctx`.
Internamente, `matchFilter` utiliza los [predicados de tipo](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) de TypeScript para acotar el tipo de `ctx`.
Toma un tipo `C extends Context` y un `Q extends FilterQuery` y produce `ctx is Filter<C, Q>`.
En otras palabras, el tipo `Filter` es lo que realmente recibes para tu `ctx` en el middleware.

Expand Down
6 changes: 2 additions & 4 deletions site/docs/es/hosting/cyclic.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Como se muestra en la línea resaltada arriba, estamos usando `/<bot-token>` en

Cree un archivo `.env` en la raíz de su proyecto con el siguiente contenido:

```
```text
BOT_TOKEN=<bot-token>
NODE_ENV=DEVELOPMENT
```
Expand All @@ -136,9 +136,7 @@ Nodemon vigilará tu archivo `bot.ts` y reiniciará tu bot en cada cambio de có

1. Crea un repositorio en GitHub, puede ser privado o público.
2. Empuja tu código.

> Es recomendable que tengas una única rama estable y hagas tus pruebas en ramas separadas, para no desplegar comportamientos inesperados en producción.
> Es recomendable que tengas una única rama estable y hagas tus pruebas en ramas separadas, para no desplegar comportamientos inesperados en producción.
3. Visita tu [Cyclic dashboard](https://app.cyclic.sh).
4. Haz clic en "Link Your Own" y selecciona tu repositorio.
5. Vaya a Avanzado > Variables y añada su `BOT_TOKEN`.
Expand Down
8 changes: 4 additions & 4 deletions site/docs/es/hosting/deno-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Aquí, estamos usando el token del bot (`/<bot token>`).
1. Crea un repositorio en GitHub, puede ser privado o público.
2. Empuja tu código.

> Es recomendable que tengas una única rama estable y que hagas tus pruebas en otras ramas, para que no te ocurran cosas inesperadas.
> Es recomendable que tengas una única rama estable y que hagas tus pruebas en otras ramas, para que no te ocurran cosas inesperadas.
3. Visita tu [Deno Deploy dashboard](https://dash.deno.com/projects).
4. Haz clic en "Nuevo proyecto", y ve a la sección "Despliegue desde el repositorio de GitHub".
Expand All @@ -74,9 +74,9 @@ Aquí, estamos usando el token del bot (`/<bot token>`).
4. [Crear un token de acceso](https://dash.deno.com/user/access-tokens).
5. Ejecuta el siguiente comando:

```sh
deployctl deploy --project <project> ./mod.ts --prod --token <token>
```
```sh
deployctl deploy --project <project> ./mod.ts --prod --token <token>
```

6. Para configurar las acciones de Github, consulte [esto](https://github.com/denoland/deployctl/blob/main/action/README.md).

Expand Down
Loading

0 comments on commit 81d2070

Please sign in to comment.