test: add check-format command and run it in CI

Author: targos

.github/workflows/ci.yml

@@ -29,6 +29,9 @@ jobs:
       - name: Check types
         run: npm run check-types
 
+      - name: Check formatting
+        run: npm run check-format
+
   test:
     runs-on: ubuntu-latest
     steps:

.prettierignore

@@ -0,0 +1,3 @@
+build
+data
+node_modules

.prettierrc renamed to .prettierrc.json

@@ -122,11 +122,14 @@ Si besoin de stocker des settings basique, la table `kv` est disponible avec l'a
 Les clés doivent être des `string`, les valeurs peuvent être n'importe quoi, sachant que ce sera sérialisé / désérialisé de JSON (donc pas de données circulaires, pas de fonctions).
 
 ```typescript
-import { KeyValue } from "#src/database/";
+import { KeyValue } from '#src/database/';
 
-await KeyValue.set('MyCron-LastRunResult', 'https://github.com/ES-Community/bot/issues/17');
+await KeyValue.set(
+  'MyCron-LastRunResult',
+  'https://github.com/ES-Community/bot/issues/17',
+);
 const myLastResult = await KeyValue.get('MyCron-LastRunResult');
 
 if (result === myLastResult) return;
 notify(result);
-```
+```

README.md

@@ -7,32 +7,32 @@ module.exports = {
   development: {
     client: 'better-sqlite3',
     connection: {
-      filename: './dev.sqlite3'
+      filename: './dev.sqlite3',
     },
-    useNullAsDefault: true
+    useNullAsDefault: true,
   },
 
   staging: {
     client: 'better-sqlite3',
     connection: {
-      filename: './staging.sqlite3'
+      filename: './staging.sqlite3',
     },
-    useNullAsDefault: true
+    useNullAsDefault: true,
   },
 
   production: {
     client: 'better-sqlite3',
     connection: {
-      filename: './prod.sqlite3'
+      filename: './prod.sqlite3',
     },
-    useNullAsDefault: true
+    useNullAsDefault: true,
   },
-  
+
   test: {
     client: 'better-sqlite3',
     connection: {
-      filename: './test.sqlite3'
+      filename: './test.sqlite3',
     },
-    useNullAsDefault: true
+    useNullAsDefault: true,
   },
 };

knexfile.js

@@ -2,19 +2,18 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = function(knex) {
-  return knex.schema
-    .createTable('kv', table => {
-      table.string('key').notNullable();
-      table.primary('key');
-      table.json('value');
-    });
+exports.up = function (knex) {
+  return knex.schema.createTable('kv', (table) => {
+    table.string('key').notNullable();
+    table.primary('key');
+    table.json('value');
+  });
 };
 
 /**
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = function(knex) {
+exports.down = function (knex) {
   return knex.schema.dropTable('kv');
 };

migrations/20220916142133_InitDatabase.js

@@ -4,13 +4,14 @@
   "private": true,
   "scripts": {
     "build": "tsc -p tsconfig.prod.json",
+    "check-format": "prettier --check .",
     "check-types": "tsc --noEmit",
     "heroku-postbuild": "npm run build",
-    "format": "prettier --write src tests",
+    "format": "prettier --write .",
     "lint": "eslint src --ext ts",
     "lint-fix": "npm run lint -- --fix",
     "start": "nodemon --watch \"src/**/*.ts\" -e ts --exec \"ts-node -r dotenv/config src/bot.ts | pino-pretty\"",
-    "test": "npm run test-only && npm run lint && npm run check-types",
+    "test": "npm run test-only && npm run lint && npm run check-types && npm run check-format",
     "test-only": "jest",
     "test-coverage": "jest --coverage"
   },

package.json

@@ -29,7 +29,7 @@ export default new Cron({
 
     for (const game of games) {
       context.logger.info(`Found a new offered game (${game.title})`);
-      
+
       const message = new MessageEmbed({ title: game.title, url: game.link });
       game.thumbnail && message.setThumbnail(game.thumbnail);
       game.banner && message.setImage(game.banner);
@@ -71,13 +71,13 @@ interface EpicGamesProducts {
           productSlug: string;
           catalogNs: {
             mappings: {
-              pageSlug: string,
-              pageType: 'productHome' | 'offer'
+              pageSlug: string;
+              pageType: 'productHome' | 'offer';
             }[];
           };
           offerMappings: {
-            pageSlug: string,
-            pageType: 'productHome' | 'offer'
+            pageSlug: string;
+            pageType: 'productHome' | 'offer';
           }[];
           urlSlug: string;
           price: {
@@ -217,30 +217,36 @@ export async function getOfferedGames(
 
   return games.map<Game>((game) => {
     const discount = game.price.lineOffers[0].appliedRules[0];
-    let slug = game.productSlug
-      || game.offerMappings?.find(i => i.pageType === 'productHome')?.pageSlug
-      || game.catalogNs.mappings?.find(i => i.pageType === 'productHome')?.pageSlug
-      || (!/^[0-9a-f]+$/.test(game.urlSlug) && game.urlSlug)
-      || '';
-    
+    let slug =
+      game.productSlug ||
+      game.offerMappings?.find((i) => i.pageType === 'productHome')?.pageSlug ||
+      game.catalogNs.mappings?.find((i) => i.pageType === 'productHome')
+        ?.pageSlug ||
+      (!/^[0-9a-f]+$/.test(game.urlSlug) && game.urlSlug) ||
+      '';
+
     if (!slug) {
       logger.error(game, 'No slug foundable');
     }
-  
+
     // Sanitize the slug (e.g. sludge-life/home -> sludge-life).
     const slugSlashIndex = slug.indexOf('/');
     if (slugSlashIndex >= 0) {
       slug = slug.slice(0, slugSlashIndex);
     }
-    
+
     const link = slug
       ? `https://www.epicgames.com/store/fr/p/${slug}`
       : 'https://store.epicgames.com/fr/free-games';
