hmlib Scribe

Bibliothèque de code permettant de rapporter des bogues à un service tiers.

NODE_ENV

Si NODE_ENV = production, le module utilise le service tiers pour rapporter les bogues.

Autrement, le module imprime les erreurs sur stderr.

npm

Pour installer dans votre projet,

npm install gitlab:hydro-meteo/hmlib-scribe

Pour que le code du module présent se mette à jour dans les projets l'ayant importé, il faut:

1. Incrémenter le numéro de version dans ce projet dans package.json
2. git add, git commit, git push dans ce projet
3. npm update hmlib-scribe dans le projet importateur

API

Le module doit être initialisé avec la clé API du projet en question (obligatoire) et avec la liste des onglets personnalisés (facultatif);

const scribe = require("hmlib-scribe")({
  apiKey: "BUGSNAG API KEY HERE",
  customTabs: ["ste-cath", "vortex"],
});

const e = new Error(
  "Here's an error message to be sent to Bugsnag or viewed in the console, dictated by NODE_ENV"
);
e["ste-cath"] = {
  msg: "The date format was wrong again",
  actual: "07/19/23 3:40 PM",
  expected: "2023-07-19T15:40:00-04:00",
};
scribe.error(e);