Contenu
  1. 1. Sélection du dom
  2. 2. Formater du texte
    1. 2.1. Utilisation des backquotes
    2. 2.2. Utilisation des paramètres de logs pour créer des chaines
    3. 2.3. Utilisation de caractères spéciaux pour optimiser l’affichage
  3. 3. Mesurer les performances
    1. 3.1. Mesure d’un temps
    2. 3.2. Déclanchement du profiler
    3. 3.3. Mise en place d’un marqueur dans la timeline
  4. 4. Un autre affichage est possible
    1. 4.1. console.table
    2. 4.2. console.group
    3. 4.3. Ajouter les timestamps
  5. 5. Contextualiser ses logs

Dans cet article je vais me concentrer sur la console afin de vous partager quelques tips & tricks disponibles dans la console des devtools.

Sélection du dom

Plusieurs “raccourcis” existent afin d’interagir avec la fenêtre d’inspection d’élément

> $0 //permet de récupérer l'élément courant sélectionné
> $1 // récupère le précédent élément sélectionné
> $N // etc
> $('section') // équivalent à document.querySelector('section')
> $$('section') // équivalent à document.querySelectorAll('section')
> $$('html/body') // retourne un array des éléments matchant le XPath en paramètre
> inspect(element) // Inspecte directement l'élément dans la page


Voici un exemple d’utilisation des méthodes.



Formater du texte

Afin d’afficher des données dynamiques (objets, temps, valeurs, …) dans la console, nous avons plusieurs possibilités :

Utilisation des backquotes

Introduites avec ES6, les backquotes sont la solution simple et compatible avec vos projets.

const uneChaine = 'du texte';
console.log(`On peut simplement utiliser les backquotes pour afficher ${uneChaine}`);
// Affichera 'On peut simplement utiliser les backquotes pour afficher du texte'

Utilisation des paramètres de logs pour créer des chaines

La méthode log prend un nombre infini de paramètres permettant de construire une chaine de caractère. Si l’on ne précise pas de caractères spéciaux, la console va se charger de concaténer les éléments les uns après les autres. Ce qui est intéressant avec cette méthode c’est que des objets complexes apparaîtront directement dans le résultat de la console et seront mis en avant.



Utilisation de caractères spéciaux pour optimiser l’affichage

Si on veut avoir une intégration plus fine avec une chaine de caractère préconstruit, on pourra utiliser les paramètres suivants :

  • %s : Format une chaine de caractères.
  • %i ou %d : Format un entier.
  • %f : Format un nombre flottant.
  • %o : Format un élement du DOM (qui pourra s’ouvrir).
  • %O : Format un objet javascript.
  • %c : Appliquera le style css à la chaine en fonction des propriétés css passées dans le second paramètre.

Ainsi on peut faire des choses comme ça :



Mesurer les performances

Mesure d’un temps

La console peut nous aider à mesurer les performances de nos pages à travers des simples instructions.

console.time('myTimer'); // Initialise un timer pour le label 'myTimer'
doSomeStuff();
console.timeEnd('myTimer'); // Termine le timer et affiche le temps passé en millisecondes
// affiche : myTimer : 1125.5554645ms

Si aucun paramètre n’est passé, alors le nom du label est ‘default’.

Déclanchement du profiler

On peut aussi déclencher le profiler javascript sur des méthodes précises avec le même fonctionnement :

console.profile('myProfiler'); // démarre le profiling du code avec le label 'myProfiler'
longMethodToProfile();
console.profileEnd('myProfiler'); // stop le profiling

On retrouve ensuite le profiler dans l’onglet Profile.



Mise en place d’un marqueur dans la timeline

Dernier log utile, l’utilisation du mot-clé timestamp qui permet d’afficher un repère dans la timeline javascript. On peut ainsi se repérer dans la timeline grâce à ça :

console.timeStamp('Adding result');


Un autre affichage est possible

Si tout le monde connaît les niveaux de logs classiques : info, debug, warn, error, log. Peu de gens savent que les devtools proposent des affichages différents afin de faciliter la lecture. En voici quelques-uns :

console.table

Cette méthode permet d’afficher de façon lisible les arrays dans la console. On pourra ainsi visualiser simplement un tableau d’objets.

console.table([{a:1, b:2, c:3}, {a:"foo", b:false, c:undefined}]);
console.table([[1,2,3], [2,3,4]]);

Donne le résultat suivant :



On peut même aller plus loin dans ce type de logs avec les classes :

function Person(firstName, lastName, age) {
this.firstName = firstName;
this.lastName = lastName;
this.age = age;
}
var family = {};
family.mother = new Person("Susan", "Doyle", 32);
family.father = new Person("John", "Doyle", 33);
family.daughter = new Person("Lily", "Doyle", 5);
family.son = new Person("Mike", "Doyle", 8);
console.table(family, ["firstName", "lastName", "age"]);

Donne la sortie suivante :



console.group

Cette méthode permet de regrouper visuellement des logs afin de “contextualiser” ses logs et améliorer leur lisibilité

console.group('Un label de niveau haut pour identifier le groupe');
console.log('un log dans le groupe');
console.info('un deuxième log');
console.groupEnd() // On termine le bloc

Donne le résultat suivant :



Ajouter les timestamps

De la même façon, il existe dans les paramètres des devtools la possibilité d’afficher par défaut le timestamp du log.



Cela aura pour effet d’enlever le “log stacking” !



Contextualiser ses logs

Il est possible depuis un moment d’utiliser des contextes pour logguer ses messages dans des contextes spécifiques (Service worker, iframe, …). Mais depuis la version 62 de Chrome, l’affichage du contexte est grandement simplifié. Ainsi le code suivant pour bénéficier d’un affichage dépendant du contexte de log !

(() => {
let logContext = console.context('addContext');
let perfContext = console.context('perfContext');
perfContext.info('Start to measure');
perfContext.time('Measure');
for (let count = 0; count < 100; count++){
logContext.info('Will log the first count %d',count);
}
perfContext.timeEnd('Measure');
perfContext.info('End of measure!');
})();


Si vous voulez aller encore plus loin dans votre utilisation de la console, je vous conseille d’aller lire la documentation officielle disponible ici : https://developers.google.com/web/tools/chrome-devtools/console/

Contenu
  1. 1. Sélection du dom
  2. 2. Formater du texte
    1. 2.1. Utilisation des backquotes
    2. 2.2. Utilisation des paramètres de logs pour créer des chaines
    3. 2.3. Utilisation de caractères spéciaux pour optimiser l’affichage
  3. 3. Mesurer les performances
    1. 3.1. Mesure d’un temps
    2. 3.2. Déclanchement du profiler
    3. 3.3. Mise en place d’un marqueur dans la timeline
  4. 4. Un autre affichage est possible
    1. 4.1. console.table
    2. 4.2. console.group
    3. 4.3. Ajouter les timestamps
  5. 5. Contextualiser ses logs