`if __name__ == '__main__'` 在 javascript es6 模块中等效

是否可以检查 JavaScript 文件是否直接运行，或者是否需要作为 es6 模块导入的一部分。

例如，包含一个主脚本。

// main.js
import './other';

if (mainTest){
  console.log('This should run');
}

它导入一个依赖项。

// other.js
if (mainTest){
  console.log('This should never run');
}

包括<script src=main.js></script>应该会导致控制台消息main.js但不是 other.js。

我找到了回答这个关于节点的问题 https://stackoverflow.com/questions/4981891/node-js-equivalent-of-pythons-if-name-main，但我对 es6 导入特别感兴趣

ES6 模块的替代方案是现在支持 https://nodejs.org/docs/latest-v12.x/api/esm.html#esm_import_meta在节点中。使用新的import.meta内置。 （别忘了设置"type": "module" https://nodejs.org/api/packages.html#packagejson-and-file-extensions in package.json.)

Example

// main.js
import "./lib.js"
import { fileURLToPath } from "url";

if (process.argv[1] === fileURLToPath(import.meta.url)) {
  console.log("I print to stdout!");
}

// lib.js
import { fileURLToPath } from "url";

if (process.argv[1] === fileURLToPath(import.meta.url)) {
  console.log("I don't run, because I'm an imported module.");
}

$ node main.js output:

I print to stdout!

实用功能

我喜欢只是import { isMain } from "./lib/utils.js"并通过import.meta.url to isMain().

import { argv } from "process"
import { fileURLToPath } from "url"
/**
 * Check if a module is the main module launched with the node process.
 * Meaning the module is NOT imported by another module,
 * but was directly invoked by `node`, like this: `$ node main.js`
 *
 * @example
 * ```js
 * // main.js
 * import lib from "./lib.js"
 * import { isMain } from "./utils.js"
 *
 * if (isMain(import.meta.url)) {
 *   console.log("I print to stdout")
 * }
 *
 * // lib.js
 * import { isMain } from "./utils"
 *
 * if (isMain(import.meta.url)) {
 *   console.log("I don't run, because I'm an imported module")
 * }
 * ```
 *
 * @param {string} moduleUrl needs to be `import.meta.url`
 * @returns {boolean} true if the module is the main module
 */
export function isMain(moduleUrl) {
  const modulePath = fileURLToPath(moduleUrl)
  const [_binPath, mainScriptPath] = argv
  return modulePath === mainScriptPath
}