如何让Node.js CLI工具仅在命令行模式下输出日志？

这里有几个比逐个加标记检查更高效的方案：

1. 抽象CLI专属工具层 #

把所有和CLI相关的输出、交互逻辑（比如console.log、chalk、inquirer调用）封装到一个单独的工具模块，在模块内部统一判断环境，决定是否执行对应操作。

示例工具模块cli-handler.js：

// 判断是否处于CLI环境，可通过环境变量或终端特性检测
const isCLI = process.env.RUNNING_IN_CLI === 'true' || process.stdout.isTTY;

// 封装日志输出
exports.log = (...args) => {
  if (isCLI) {
    console.log(...args);
  }
};

// 封装带颜色的日志
exports.coloredLog = (text, color) => {
  if (isCLI) {
    const chalk = require('chalk');
    console.log(chalk[color](text));
  }
};

// 封装inquirer交互（非CLI环境可返回默认值或空）
exports.prompt = async (questions) => {
  if (!isCLI) {
    // Web环境下返回预设默认值，或根据业务逻辑处理
    return questions.reduce((acc, q) => ({ ...acc, [q.name]: q.default }), {});
  }
  const inquirer = require('inquirer');
  return inquirer.prompt(questions);
};

之后把业务代码里所有直接调用console.log、chalk的地方，替换成调用这个模块的方法。只需要做一轮替换，后续维护都在这个工具层处理，不用再改业务逻辑。

2. 环境驱动的工具重写 #

在CLI入口文件中，通过环境变量标记当前运行环境，并重写CLI相关工具的行为；非CLI环境下，这些工具会被静默处理或返回原始内容。

示例CLI入口文件：

// 标记当前为CLI环境
process.env.RUNNING_IN_CLI = 'true';

// 重写console.log，仅CLI环境输出
const originalLog = console.log;
console.log = (...args) => {
  if (process.env.RUNNING_IN_CLI === 'true') {
    originalLog(...args);
  }
};

// 让非CLI环境下chalk直接返回原文本
if (process.env.RUNNING_IN_CLI !== 'true') {
  require.cache[require.resolve('chalk')] = {
    exports: new Proxy({}, {
      get: (_, prop) => (text) => text
    })
  };
}

// 引入并执行业务逻辑
require('./core-business');

这种方式不需要修改业务代码，所有控制逻辑都在入口层处理。但要注意，这种全局重写可能影响第三方依赖的输出，需要根据实际情况调整。

3. 依赖注入模式 #

将CLI相关的工具作为参数传入业务函数，而非在函数内部直接调用。业务函数只关注核心逻辑，输出/交互行为由调用方提供。

示例改造后的业务函数：

// 原业务函数（耦合CLI输出）
// function processData() {
//   console.log('开始处理数据');
//   // ...核心逻辑
//   console.log(chalk.green('数据处理完成'));
// }

// 改造后（依赖注入）
function processData(logger = { log: () => {}, coloredLog: () => {} }) {
  logger.log('开始处理数据');
  // ...核心逻辑
  logger.coloredLog('数据处理完成', 'green');
}

在CLI中调用时传入真实的CLI工具：

const chalk = require('chalk');
processData({
  log: console.log,
  coloredLog: (text, color) => console.log(chalk[color](text))
});

在Vue应用中调用时，传入空实现或自定义的Web端处理逻辑：

// Vue组件中调用，无输出
processData();

// 或传入Web端的日志收集逻辑
processData({
  log: (msg) => {
    // 比如发送到前端日志系统
    console.debug('[Web端]', msg);
  }
});

这种方式解耦了业务逻辑和CLI依赖，同时提升了代码的可测试性，适合长期维护的项目。

内容的提问来源于stack exchange，提问作者hendrikbl