Google Docs Add-On 项目教程

1. 项目的目录结构及介绍

google-docs-add-on/
├── dist/
├── src/
│   ├── Code.js
│   ├── Config.js
│   ├── ...
├── test/
├── .babelrc
├── .claspignore
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc.js
├── CHANGELOG.md
├── CREDITS.md
├── LICENSE.md
├── README.md
├── package-lock.json
├── package.json
└── webpack.config.js

目录结构介绍

• dist/: 存放编译后的文件。
• src/: 项目的源代码目录，包含主要的JavaScript文件。
  • Code.js: 项目的主入口文件。
  • Config.js: 配置文件，用于管理项目的配置参数。
  • ...: 其他辅助文件。
• test/: 存放测试文件。
• .babelrc: Babel配置文件，用于转换ES6+代码。
• .claspignore: Clasp忽略文件，用于指定不需要上传到Google Apps Script的文件。
• .eslintignore: ESLint忽略文件，用于指定不需要进行代码检查的文件。
• .eslintrc: ESLint配置文件，用于代码风格检查。
• .gitignore: Git忽略文件，用于指定不需要纳入版本控制的文件。
• .prettierrc.js: Prettier配置文件，用于代码格式化。
• CHANGELOG.md: 项目更新日志。
• CREDITS.md: 项目贡献者列表。
• LICENSE.md: 项目许可证。
• README.md: 项目说明文件。
• package-lock.json: 锁定依赖包的版本。
• package.json: 项目依赖管理文件。
• webpack.config.js: Webpack配置文件，用于打包项目。

2. 项目的启动文件介绍

主入口文件：src/Code.js

Code.js 是项目的启动文件，负责初始化插件并定义主要的逻辑流程。以下是该文件的主要功能：

• 初始化插件: 在Google Docs中加载插件时，首先执行该文件中的代码。
• 定义菜单项: 创建自定义菜单项，用户可以通过这些菜单项触发插件的功能。
• 处理用户交互: 处理用户在Google Docs中的操作，例如点击菜单项或按钮。

示例代码

function onOpen(e) {
  DocumentApp.getUi()
    .createMenu('WordPress')
    .addItem('Publish to WordPress', 'publishToWordPress')
    .addToUi();
}

function publishToWordPress() {
  // 发布文档到WordPress的逻辑
}

3. 项目的配置文件介绍

配置文件：src/Config.js

Config.js 文件用于管理项目的配置参数，例如API密钥、URL地址等。以下是该文件的主要功能：

• 定义配置项: 定义项目所需的配置参数，例如WordPress的API地址、OAuth客户端ID等。
• 读取配置: 在项目启动时，读取这些配置参数并应用到相应的功能模块中。

示例代码

const Config = {
  wordpressApiUrl: 'https://example.com/wp-json/wp/v2/',
  oauthClientId: 'your-client-id',
  oauthClientSecret: 'your-client-secret',
};

export default Config;

通过以上配置文件，项目可以在不同的环境中灵活配置，确保功能的正常运行。