Wykryj, czy wywołanie wymaga lub bezpośrednio z wiersza poleceń

W jaki sposób można wykryć, czy mój plik node.js nazwano stosując SH: node path-to-fileczy JS: require('path-to-file')?

To jest odpowiednik Node.JS do mojego poprzedniego pytania w Perlu: Jak mogę uruchomić skrypt Perla tylko wtedy, gdy nie został załadowany wymaganiem?

if (require.main === module) {
    console.log('called directly');
} else {
    console.log('required as a module');
}

Zobacz dokumentację tego tutaj: https://nodejs.org/docs/latest/api/modules.html#modules_accessing_the_main_module

Istnieje inna, nieco krótsza droga (nie wymieniona we wspomnianych dokumentach).

var runningAsScript = !module.parent;

W tym wpisie na blogu przedstawiłem więcej szczegółów na temat tego, jak to wszystko działa pod maską .

Byłem trochę zdezorientowany terminologią użytą w wyjaśnieniach. Musiałem więc zrobić kilka szybkich testów.

Odkryłem, że dają one takie same wyniki:

var isCLI = !module.parent;
var isCLI = require.main === module;

A dla innych zdezorientowanych ludzi (i bezpośredniej odpowiedzi na pytanie):

var isCLI = require.main === module;
var wasRequired = !isCLI;

Tak jak w Pythonie, zawsze próbuję sobie przypomnieć, jak napisać ten cholerny fragment kodu. Postanowiłem więc stworzyć dla niego prosty moduł. Zajęło mi to trochę czasu, ponieważ dostęp do informacji o module dzwoniącym nie jest łatwy, ale fajnie było zobaczyć, jak można to zrobić.

Pomysł polega więc na wywołaniu modułu i zapytaniu go, czy moduł wywołujący jest główny. Musimy ustalić moduł funkcji dzwoniącego. Moje pierwsze podejście było odmianą przyjętej odpowiedzi:

module.exports = function () {
    return require.main === module.parent;
};

Ale to nie gwarantuje, że zadziała. module.parentwskazuje moduł, który załadował nas do pamięci, a nie ten, który nas woła. Jeśli to moduł wywołujący załadował ten moduł pomocnika do pamięci, nie ma sprawy. Ale jeśli nie, jesteśmy bezradni. Musimy więc spróbować czegoś innego. Moim rozwiązaniem było wygenerowanie śladu stosu i pobranie stąd nazwy modułu dzwoniącego:

module.exports = function () {
    // generate a stack trace
    const stack = (new Error()).stack;
    // the third line refers to our caller
    const stackLine = stack.split("\n")[2];
    // extract the module name from that line
    const callerModuleName = /\((.*):\d+:\d+\)$/.exec(stackLine)[1];

    return require.main.filename === callerModuleName;
};

Teraz możemy zrobić:

if (require("./is-main-module")()) {  // notice the `()` at the end
    // do something
} else {
    // do something else
}

Lub bardziej czytelny:

const isMainModule = require("./is-main-module");

if (isMainModule()) {
    // do something
} else {
    // do something else
}

Niemożliwe do zapomnienia :-)

Wypróbuj to, jeśli używasz modułów ES6:

if (process.mainModule.filename === __filename) {
  console.log('running as main module')
}