Fantastisches Community-Modul

debuggen

Build-Status Abdeckungsstatus Locker OpenCollective OpenCollective

Ein winziges JavaScript-Debugging-Dienstprogramm, das der Debugging-Technik des Node.js-Kerns nachempfunden ist. Funktioniert in Node.js und Webbrowsern.

Installation

1
$ npm install debug

Verwendung

debugmacht eine Funktion verfügbar, übergeben console.errorSie dieser Funktion einfach den Namen Ihres Moduls und es wird eine dekorierte Version von zurückgegeben, an die Sie Debug-Anweisungen übergeben können. Auf diese Weise können Sie die Debug-Ausgabe für verschiedene Teile Ihres Moduls sowie für das Modul umschalten als Ganzes.

Beispiel app.js :

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
var debug = require('debug')('http') , http = require('http') , name = 'My App'; // fake app debug('booting %o', name); http.createServer(function(req, res){ debug(req.method + ' ' + req.url); res.end('hello\n'); }).listen(3000, function(){ debug('listening'); }); // fake worker of some kind require('./worker');

Beispiel worker.js :

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
var a = require('debug')('worker:a') , b = require('debug')('worker:b'); function work() { a('doing lots of uninteresting work'); setTimeout(work, Math.random() * 1000); } work(); function workb() { b('doing some work'); setTimeout(workb, Math.random() * 2000); } workb();

Die DEBUGUmgebungsvariable wird dann verwendet, um diese basierend auf durch Leerzeichen oder Kommas getrennten Namen zu aktivieren.

Hier sind einige Beispiele:

Screenshot 08.08.2017 um 12 53 04 Uhr Screenshot 08.08.2017 um 12 53 38 Uhr Screenshot 08.08.2017 um 12 53 25 Uhr

Windows Hinweis

Unter Windows wird die Umgebungsvariable mit dem setBefehl festgelegt.

1
set DEBUG=*,-not_this

Beachten Sie, dass PowerShell unterschiedliche Syntax zum Festlegen von Umgebungsvariablen verwendet.

1
$env:DEBUG = "*,-not_this"

Führen Sie dann das zu debuggende Programm wie gewohnt aus.

Namespace-Farben

Für jede Debug-Instanz wird basierend auf ihrem Namespace-Namen eine Farbe generiert. Dies hilft beim visuellen Parsen der Debug-Ausgabe, um festzustellen, zu welcher Debug-Instanz eine Debug-Zeile gehört.

Node.js

In Node.js sind Farben aktiviert, wenn stderr ein TTY ist. Sie sollten das supports-colorModul auch neben dem Debug installieren , da sonst beim Debuggen nur eine kleine Handvoll Grundfarben verwendet werden.

Webbrowser

Farben sind auch in "Web Inspectors" aktiviert, die die %cFormatierungsoption verstehen . Dies sind WebKit Web Inspectors, Firefox ( seit Version 31 ) und das Firebug-Plugin für Firefox (jede Version).

Millisekunden Diff

Wenn Sie eine Anwendung aktiv entwickeln, kann es hilfreich sein zu sehen, wann die Zeit zwischen einem debug()Anruf und dem nächsten verbracht wurde. Angenommen, Sie rufen beispielsweise debug()vor dem Anfordern einer Ressource auf, und danach zeigt Ihnen "+ NNNms" an, wie viel Zeit aufgewendet wurde zwischen Anrufen.

Wenn stdout kein TTY ist, Date#toISOString()wird es verwendet, um die Debug-Informationen wie folgt zu protokollieren:

Konventionen

Wenn Sie dies in einer oder mehreren Ihrer Bibliotheken verwenden, sollten Sie den Namen Ihrer Bibliothek verwenden, damit Entwickler das Debuggen wie gewünscht umschalten können, ohne Namen zu erraten. Wenn Sie mehr als einen Debugger haben, sollten Sie ihnen Ihren Bibliotheksnamen und voranstellen Verwenden Sie ":", um Funktionen zu trennen. Beispiel: "bodyParser" von "Connect" lautet dann "connect: bodyParser". Wenn Sie am Ende Ihres Namens ein "*" anhängen, wird es unabhängig von der Einstellung des DEBUG immer aktiviert Umgebungsvariable. Sie können sie dann sowohl für die normale Ausgabe als auch für die Debug-Ausgabe verwenden.

Platzhalter

Das *Zeichen kann als Platzhalter verwendet werden. Angenommen, Ihre Bibliothek verfügt beispielsweise über Debugger mit den Namen "connect: bodyParser", "connect: compress", "connect: session", anstatt alle drei mit aufzulisten DEBUG=connect:bodyParser,connect:compress,connect:session, können Sie dies einfach tun DEBUG=connect:*oder ausführen Alles, was dieses Modul benutzt, einfach benutzen DEBUG=*.

Sie können bestimmte Debugger auch ausschließen, indem Sie ihnen ein "-" voranstellen. Sie würden beispielsweise DEBUG=*,-connect:*alle Debugger mit Ausnahme derjenigen einschließen, die mit "connect:" beginnen.

Umgebungsvariablen

Beim Ausführen von Node.js können Sie einige Umgebungsvariablen festlegen, die das Verhalten der Debug-Protokollierung ändern:

Name Zweck
DEBUG Aktiviert / deaktiviert bestimmte Debugging-Namespaces.
DEBUG_HIDE_DATE Datum vor Debug-Ausgabe ausblenden (nicht TTY).
DEBUG_COLORS Gibt an, ob Farben in der Debug-Ausgabe verwendet werden sollen.
DEBUG_DEPTH Objektinspektionstiefe.
DEBUG_SHOW_HIDDEN Zeigt versteckte Eigenschaften für inspizierte Objekte an.

Hinweis: Die Umgebungsvariablen, die mit dem DEBUG_Ende beginnen, werden in ein Options-Objekt konvertiert, das mit %o/ %Oformatters verwendet wird. util.inspect() Die vollständige Liste finden Sie in der Node.js-Dokumentation .

Formatierer

Das Debuggen verwendet die Formatierung im Printf-Stil . Nachfolgend sind die offiziell unterstützten Formatierer aufgeführt:

Formatierer Darstellung
%O Drucken Sie ein Objekt in mehreren Zeilen.
%o Drucken Sie ein Objekt in einer einzigen Zeile.
%s String.
%d Zahl (sowohl Ganzzahl als auch Gleitkommawert).
%j JSON. Wird durch die Zeichenfolge '[Circular]' ersetzt, wenn das Argument Zirkelverweise enthält.
%% Ein einzelnes Prozentzeichen ('%'). Dies verbraucht kein Argument.

Custom formatters

Sie können benutzerdefinierte Formatierer hinzufügen, indem Sie das debug.formattersObjekt erweitern. Wenn Sie beispielsweise Unterstützung für das Rendern eines Puffers als Hex hinzufügen möchten %h, können Sie Folgendes tun:

1 2 3 4 5 6 7 8 9
const createDebug = require('debug') createDebug.formatters.h = (v) => { return v.toString('hex') } // …elsewhere const debug = createDebug('foo') debug('this is hex: %h', new Buffer('hello world')) // foo this is hex: 68656c6c6f20776f726c6421 +0ms

Browser-Unterstützung

Sie können ein browserfähiges Skript mit browserify erstellen oder einfach den browserify-as-a-Service- Build verwenden , wenn Sie es nicht selbst erstellen möchten.

Der Aktivierungsstatus des Debugs wird derzeit beibehalten localStorage. Betrachten Sie die unten gezeigte Situation, in der Sie worker:aund haben worker:b, und möchten Sie beide debuggen. Sie können dies aktivieren, indem Sie localStorage.debug:

1
localStorage.debug = 'worker:*'

Und dann aktualisieren Sie die Seite.

