Karte Pfade für Knoten-Module, für Unit-Tests

Question

Client-seitiger Stub-I Pfade zu Module mit SystemJS aus, wie diese

var systemJsConfig = { 
    baseURL: "./", 
    defaultJSExtensions: true, 
    map: { 
     'root-components': 'applicationRoot/rootComponents' 
    } 
}; 

und so würde require('root-components/foo'); zu applicationRoot/rootComponents/foo kartieren.

Das Problem ist, wenn ich ein Modul mit require('root-components/foo'); in Mocha ausführen, Knoten hat keine Ahnung, was dieser Pfad bedeutet. Gibt es einen vernünftigen Weg, um diese Pfadzuordnung in Node zu erreichen?

Ist Proxyquire dazu in der Lage? Ich las ihre Dokumente durch, fand aber nichts, was darauf hinwies.

Dies ist nur für Komponententests, so bin ich glücklich mit jeder Lösung mit jeder Art von Party-Dienstprogramm.

Answer 1

gefunden werden Wenn Ihre einzige Anforderung so einfach ist, können Sie eine Dienstprogrammfunktion, die require überschreibt.

Die neue erfordern gilt eine Abbildung auf den Pfad Argument, sucht für ein Modul in dem neuen Pfad, und Sie können für die Module optional Rückfall, die in dem abgebildeten Pfad nicht existieren. Der Code sollte so aussehen:

const oldRequire = require; 
require = (path) => { 
    try { 
     const mapped = oldRequire(path.replace('root-components/foo', 'applicationRoot/rootComponents/foo')); 
     if (!mapped) { 
      throw new Error('module not found in mapped directory'); 
     } 
     console.log('module resolved with mapping', path); 
     return mapped; 
    } catch (e) { 
     console.log('using old require without mapped path', path); 
     return oldRequire(path); 
    } 
}; 

Answer 2

Sie könnten eine Menge verschiedener Möglichkeiten tun Modul Aliasing as described in this gist, aber der einfachere Weg ist nur der Ausgangswurzelpfad zu setzen mit NODE_PATH, und gehen von dort aus:

Hier ist, wie es mit der NODE_PATH Umgebungsvariable sieht :

NODE_PATH=./src node src/server/index.js

dann in all Ihren Dateien, unabhängig davon, wo sie in der Hierarchie sind, wird aus dem ./src Verzeichnis lösen. Dies eliminiert die Notwendigkeit von Aliasnamen, wie Sie es beschreiben, aber mir ist klar, dass in Ihrem Fall viele Dateien verschoben/umbenannt werden müssen.

Beispiel: require('root-components/foo'); =>./src/root-components/foo.js

Answer 3

Option 1 - Ändern NODE_PATH (nicht empfohlen):

Modify NODE_PATH umfassen die Modulpfade in der Schale vor dem Start node.js.

exports NODE_PATH=./path/to/module:$NODE_PATH 

Dies ist keine gute Option, weil es einen Pre-Launch-Schritt erfordert, und - da die NODE_PATH enthält viele Wege - es ist nicht immer klar, wo das Modul aus geladen wird, und es gibt die Möglichkeit, Namenskollisionen .

Option 2 - Schieben Sie das Modul in einen externen Repo

Lassen Sie uns sagen Sie die Komponenten in einem separaten ‚rootcomponents‘ auf GitHub Profil verfügbar Repo bewegen.

Dann können Sie es installieren direkt über:

npm install --save github:arackaf/rootcomponents 

Dann sollten Sie in der Lage sein, das Projekt Quelle zu einem System.js alias abzubilden.

var systemJsConfig = { 
    baseURL: "./", 
    defaultJSExtensions: true, 
    map: { 
     'root-components': 'github:arackaf/rootcomponents' 
    } 
}; 

Von dort sollte es, wie Sie erwartet:

require('root-components/foo'); 

Option 3 - Laden Sie das Modul über relative Pfad:

Die config.map Option ist nur für Aliase externe Abhängigkeiten abzubilden .

Eine einfache Alternative besteht darin, einen relativen Pfad anzugeben. Verwandte Pfade basieren auf der baseURL.

Zum Beispiel, wenn Sie Last sind versuchen:

src/rootComponents/foo.js 

Das wäre erforderlich:

require('./src/rootComponents/foo') 

---

Hinweis: Dies alles setzt voraus, dass die require() Aussagen folgendes System .js Muster/Regeln.

Eine andere mögliche Option ist die Bereitstellung einer System.paths[] Option, die einen Alias ​​für einen lokalen Pfad erstellt. Ich kann nicht überprüfen, wie/ob das funktioniert (dh ich habe es noch nie versucht), aber die Besonderheiten können here