部署Firebase Cloud Functions时遇require-jsdoc缺失JSDoc注释lint错误求助

你遇到的是ESLint的require-jsdoc规则报错，该规则要求所有函数必须添加JSDoc注释。以下是三种可行的解决方案：

1. 给函数添加符合要求的JSDoc注释（推荐） #

这是最规范的处理方式，既能通过lint检查，还能提升代码的可读性和维护性。修改后的代码示例：

const functions = require("firebase-functions");
const admin = require("firebase-admin");
admin.initializeApp();

/**
 * 监听/products节点的新增数据，触发新产品通知推送
 * @param {Object} event - Firebase数据库触发器的事件对象
 * @returns {Promise} 返回数据库更新操作的Promise实例
 */
exports.announceProduct = functions.database
    .ref("/products/{productID}")
    .onCreate((event) => {
      const product = event.val();
      sendNotification(product);
      return event.ref.set(product);
    });

/**
 * 向newProducts主题发送新产品上线通知
 * @param {Object} product - 新产品数据，需包含title和cost字段
 */
function sendNotification(product) {
  const title = product.title;
  const cost = product.cost;

  const payload = {
    notification: {
      title: "New Product Available",
      body: `${title} for £ ${cost}`,
      sound: "default",
    },
  };

  console.log(payload);

  const topic = "newProducts";
  admin.messaging().sendToTopic(topic, payload);
}

2. 修改ESLint配置，禁用或调整规则 #

如果项目不需要强制添加JSDoc，可以修改根目录下的ESLint配置文件（如.eslintrc.json、.eslintrc.js或package.json中的eslint字段）：

完全禁用规则 #

在配置的rules中添加：

{
  "rules": {
    "require-jsdoc": "off"
  }
}

调整规则要求（仅针对特定函数类型） #

若只想对部分函数类型要求JSDoc，比如忽略箭头函数：

{
  "rules": {
    "require-jsdoc": [
      "error",
      {
        "require": {
          "FunctionDeclaration": true,
          "MethodDefinition": true,
          "ClassDeclaration": true,
          "ArrowFunctionExpression": false
        }
      }
    ]
  }
}

3. 部署时跳过ESLint检查（临时方案） #

如果只是想快速完成部署，不想修改代码或配置，可以在部署命令中添加--no-lint参数跳过lint检查：

firebase deploy --only functions --no-lint

注意：不推荐长期使用该方法，ESLint检查是为了保障代码质量，跳过可能会遗漏其他潜在问题。

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