Google Apps Script 开发环境搭建教程

项目目录结构及介绍

apps-script-starter/
├── .clasp.json
├── .claspignore
├── .gitignore
├── .vscode/
│   └── settings.json
├── appsscript.json
├── dist/
│   └── Code.js
├── src/
│   ├── Code.js
│   ├── index.js
│   └── ...
├── package.json
└── README.md

• .clasp.json: 用于配置 Google Apps Script 项目的远程路径和 ID。
• .claspignore: 指定不需要上传到 Google Apps Script 的文件和目录。
• .gitignore: 指定不需要被 Git 追踪的文件和目录。
• .vscode/settings.json: 配置 Visual Studio Code 的开发环境设置。
• appsscript.json: Google Apps Script 的项目配置文件。
• dist/: 打包后的代码存放目录。
• src/: 源代码存放目录。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目说明文档。

项目启动文件介绍

项目的启动文件位于 src/Code.js，这是 Google Apps Script 项目的入口文件。通常包含项目的初始化代码和主要功能函数。

// src/Code.js
function myFunction() {
  Logger.log('Hello, World!');
}

项目配置文件介绍

appsscript.json

appsscript.json 是 Google Apps Script 的项目配置文件，包含项目的元数据和运行时配置。

{
  "timeZone": "America/New_York",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8"
}

• timeZone: 设置项目的时区。
• dependencies: 项目的依赖配置。
• exceptionLogging: 异常日志记录方式。
• runtimeVersion: 设置运行时版本，这里使用 V8。

.clasp.json

.clasp.json 用于配置 Google Apps Script 项目的远程路径和 ID。

{
  "scriptId": "your-script-id",
  "rootDir": "dist"
}

• scriptId: Google Apps Script 项目的 ID。
• rootDir: 指定打包后的代码存放目录。

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖和脚本配置。

{
  "name": "apps-script-starter",
  "version": "1.0.0",
  "description": "Google Apps Script Starter Kit",
  "main": "index.js",
  "scripts": {
    "build": "webpack",
    "deploy": "npm run build && clasp push"
  },
  "dependencies": {
    "webpack": "^5.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目入口文件。
• scripts: 定义项目的脚本命令。
• dependencies: 项目的依赖包。

以上是基于开源项目 https://github.com/labnol/apps-script-starter.git 的教程内容，涵盖了项目的目录结构、启动文件和配置文件的介绍。