CryptoES 使用教程

1. 项目目录结构及介绍

CryptoES 是一个兼容 ES6 和 TypeScript 的密码学算法库。项目的目录结构如下：

crypto-es/
├── __tests__/              # 测试文件目录
├── lib-backup/             # 备份的库文件
├── lib/                    # 核心库文件
├── .gitignore              # Git 忽略文件
├── CHANGELOG.md            # 更新日志
├── DEVLOG.md               # 开发日志
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
├── package-lock.json       # 包锁定文件
├── package.json            # 包配置文件
└── tsconfig.json           # TypeScript 配置文件

• __tests__：包含项目的测试代码。
• lib-backup：包含备份的库文件，可能用于版本回滚或历史参考。
• lib：包含项目的核心代码，实现了各种密码学算法。
• .gitignore：定义了 Git 应该忽略的文件和目录。
• CHANGELOG.md：记录了项目的所有更新和改进。
• DEVLOG.md：记录了项目的开发过程和开发者日志。
• LICENSE：包含了项目的开源许可证信息。
• README.md：提供了项目的基本信息和如何使用项目的指南。
• package-lock.json：记录了项目依赖的精确版本，用于确保环境一致性。
• package.json：定义了项目的依赖、脚本和其他元数据。
• tsconfig.json：配置 TypeScript 编译器的选项。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本完成的。例如，运行以下命令可以进行项目的测试：

npm test

这会执行 __tests__ 目录中的测试脚本。package.json 中的 scripts 部分可能包含如下内容：

"scripts": {
  "test": "jest"
}

这里使用了 jest 作为测试框架，这是在 package.json 的 dependencies 部分指定的。

3. 项目的配置文件介绍

项目的配置主要通过 tsconfig.json 和 package.json 来完成。

• tsconfig.json：TypeScript 配置文件，用于指定 TypeScript 编译器的选项。例如，它可能指定了模块系统、目标代码版本、以及是否生成源映射等。

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true
  }
}

• package.json：项目的包配置文件，包含了项目的名称、版本、描述、依赖、脚本等信息。其中的 dependencies 部分列出了项目依赖的其他包，而 scripts 部分定义了可以运行的脚本命令。例如：

{
  "name": "crypto-es",
  "version": "1.0.0",
  "description": "A cryptography algorithms library compatible with ES6 and TypeScript",
  "dependencies": {
    "jest": "^27.0.0"
  },
  "scripts": {
    "test": "jest"
  }
}

通过这些配置文件，开发者可以方便地管理和构建项目。