Sarus项目启动与配置教程

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

Sarus项目的主要目录结构如下：

.
├── .github/
├── .gitignore
├── __tests__/
├── dist/
├── scripts/
├── src/
├── editorconfig
├── gitignore
├── BACKGROUND.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── FUTURE.md
├── LICENSE
├── README.md
├── SECURITY.md
├── TODO.md
├── jest.config.js
├── package-lock.json
├── package.json
└── tsconfig.json

• .github/：包含GitHub特有的配置文件。
• .gitignore：指定Git应该忽略的文件和目录。
• __tests__/：存放单元测试相关的代码。
• dist/：编译后的文件存放目录。
• scripts/：包含构建和辅助脚本。
• src/：源代码目录，包含项目的核心实现。
• editorconfig：定义代码编辑器的配置。
• gitignore：项目的.gitignore文件。
• BACKGROUND.md、CHANGELOG.md、CODE_OF_CONDUCT.md、CONTRIBUTING.md、FUTURE.md、SECURITY.md、TODO.md：项目相关的文档。
• LICENSE：项目的许可文件。
• README.md：项目的自述文件，提供项目的基本信息。
• SECURITY.md：安全性相关的信息和指南。
• jest.config.js：Jest测试框架的配置文件。
• package-lock.json：npm依赖项的锁定文件。
• package.json：项目的npm配置文件。
• tsconfig.json：TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是src/目录下的主文件，例如index.ts或main.ts。这个文件会创建一个Sarus实例，并配置WebSocket连接的相关参数。

以下是一个简单的启动文件示例：

import Sarus from '@anephenix/sarus';

const sarus = new Sarus({
  url: 'wss://ws.anephenix.com'
});

// 添加事件监听器
sarus.on('open', () => {
  console.log('Connection opened');
});

sarus.on('message', event => {
  const message = JSON.parse(event.data);
  // 处理消息
});

sarus.on('close', () => {
  console.log('Connection closed');
});

sarus.on('error', error => {
  throw error;
});

这个文件会创建一个WebSocket连接，并在连接上注册事件监听器，以处理打开、消息、关闭和错误事件。

3. 项目的配置文件介绍

项目的配置文件主要包括package.json和tsconfig.json。

• package.json：定义了项目的依赖项、脚本和元数据。例如：

{
  "name": "sarus",
  "version": "1.0.0",
  "description": "A WebSocket JavaScript library.",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    // 依赖项
  },
  "devDependencies": {
    // 开发依赖项
  }
}

• tsconfig.json：TypeScript项目的配置文件，定义了TypeScript编译器的选项，例如：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"],
  "exclude": ["node_modules", "__tests__"]
}

这些配置文件帮助开发者构建、测试和部署项目。