debuggen

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

debugÜbergeben Sie dieser Funktion einfach den Namen Ihres Moduls, und sie gibt eine dekorierte Version von zurück, an die console.errorSie 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 als Ganzes umschalten.

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 Leerzeichen oder durch Kommas getrennten Namen zu aktivieren.

Hier sind einige Beispiele:

Windows-Notizen

Unter Windows wird die Umgebungsvariable mit dem setBefehl gesetzt.

1
set DEBUG=*,-not_this

Beachten Sie, dass PowerShell eine andere 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 Analysieren der Debug-Ausgabe, um zu identifizieren, zu welcher Debug-Instanz eine Debug-Zeile gehört.

Node.js

In Node.js sind Farben aktiviert, wenn stderr ein TTY ist, außerdem sollte man das supports-colorModul neben debug installieren, sonst verwendet debug nur eine Handvoll Grundfarben.

Webbrowser

%cFarben werden auch bei "Web Inspectors" aktiviert, die die Formatierungsoption verstehen , dies sind WebKit Web Inspectors, Firefox ( ab Version 31 ) und das Firebug-Plugin für Firefox (jede Version).

Millisekunde diff

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

Wenn stdout kein TTY ist, Date#toISOString()wird es verwendet, wodurch es für die Protokollierung der Debug-Informationen nützlicher wird, wie unten gezeigt:

Konventionen

Wenn Sie dies in einer oder mehreren Ihrer Bibliotheken verwenden, sollten Sie den Namen Ihrer Bibliothek verwenden, damit Entwickler das Debugging 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. Zum Beispiel wäre "bodyParser" von Connect dann "connect:bodyParser". Wenn Sie ein "*" an das Ende Ihres Namens anhängen, wird es immer aktiviert, unabhängig von der Einstellung des DEBUG Umgebungsvariable, die Sie dann sowohl für die normale Ausgabe als auch für die Debug-Ausgabe verwenden können.

Platzhalter

Das *Zeichen kann als Platzhalter verwendet werden.Angenommen, Ihre Bibliothek hat Debugger namens "connect:bodyParser", "connect:compress", "connect:session", anstatt alle drei mit aufzulisten, können Sie einfach , oder DEBUG=connect:bodyParser,connect:compress,connect:sessionausführen DEBUG=connect:*Alles, was dieses Modul verwendet, verwenden Sie einfach DEBUG=*.

Sie können auch bestimmte Debugger ausschließen, indem Sie ihnen ein "-"-Zeichen voranstellen. Beispielsweise DEBUG=*,-connect:*würden alle Debugger außer denen eingeschlossen, die mit "connect:" beginnen.

Umgebungsvariablen

Beim Durchlaufen 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 aus der Debug-Ausgabe ausblenden (nicht-TTY).
DEBUG_COLORS	Ob Farben in der Debug-Ausgabe verwendet werden sollen oder nicht.
DEBUG_DEPTH	Tiefe der Objektinspektion.
DEBUG_SHOW_HIDDEN	Zeigt verborgene Eigenschaften von geprüften Objekten an.

Hinweis: Die Umgebungsvariablen, die mit beginnen, DEBUG_werden in ein Optionsobjekt konvertiert, das mit %o/ %O-Formattern verwendet wird.Die util.inspect() vollständige Liste finden Sie in der Node.js-Dokumentation.

Formatierer

Debug verwendet die Formatierung im printf-Stil . Nachfolgend sind die offiziell unterstützten Formatierer aufgeführt:

Formatierer	Darstellung
%O	Hübsches Drucken eines Objekts in mehreren Zeilen.
%o	Hübsches Drucken eines Objekts in einer einzigen Zeile.
%s	Schnur.
%d	Zahl (sowohl Integer als auch Float).
%j	JSON. Wird durch die Zeichenfolge „[Circular]“ ersetzt, wenn das Argument Zirkelverweise enthält.
%%	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 mit 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 mit browserify ein browserfähiges Skript erstellen oder einfach den Browserify-as-a-Service- Build verwenden , wenn Sie es nicht selbst erstellen möchten.

Der Aktivierungsstatus von Debug wird derzeit von beibehalten localStorage. Stellen Sie sich die unten gezeigte Situation vor, in der Sie worker:aund haben worker:bund beide debuggen möchten. Sie können dies mit aktivieren localStorage.debug:

1
localStorage.debug = 'worker:*'

Und aktualisieren Sie dann 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);

Ausgabeströme

Standardmäßig debugwird auf 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 enable()Methode aufrufen:

1
2
3
4
5
6
7
8
9
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

Prüfen, ob ein Debug-Target aktiviert ist

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

1
2
3
4
5
const debug = require('debug')('http');

if (debug.enabled) {
  // do stuff...
}

Sie können diese Eigenschaft auch manuell umschalten, um zu erzwingen, dass die Debug-Instanz aktiviert oder deaktiviert wird.

Autoren

• TJ Holowaychuk
• Nathan Rajlich
• Andreas Rhyne

Unterstützer

Unterstützen Sie uns mit einer monatlichen Spende und helfen Sie uns, unsere Aktivitäten fortzusetzen .

Sponsoren

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

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 dazugehörigen Dokumentationsdateien (die „Software“) erhält, kostenlos die Erlaubnis erteilt, mit der Software uneingeschränkt zu handeln, einschließlich, aber nicht beschränkt auf die Rechte zur Nutzung, Vervielfältigung, Änderung und Zusammenführung , Kopien der Software zu veröffentlichen, zu verteilen, unterzulizenzieren und/oder zu verkaufen und Personen, denen die Software zur Verfügung gestellt wird, dies zu gestatten, vorbehaltlich der folgenden Bedingungen:

Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.

DIE SOFTWARE WIRD OHNE MÄNGELGEWÄHR BEREITGESTELLT, OHNE JEGLICHE GEWÄHRLEISTUNG, AUSDRÜCKLICH ODER STILLSCHWEIGEND, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GEWÄHRLEISTUNG DER MARKTFÄHIGKEIT, EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG VON RECHTEN DRITTER, FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER SONSTIGE HAFTUNG, OB IM RAHMEN EINER KLAGE AUS VERTRAG, UNERLAUBTER HANDLUNG ODER ANDERWEITIG, DIE SICH AUS, AUS ODER IM ZUSAMMENHANG MIT DER SOFTWARE ODER DER NUTZUNG ODER ANDEREN HANDLUNGEN MIT DER SOFTWARE ERGEBEN.