Discord Embedded App SDK 使用教程

Discord Embedded App SDK 使用教程

embedded-app-sdk 项目地址: https://gitcode.com/gh_mirrors/em/embedded-app-sdk

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

discord/embedded-app-sdk/
├── assets/
├── docs/
├── examples/
├── scripts/
├── src/
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .npmrc
├── .prettierrc
├── .watchmanconfig
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── commitlint.config.js
├── jest.config.ts
├── package-lock.json
├── package.json

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• docs/: 存放项目的文档文件。
• examples/: 存放项目的示例代码。
• scripts/: 存放项目的脚本文件。
• src/: 存放项目的主要源代码。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• .watchmanconfig: Watchman 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• commitlint.config.js: commitlint 配置文件。
• jest.config.ts: Jest 测试配置文件。
• package-lock.json: npm 锁定文件。
• package.json: 项目依赖和脚本配置文件。

2. 项目的启动文件介绍

在 src/ 目录下，通常会有一个主要的入口文件，例如 index.js 或 main.js。这个文件是项目的启动文件，负责初始化 SDK 并启动应用程序。

// src/index.js
import { DiscordSDK } from '@discord/embedded-app-sdk';

const discordSdk = new DiscordSDK(YOUR_OAUTH2_CLIENT_ID);

async function setup() {
  // 等待 Discord 客户端的 READY 事件
  await discordSdk.ready();
  
  // 打开 OAuth 弹窗
  discordSdk.openOAuth();
}

setup();

启动文件介绍

• index.js: 项目的入口文件，负责初始化 Discord SDK 并启动应用程序。
• DiscordSDK: SDK 的主类，用于与 Discord 客户端进行通信。
• setup(): 异步函数，用于设置和启动 SDK。

3. 项目的配置文件介绍

.eslintrc.json

ESLint 配置文件，用于定义代码风格和规则。

{
  "extends": "eslint:recommended",
  "rules": {
    "no-console": "off"
  }
}

package.json

项目的依赖和脚本配置文件。

{
  "name": "embedded-app-sdk",
  "version": "1.0.0",
  "scripts": {
    "start": "node src/index.js",
    "test": "jest"
  },
  "dependencies": {
    "@discord/embedded-app-sdk": "^1.0.0"
  },
  "devDependencies": {
    "eslint": "^7.0.0",
    "jest": "^26.0.0"
  }
}

jest.config.ts

Jest 测试配置文件。

export default {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testMatch: ['**/*.test.ts']
};

配置文件介绍

• .eslintrc.json: 定义代码风格和规则。
• package.json: 定义项目的依赖和脚本。
• jest.config.ts: 定义 Jest 测试配置。

通过以上内容，您可以了解 Discord Embedded App SDK 项目的目录结构、启动文件和配置文件的基本信息。

embedded-app-sdk 项目地址: https://gitcode.com/gh_mirrors/em/embedded-app-sdk