1 2 3 4 5 6 7 8 9 10
a = debug('worker:a'); b = debug('worker:b'); setInterval(function(){ a('doing some work'); }, 1000); setInterval(function(){ b('doing some work'); }, 1200);

Ausgabestreams

Standardmäßig debugwird bei stderr protokolliert. Dies kann jedoch pro Namespace konfiguriert werden, indem die logMethode überschrieben wird:

Beispiel stdout.js :

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
var debug = require('debug'); var error = debug('app:error'); // by default stderr is used error('goes to stderr!'); var log = debug('app:log'); // set this namespace to log via console.log log.log = console.log.bind(console); // don't forget to bind to console! log('goes to stdout'); error('still goes to stderr!'); // set all output to go via console.info // overrides all per-namespace log settings debug.log = console.info.bind(console); error('now goes to stdout via console.info'); log('still goes to stdout, but via console.info now');

Dynamisch einstellen

Sie können das Debuggen auch dynamisch aktivieren, indem Sie die folgende enable()Methode aufrufen :

1 2 3 4 5 6 7 8 9 10
let debug = require('debug'); console.log(1, debug.enabled('test')); debug.enable('test'); console.log(2, debug.enabled('test')); debug.disable(); console.log(3, debug.enabled('test'));

drucken:

1 2 3
1 false 2 true 3 false

Verwendung:
enable(namespaces)
namespacesKann Modi enthalten, die durch einen Doppelpunkt und Platzhalter getrennt sind.

Beachten Sie, dass der Aufruf enable()die zuvor festgelegte DEBUG-Variable vollständig überschreibt:

1 2
$ DEBUG=foo node -e 'var dbg = require("debug"); dbg.enable("bar"); console.log(dbg.enabled("foo"))' => false

Überprüfen, ob ein Debug-Ziel aktiviert ist

Nachdem Sie eine Debug-Instanz erstellt haben, können Sie durch Überprüfen der enabledEigenschaft feststellen, ob sie aktiviert ist oder nicht :

1 2 3 4 5
const debug = require('debug')('http'); if (debug.enabled) { // do stuff... }

Sie können diese Eigenschaft auch manuell umschalten, um das Aktivieren oder Deaktivieren der Debug-Instanz zu erzwingen.

Autoren

  • TJ Holowaychuk
  • Nathan Rajlich
  • Andrew Rhyne

Unterstützer

Unterstützen Sie uns mit einer monatlichen Spende und helfen Sie uns, unsere Aktivitäten fortzusetzen. [ Werden Sie ein Unterstützer ]

Sponsoren

Werden Sie Sponsor und erhalten Sie Ihr Logo in unserer README-Datei auf Github mit einem Link zu Ihrer Website. [ Werden Sie Sponsor ]

Lizenz

(Die MIT-Lizenz)

Copyright (c) 2014-2017 TJ Holowaychuk < tj@vision-media.ca >

Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erhält, kostenlos die Erlaubnis erteilt, uneingeschränkt mit der Software umzugehen, einschließlich, jedoch nicht beschränkt auf die Rechte zur Nutzung, zum Kopieren, Ändern, Zusammenführen , veröffentlichen, vertreiben, unterlizenzieren und / oder verkaufen Kopien der Software und erlauben Personen, denen die Software zur Verfügung gestellt wird, dies unter den folgenden Bedingungen:

Der oben genannte Copyright-Hinweis und dieser Genehmigungshinweis sind in allen Kopien oder wesentlichen Teilen der Software enthalten.

DIE SOFTWARE WIRD OHNE JEGLICHE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG ZUR VERFÜGUNG GESTELLT. SCHÄDEN ODER ANDERE HAFTUNG, OB BEI VERTRAGS-, TORT- ODER ANDERWEITIGEN MASSNAHMEN, DIE AUS, AUS ODER IM ZUSAMMENHANG MIT DER SOFTWARE ODER DER NUTZUNG ODER ANDEREN HANDELN IN DER SOFTWARE ENTSTEHEN.