Node.JS: Rileva se richiesto tramite richiesta o direttamente dalla riga di comando

Question

Come posso rilevare se il mio file Node.JS è stato chiamato utilizzando SH: node path-to-file o JS: require('path-to-file')?

questo è il Node.JS equivalenti alla mia precedente interrogazione in Perl: How can I run my Perl script only if it wasn't loaded with require?

Answer 1

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

vedere la documentazione per questo qui: https://nodejs.org/docs/latest/api/all.html#modules_accessing_the_main_module

Answer 2

C'è un altro modo leggermente più corto (non indicato nel citato docs).

var runningAsScript = !module.parent;

ho delineato ulteriori dettagli su come questo tutte le opere sotto il cofano in this blog post.

Answer 3

Ero un po 'confuso dalla terminologia utilizzata nella spiegazione (s). Quindi ho dovuto fare un paio di test rapidi.

ho scoperto che questi producono gli stessi risultati:

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

E per le altre persone confuse (e per rispondere alla domanda direttamente):

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

Answer 4

Proprio come in Python, ho sempre trovato sto cercando di ricordare come scrivere questo dannato frammento di codice. Così ho deciso di creare un modulo semplice per questo. Mi ci è voluto un po 'di tempo per sviluppare l'accesso alle informazioni sul modulo del chiamante, ma è stato divertente vedere come sarebbe stato possibile.

Quindi l'idea è di chiamare un modulo e chiedere se il modulo chiamante è quello principale. Dobbiamo capire il modulo della funzione chiamante. Il mio primo approccio era una variazione della risposta accettata:

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

Ma non è garantito che funzioni. module.parent punti al modulo che ha caricato in memoria, non quello che ci chiama. Se era il modulo chiamante che ha caricato questo modulo helper in memoria, va bene. Ma se non lo fosse, siamo indifesi. Quindi dobbiamo provare qualcos'altro. La mia soluzione era di generare una traccia dello stack e ottenere il nome del modulo del chiamante da lì:

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; 
}; 

Ora possiamo fare:

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

O più leggibile:

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

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

impossibile da dimenticare :-)