typos
All checks were successful
Lint and Format Check / lint-and-format (pull_request) Successful in 10s

This commit is contained in:
Mylloon 2024-09-17 11:34:29 +02:00
parent d1e7d82488
commit e37d1ad807
Signed by: Anri
GPG key ID: A82D63DFF8D1317F
2 changed files with 26 additions and 26 deletions

View file

@ -56,10 +56,10 @@ La norme pour les nom dans les fichiers est la suivante :
Évidemment ça peut s'additionner, Évidemment ça peut s'additionner,
par exemple : `c_NOM-COMMANDE_subX_optX_desc`. par exemple : `c_NOM-COMMANDE_subX_optX_desc`.
- Chaîne de charactère des évènements : - Chaîne de caractère des évènements :
`e` est utilisé pour `E`vènements. `e` est utilisé pour `E`vènements.
- `e_NOM-EVENEMENT_N` : `N` le nom de la chaîne de caractère - `e_NOM-EVENEMENT_N` : `N` le nom de la chaîne de caractère
- Chaîne de charactère des utils : - Chaîne de caractère des utils :
`u` est utilisé pour `U`tilitaires. `u` est utilisé pour `U`tilitaires.
- `u_NOM-FICHIER-UTILS_N` : `N` le nom de la chaîne de caractère - `u_NOM-FICHIER-UTILS_N` : `N` le nom de la chaîne de caractère
@ -69,7 +69,7 @@ La norme pour les nom dans les fichiers est la suivante :
doit être nommé `langue.json` avec `langue` suivant doit être nommé `langue.json` avec `langue` suivant
[cette liste](https://discord.com/developers/docs/reference#locales). [cette liste](https://discord.com/developers/docs/reference#locales).
2. Le contenu du fichier peut être copié du fichier de la langue par défaut, 2. Le contenu du fichier peut être copié du fichier de la langue par défaut,
[cf. au dessus](#langues). [cf. au-dessus](#langues).
3. Ce sont les valeurs des clés (le texte à gauche des `:`) qui doivent 3. Ce sont les valeurs des clés (le texte à gauche des `:`) qui doivent
être traduits. Merci par avance ! être traduits. Merci par avance !
> Ne vous forcez pas à tout traduire. Même une contribution avec > Ne vous forcez pas à tout traduire. Même une contribution avec
@ -80,27 +80,27 @@ La norme pour les nom dans les fichiers est la suivante :
1. Rechercher la langue dans le dossier [src/locales/](./src/locales/). 1. Rechercher la langue dans le dossier [src/locales/](./src/locales/).
2. Modifier/Ajouter des traductions comme 2. Modifier/Ajouter des traductions comme
[expliquer au dessus](#ajouter-une-langue) (à partir du `3.`). [expliquer au-dessus](#ajouter-une-langue) (à partir du `3.`).
> Pensez à vérifier si de nouvelles valeurs n'ont pas été ajouté dans > Pensez à vérifier si de nouvelles valeurs n'ont pas été ajouté dans
> le fichier langue par défaut, [cf. au dessus](#langues). > le fichier langue par défaut, [cf. au-dessus](#langues).
## Projet ## Projet
Le code se trouve dans le dosier [src/](./src/). Dans ce dossier il y a : Le code se trouve dans le dossier [src/](./src/). Dans ce dossier il y a :
- [commands/](./src/commands/) qui contient toutes les commandes, rangés par - [commands/](./src/commands/) qui contient toutes les commandes, rangés par
catégories catégories
- [events/](./src/events/) qui contient tous les évènements, rangés par - [events/](./src/events/) qui contient tous les évènements, rangés par
catégories catégories
- [locales/](./src/locales/) qui contient tous les fichiers de langue - [locales/](./src/locales/) qui contient tous les fichiers de langue
- [modules/](./src/modules/) qui contient les extensions utilisé, - [modules/](./src/modules/) qui contient les extensions utilisées,
par exemple, pour utiliser la fonction `capitalize()` d'un string, il faut par exemple, pour utiliser la fonction `capitalize()` d'un string, il faut
importer le fichier `string.ts` qui se trouve dans le dossier importer le fichier `string.ts` qui se trouve dans le dossier
- [utils/](./src/utils/) qui contient toutes les fonctions utilitaires, rangés - [utils/](./src/utils/) qui contient toutes les fonctions utilitaires, rangés
par fichiers par fichiers
Les dossiers [commands/](./src/commands/) et [events/](./src/events/) Les dossiers [commands/](./src/commands/) et [events/](./src/events/)
contiennent chaquin un fichier `loader.js` qui charge respectivement contiennent chacun un fichier `loader.js` qui charge respectivement
les commandes et les évènements dans le bot. les commandes et les évènements dans le bot.
## Ajouter une commande ## Ajouter une commande
@ -141,14 +141,14 @@ export default {
Rapidement, cette structure comporte 3 éléments : Rapidement, cette structure comporte 3 éléments :
- `scope` : une liste de guildId où la commande est disponible, si la liste est - `scope` : une liste de guildId où la commande est disponible, si la liste est vide,
est vide, la commande est disponible partout la commande est disponible partout
- `data` : représente les données envoyées à l'API de Discord - `data` : représente les données envoyées à l'API de Discord
- `interaction` : représente le comportement de la commande - `interaction` : représente le comportement de la commande
Ce template vous permet de commencé rapidement votre commande car il contient Ce modèle vous permet de commencer rapidement votre commande, car il contient
déjà tout ce qu'il faut pour le support des langues. Pensez bien à ne pas écrire déjà tout ce qu'il faut pour le support des langues. Pensez bien à ne pas écrire
directement vos chaînes de caractères ici mais bien dans directement vos chaînes de caractères ici, mais bien dans
les [fichiers de langues](./src/locales/), c'est à ça que la variable les [fichiers de langues](./src/locales/), c'est à ça que la variable
`loc` sert. `loc` sert.
@ -159,8 +159,8 @@ Vous devez aussi ajouter **obligatoirement** :
- `"c_COMMANDE_desc": "DESCRIPTION"` au fichier de langue, avec `COMMANDE` - `"c_COMMANDE_desc": "DESCRIPTION"` au fichier de langue, avec `COMMANDE`
le nom de la commande et `DESCRIPTION` la description de votre commande. le nom de la commande et `DESCRIPTION` la description de votre commande.
> Note: Il est possible d'ajouter de l'autocomplétion via > Note : Il est possible d'ajouter de l'autocomplétion via
> un 4ème élément : `autocomplete`. > un 4 élément : `autocomplete`.
## Ajouter un évènement ## Ajouter un évènement
@ -181,10 +181,10 @@ de discord.js de l'évènement
### Player ### Player
Les évènement du player ont la même logique les autres, mais sont placés Les évènements du player ont la même logique les autres, mais sont placés
dans le dossier [`player`](./src/events/player/). dans le dossier [`player`](./src/events/player/).
> Pour débogguer le player, il est possible d'ajouter un évènement `debug`, en > Pour déboguer le player, il est possible d'ajouter un évènement `debug`, en
> voici un exemple : > voici un exemple :
> >
> ```ts > ```ts
@ -204,7 +204,7 @@ Les modèles sont gérés [en dehors séparément du reste](./src/modals/).
Les boutons sont gérés [en dehors séparément du reste](./src/buttons/) Les boutons sont gérés [en dehors séparément du reste](./src/buttons/)
Chaque bouton à une implémentation séparée des autres, même si ils sont dans le Chaque bouton à une implémentation séparée des autres, même s'ils sont dans le
même message. même message.
Contrairement aux autres éléments, les boutons doivent se faire collecter via Contrairement aux autres éléments, les boutons doivent se faire collecter via
@ -212,7 +212,7 @@ la fonction [`collect`](./src/buttons/loader.ts#L46) juste après leur déclarat
## Autocomplétion ## Autocomplétion
La réponse qu'attent Discord doit se faire obligatoirement sous 3 secondes. La réponse qu'attend Discord doit se faire obligatoirement sous 3 secondes.
Pour se faire on peut utiliser un timeout avec Pour se faire on peut utiliser un timeout avec
[une race](https://fr.wikipedia.org/wiki/Situation_de_comp%C3%A9tition). [une race](https://fr.wikipedia.org/wiki/Situation_de_comp%C3%A9tition).
@ -243,7 +243,7 @@ la traduction.
- [Créez un fork](https://git.mylloon.fr/repo/fork/76) et poussez - [Créez un fork](https://git.mylloon.fr/repo/fork/76) et poussez
vos modifications dans ce dernier. vos modifications dans ce dernier.
Pour commencer, vous pouvez jeté un oeil aux Pour commencer, vous pouvez jeter un œil aux
[tickets facilement résolvable](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/issues?state=open&labels=82). [tickets facilement résolvable](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/issues?state=open&labels=82).
- De préférences, les fonctions, méthodes et variables seront écrites - De préférences, les fonctions, méthodes et variables seront écrites
@ -252,7 +252,7 @@ Pour commencer, vous pouvez jeté un oeil aux
## Soumettre ses modifications ## Soumettre ses modifications
1. Pensez à bien commenter votre code (en anglais) pour que n'importe qui 1. Pensez à bien commenter votre code (en anglais) pour que n'importe qui
comprennent vos modifications. Vérifier bien dans tout les fichiers si ce que comprennent vos modifications. Vérifier bien dans tous les fichiers si ce que
vous avez modifié n'est pas référencer ailleurs (exemple : si vous modifier vous avez modifié n'est pas référencer ailleurs (exemple : si vous modifier
une variable d'environnement, il faut penser à mettre à jour le une variable d'environnement, il faut penser à mettre à jour le
[`README`](./README.md#variables-denvironnements)). [`README`](./README.md#variables-denvironnements)).
@ -272,10 +272,10 @@ Pour commencer, vous pouvez jeté un oeil aux
> **Explication** > **Explication**
> >
> `npm run debug` execute le code depuis le dossier [`src`](src/) > `npm run debug` exécute le code depuis le dossier [`src`](src/)
> tandis que `npm run main` et l'image Docker le fait depuis le dossier `dist`. > tandis que `npm run main` et l'image Docker le fait depuis le dossier `dist`.
> >
> Docker est cependant différent car dans l'image, le dossier [`src`](src/) est > Docker est cependant différent, car dans l'image, le dossier [`src`](src/) est
> supprimé. > supprimé.
## Gestion du dépôt ## Gestion du dépôt
@ -283,6 +283,6 @@ Pour commencer, vous pouvez jeté un oeil aux
- On ne push jamais directement sur la branche `main`. - On ne push jamais directement sur la branche `main`.
- Quand on merge des modifications vers `main`, on fait un _squash_, - Quand on merge des modifications vers `main`, on fait un _squash_,
l'historique des modifications reste disponible dans l'historique des modifications reste disponible dans
[le graph](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/graph). [le graphe](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/graph).
- De préférences, suivre [ces conventions](https://www.conventionalcommits.org/fr/v1.0.0/) - De préférences, suivre [ces conventions](https://www.conventionalcommits.org/fr/v1.0.0/)
(cf. cette [partie précédente](#soumettre-ses-modifications)). (cf. cette [partie précédente](#soumettre-ses-modifications)).

View file

@ -40,9 +40,9 @@ services:
## Variables d'environnements ## Variables d'environnements
| Nom | Description | Par défaut | Commentaire | | Nom | Description | Par défaut | Commentaire |
| :-----------: | :---------------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | :-----------: | :---------------: | :--------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| TOKEN_DISCORD | Token Discord | Aucune | | TOKEN_DISCORD | Token Discord | Aucune |
| DEFAULT_LANG | Langue par défaut | `fr` | Expérimental, si la langue par défaut n'est pas complète (càd 100%), le bot pourrait ne pas fonctionner correctement.<br>Liste des traductions disponibles [ici](./src/locales/) | | DEFAULT_LANG | Langue par défaut | `fr` | Expérimental, si la langue par défaut n'est pas complète (c.-à-d. 100%), le bot pourrait ne pas fonctionner correctement.<br>Liste des traductions disponibles [ici](./src/locales/) |
## Volumes ## Volumes