-    
-    let thumbnail = game.keyImages.find((image) => image.type === 'Thumbnail')?.url;
+
+    let thumbnail = game.keyImages.find(
+      (image) => image.type === 'Thumbnail',
+    )?.url;
     thumbnail = thumbnail && encodeURI(thumbnail);
-    
-    let banner = game.keyImages.find((image) => image.type === 'OfferImageWide')?.url;
+
+    let banner = game.keyImages.find(
+      (image) => image.type === 'OfferImageWide',
+    )?.url;
     banner = banner && encodeURI(banner);
 
     return {

src/crons/EpicGames.ts

@@ -1,34 +1,34 @@
-import { MessageEmbed } from "discord.js";
-import got from "got";
-import { Logger } from "pino";
+import { MessageEmbed } from 'discord.js';
+import got from 'got';
+import { Logger } from 'pino';
 
-import { Cron, findTextChannelByName } from "../framework";
-import { parse } from "node-html-parser";
+import { Cron, findTextChannelByName } from '../framework';
+import { parse } from 'node-html-parser';
 
 const dateFmtOptions: Intl.DateTimeFormatOptions = {
-  timeZone: "Europe/Paris",
-  year: "numeric",
-  month: "long",
-  day: "numeric",
-  hour: "numeric",
-  minute: "numeric"
+  timeZone: 'Europe/Paris',
+  year: 'numeric',
+  month: 'long',
+  day: 'numeric',
+  hour: 'numeric',
+  minute: 'numeric',
 };
 
 export default new Cron({
   enabled: true,
-  name: "GoG",
+  name: 'GoG',
   description:
-    "Vérifie tous les jours à 17h30 (Paris) si GoG offre un jeu (promotion gratuite) et alerte dans #jeux",
+    'Vérifie tous les jours à 17h30 (Paris) si GoG offre un jeu (promotion gratuite) et alerte dans #jeux',
   schedule: '30 17 * * *',
   // schedule: "* * * * *", // switch for testing
   async handle(context) {
     const game = await getOfferedGame(context.logger);
     if (!game) {
       return;
     }
-    
-    const channel = findTextChannelByName(context.client.channels, "jeux");
-    
+
+    const channel = findTextChannelByName(context.client.channels, 'jeux');
+
     await channel.send(
       new MessageEmbed()
         .setTitle(game.title)
@@ -37,15 +37,15 @@ export default new Cron({
         .setThumbnail(game.thumbnail)
         .setImage(game.banner)
         .addField(
-          "Fin",
-          game.discountEndDate.toLocaleDateString("fr-FR", dateFmtOptions),
-          true
+          'Fin',
+          game.discountEndDate.toLocaleDateString('fr-FR', dateFmtOptions),
+          true,
         )
-        .addField("Prix", `${game.originalPrice}€ → **Gratuit**`)
-        .addField("Note", `⭐ ${game.rating}`)
-        .setTimestamp()
+        .addField('Prix', `${game.originalPrice}€ → **Gratuit**`)
+        .addField('Note', `⭐ ${game.rating}`)
+        .setTimestamp(),
     );
-  }
+  },
 });
 
 /**
@@ -70,39 +70,53 @@ interface Game {
 async function getOfferedGame(logger: Logger): Promise<Game | null> {
   const GOG_GOT_OPTIONS = {
     headers: {
-      "Accept-Language": "fr,fr-FR;q=0.8,fr-FR;q=0.7,en-US;q=0.5,en-US;q=0.3,en;q=0.2"
-    }
+      'Accept-Language':
+        'fr,fr-FR;q=0.8,fr-FR;q=0.7,en-US;q=0.5,en-US;q=0.3,en;q=0.2',
+    },
   };
-  const { body: homeBody } = await got<string>("https://www.gog.com/#giveaway", GOG_GOT_OPTIONS);
-  
+  const { body: homeBody } = await got<string>(
+    'https://www.gog.com/#giveaway',
+    GOG_GOT_OPTIONS,
+  );
+
   if (!homeBody) return null;
   const html = parse(homeBody);
   if (!html) return null;
-  const SEOLink = html.querySelector("a#giveaway");
+  const SEOLink = html.querySelector('a#giveaway');
   if (!SEOLink) return null;
   const endTimestamp = Number(
     html
-      .querySelector(".giveaway-banner__footer gog-countdown-timer")
-      ?.getAttribute("end-date")
+      .querySelector('.giveaway-banner__footer gog-countdown-timer')
+      ?.getAttribute('end-date'),
   );
-  
+
   const { body: gameBody } = await got<string>(
-    `https://www.gog.com${SEOLink.getAttribute("ng-href")}`,
-    GOG_GOT_OPTIONS
+    `https://www.gog.com${SEOLink.getAttribute('ng-href')}`,
+    GOG_GOT_OPTIONS,
   );
   if (!gameBody) return null;
   const gameHTML = parse(gameBody);
   if (!gameHTML) return null;
-  
-  const ldJSONNode = gameHTML.querySelector("script[type=\"application/ld+json\"]");
-  const gameJSON = JSON.parse(ldJSONNode?.innerHTML ?? "");
+
+  const ldJSONNode = gameHTML.querySelector(
+    'script[type="application/ld+json"]',
+  );
+  const gameJSON = JSON.parse(ldJSONNode?.innerHTML ?? '');
   if (!gameJSON) return null;
-  
-  const description = gameHTML.querySelector(".content-summary-item__description")?.innerText ?? "";
-  const banner = gameHTML.querySelector("head meta[property=\"og:image\"]")?.getAttribute("content") ?? "";
-  
-  logger.info({ data: { gameJSON, description, banner } }, "Offered games response");
-  
+
+  const description =
+    gameHTML.querySelector('.content-summary-item__description')?.innerText ??
+    '';
+  const banner =
+    gameHTML
+      .querySelector('head meta[property="og:image"]')
+      ?.getAttribute('content') ?? '';
+
+  logger.info(
+    { data: { gameJSON, description, banner } },
+    'Offered games response',
+  );
+
   return {
     title: gameJSON.name,
     description,