iCal Generator 项目使用教程

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

iCal Generator 项目的目录结构如下：

ical-generator/
├── dist/
│   ├── index.d.ts
│   ├── index.js
│   └── index.js.map
├── examples/
│   ├── basic.js
│   ├── custom-uid.js
│   ├── full.js
│   ├── minimal.js
│   └── recurring.js
├── lib/
│   ├── index.d.ts
│   ├── index.js
│   └── index.js.map
├── test/
│   ├── index.test.js
│   └── utils.test.js
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .npmignore
├── .prettierrc
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录介绍：

• dist/: 编译后的文件，包含 TypeScript 定义文件、JavaScript 文件和源映射文件。
• examples/: 示例代码，展示了如何使用 iCal Generator 创建不同类型的 iCal 事件。
• lib/: 源代码目录，包含 TypeScript 定义文件和编译后的 JavaScript 文件。
• test/: 测试文件，包含单元测试和工具函数测试。
• .editorconfig, .eslintrc.json, .gitignore, .npmignore, .prettierrc: 项目配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 examples/ 目录下的示例文件。这些文件展示了如何使用 iCal Generator 创建不同类型的 iCal 事件。以下是一些示例文件的介绍：

• basic.js: 基本的 iCal 事件创建示例。
• custom-uid.js: 自定义 UID 的 iCal 事件创建示例。
• full.js: 包含所有可选属性的完整 iCal 事件创建示例。
• minimal.js: 最小化的 iCal 事件创建示例。
• recurring.js: 重复事件的 iCal 事件创建示例。

3. 项目的配置文件介绍

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

• package.json: 包含项目的依赖、脚本和其他元数据。
• tsconfig.json: TypeScript 编译配置文件。
• .eslintrc.json: ESLint 代码风格检查配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• .editorconfig: 编辑器配置文件，统一代码风格。

package.json 配置示例：

{
  "name": "ical-generator",
  "version": "3.0.0",
  "description": "ical-generator is a small piece of code which generates ical calendar files",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "lint": "eslint src examples test --ext .ts,.js"
  },
  "dependencies": {
    "moment-timezone": "^0.5.33"
  },
  "devDependencies": {
    "@types/jest": "^27.0.1",
    "eslint": "^7.32.0",
    "jest": "^27.1.0",
    "prettier": "^2.3.2",
    "ts-jest": "^27.0.5",
    "typescript": "^4.4.2"
  }
}

tsconfig.json 配置示例：

{
  "compilerOptions": {
    "target": "ES2019",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingIn