create-wpssync v0.0.2-beta.4

Create WPS Sync App

create-wpssync-app 是一个命令行工具，用于快速创建 WPS 同步项目的脚手架。

快速开始

你可以使用以下包管理器来创建项目：

使用 pnpm 创建项目

pnpm create wpssync <project-name>

使用 npm 创建项目

npm create wpssync <project-name>

使用 yarn 创建项目

yarn create wpssync <project-name>

使用 bun 创建项目

bun create wpssync <project-name>

功能

该CLI 工具支持以下功能：

1. 创建新项目：根据模版项目生成一个新的项目。
2. 交互式选择： • 项目名称（如果未提供）。 • 项目描述。 • 选择通讯录同步方式：api、mysql、oracle、mssql。 • 选择认证协议：cas、oauth2、none。 • 是否支持 HTTPS。 • 是否订阅 WPS 消息。 • 选择同步方式：增量 或 全量。 • 配置远程仓库地址。
3. 项目模版结构： • 自动创建和初始化项目结构。 • 自动处理依赖和配置文件的修改。 • 初始化 Git 仓库，并自动关联远程仓库.

使用步骤

1. 在项目目录下运行脚手架命令，选择或提供项目名称：

pnpm create wpssync <project-name>

2. 工具会提示你输入项目描述、选择通讯录同步方式等。根据你的项目需求填写或选择对应的选项。
3. 工具会自动生成项目结构并完成配置。
4. 如果选择了 mysql、mssql、或 oracle，工具会根据通讯录方式更新项目的依赖项，并修改 .env 和 package.json 文件。
5. 工具会自动为你初始化一个 Git 仓库，并关联远程仓库。

目录结构

工具会生成以下默认的项目结构：

project-name/
├── .env
├── docker-compose.yml
├── src/
│   ├── api/
│   │   ├── create<projectName>Cas.ts (如果选择了 CAS)
│   │   ├── create<projectName>OauthService.ts (如果选择了 OAuth2)
│   └── data/
│       ├── createConfig.ts
│       ├── createRemoteService.ts
│       └── createSaveDBFromApiService.ts
└── README.md

编译项目

bun

bun install
bun run build
bun link