获取 GAS 项目中的函数列表

Question

我想看看是否有办法获取我在 Google Apps 脚本项目中拥有的所有功能的列表。我已经看到多个线程获取所有 Google Apps 脚本项目的列表，但 none 尚未列出每个项目中的所有函数。有谁知道这是否可能？我浏览了 Google Apps 脚本参考概述，但没有找到任何对我来说很突出的内容（当然，我可能会错过）。如果有人有任何建议，请告诉我！

我能提供的最好的例子是：

我有一个 Google Spreadsheet 文件。附加到 Google Spreadsheet 的是一个 GAS 项目（通过 Google Sheet 菜单 "Tools -> Script Editor" 访问），它有几个不同的函数用于获取值来自 sheet，做一些计算，post 结果到另一个 sheet。

我想要完成的任务：运行某种函数可以为我提供 GAS 项目中所有函数的列表（最好是字符串值）。例如：

["runMyCalculations","myOnEdit","sortClosedFiles","formatSheets"]

如果我打开脚本编辑器并在下拉菜单中 select 并单击 "Run" 按钮，所有这些都是只能运行的功能。

我想做的是创建一个包含我所有功能的动态列表，这样我就可以将它们传递到一个 "on open" 触发函数中，该函数在 sheet 中创建一个自定义菜单，列出我拥有的所有功能。我想要这个，这样我就可以简单地更改我的 sheet，转到下拉菜单和运行我需要运行的功能，而不必打开脚本编辑器.

Answer 1

您可以使用 Apps 脚本 API 从 Apps 脚本文件中获取所有内容。下面的代码有传入文件名获取的选项。您必须提供 Apps 脚本文件 ID。传入 gs 文件名是可选的。提供了3个功能。完成所有工作的函数，一个使用测试参数调用该函数的函数，以及一个日志记录函数。不需要 OAuth 库，因为令牌是从 ScriptApp 服务获取的。

注意：您需要启用 Apps 脚本 API，并批准对您的云端硬盘的权限才能使此代码生效。确保在您第一次运行此代码时检查 UrlFetchApp.fetch() 调用中的 return 以获取错误消息。它可能有一个 link，您需要使用它来启用 Apps 脚本 API。

function getFuncNames(po) {
  var allFiles,dataContentAsString,downloadUrl,fileContents,fileData,i,options,
      theAccessTkn,thisFileName;
  var ndxOfFunction=0,counter=0, ndxOfEnd=0, functionName="", allFncNames=[],
      hasSpaces = 0;
  var innerObj, thisFile, fileType = "", thisGS_Content,howManyFiles, allGsContent="";

  /*
    Get all script function names.  If no gs file name is provided, the code
    gets all the function names.
  */

  /*
    po.fileID - required - The Apps Script file ID
    po.gsFileName - optional - the gs code file name to get - gets just one 
       file instead of all files
  */

  //ll('po',po);

  if (!po.fileID) {
    return false;
  }

  theAccessTkn = ScriptApp.getOAuthToken();//Get an access token for OAuth

  downloadUrl = "https://script.google.com/feeds/download/export?id=" +
      po.fileID + "&format=json";//create url

  options = {
    "kind": "drive#file",
    "id": po.fileID,
    "downloadUrl": downloadUrl,
    "headers": {
       'Authorization': 'Bearer ' +  theAccessTkn,
     },
    "contentType": "application/vnd.google-apps.script+json",
    "method" : "GET"
  };

  fileData = UrlFetchApp.fetch(downloadUrl, options);//Get all the content from the Apps Script file
  //ll('fileData',fileData)

  dataContentAsString = fileData.getContentText();

  fileContents = JSON.parse(dataContentAsString);//Parse string into object

  allFiles = fileContents.files;//All the files in the Apps Script project

  howManyFiles = allFiles.length;

  for (i=0;i<howManyFiles;i++) {
    thisFile = allFiles[i];//Get one inner element that represents one file
    if (!thisFile) {continue;}

    fileType = thisFile.type;
    if (fileType !== "server_js") {continue;}//This is not a gs file - its HTML or json

    thisFileName = thisFile.name;
    //ll('typeof thisFileName',typeof thisFileName)
    //ll('thisFileName',thisFileName)
    //ll('equal',po.gsFileName !== thisFile.name)

    if (po.gsFileName) {//Is there a setting for the file name to restrict the search to
      if (po.gsFileName !== thisFile.name) {//The name to search for is not this file name
        continue;
      }
    }

    thisGS_Content = thisFile.source;//source is the key name for the file content
    allGsContent = allGsContent + thisGS_Content;
  }

  //ll('allGsContent',allGsContent)

  while (ndxOfFunction !== -1 || counter < 1000) {
    ndxOfFunction = allGsContent.indexOf("function ");

    //ll('ndxOfFunction',ndxOfFunction)
    if (ndxOfFunction === -1) {break};

    allGsContent = allGsContent.slice(ndxOfFunction+9);//Remove everything in front of 'function' first

    ndxOfEnd = allGsContent.indexOf("(");
    functionName = allGsContent.slice(0,ndxOfEnd);
    allGsContent = allGsContent.slice(ndxOfEnd+2);//Remove the     
    hasSpaces = functionName.indexOf(" ");

    if (hasSpaces !== -1) {continue;}

    if (functionName.length < 150) {
      allFncNames.push(functionName);
    }//Any string over 150 long is probably not a function name

    counter ++;
  };

  //ll('allFncNames',allFncNames)
  return allFncNames;
};

function runOtherFnk() {
  getFuncNames({fileID:"Your File ID here",gsFileName:"Code"});
}

function ll(a,b) {
  //Logger.log(typeof a)

  if (typeof b === 'object') {
    b = JSON.stringify(b);
  }

  Logger.log(a + ":" + b)
}

以下代码从 this 对象中提取文件名：

function getAllFnks() {
  var allFnks,fnkStr,k;

  allFnks = [];

  for (k in this) {
    //Logger.log(k)
    //Logger.log(typeof k)
    //Logger.log(this[k])
    //Logger.log(typeof this[k])

    fnkStr = this[k];

    if (fnkStr) {
      fnkStr = fnkStr.toString();
      //Logger.log(typeof fnkStr)
    } else {
      continue;
    }

    //Logger.log(fnkStr.toString().indexOf('function'))
    if (fnkStr.indexOf('function') === 1) {
      allFnks.push(k);
    }
  }

  Logger.log(allFnks)
  Logger.log('Number of functions: ' + allFnks.length)
}

获取 GAS 项目中的函数列表

Getting a list of functions within your GAS project

google-apps-script

google-apps-script-editor