Wechaty Puppet Padchat 项目教程

Wechaty Puppet Padchat 项目教程

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

Wechaty Puppet Padchat 项目的目录结构如下：

wechaty-puppet-padchat/
├── bin/
├── examples/
├── image/
├── scripts/
├── src/
├── tests/
├── .editorconfig
├── .gitignore
├── .markdownlintrc
├── .travis.yml
├── LICENSE
├── README-en.md
├── README.md
├── package.json
├── tsconfig.json
└── tslint.json

目录介绍

• bin/: 包含项目的可执行文件。
• examples/: 包含项目的示例代码。
• image/: 包含项目的图片资源。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的主要源代码。
• tests/: 包含项目的测试代码。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .markdownlintrc: Markdown 格式检查配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README-en.md: 英文项目说明文档。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TypeScript 代码风格检查配置文件。

2、项目的启动文件介绍

项目的启动文件位于 src/ 目录下，主要包含以下文件：

• main.ts: 项目的主入口文件，负责初始化和启动 Wechaty Puppet Padchat。

启动文件介绍

• main.ts: 该文件是项目的入口点，负责初始化 Wechaty 实例并启动 Puppet Padchat。代码示例如下：

import { Wechaty } from 'wechaty';

const WECHATY_PUPPET_PADCHAT_TOKEN = 'your-token-here';
const puppet = 'wechaty-puppet-padchat';
const puppetOptions = { token: WECHATY_PUPPET_PADCHAT_TOKEN };

const bot = new Wechaty({ puppet, puppetOptions });

bot.on('scan', (qrcode, status) => {
  console.log(`Scan QR Code to login: ${status}\n${qrcode}`);
});

bot.start()
  .then(() => console.log('Bot started.'))
  .catch(e => console.error(e));

3、项目的配置文件介绍

项目的配置文件主要包括以下几个：

• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TypeScript 代码风格检查配置文件。

配置文件介绍

• package.json: 该文件定义了项目的依赖包、脚本命令和其他元数据。关键部分如下：

{
  "name": "wechaty-puppet-padchat",
  "version": "0.0.1",
  "description": "Padchat Puppet for Wechaty",
  "main": "src/main.ts",
  "scripts": {
    "start": "ts-node src/main.ts",
    "test": "jest"
  },
  "dependencies": {
    "wechaty": "^0.60.0",
    "wechaty-puppet-padchat": "^0.20.0"
  },
  "devDependencies": {
    "ts-node": "^9.1.1",
    "typescript": "^4.1.3",
    "jest": "^26.6.3"
  }
}

• tsconfig.json: 该文件定义了 TypeScript 编译选项。关键部分如下：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": [
    "src/**/*"
  ]
}

• tslint.json: