<p align="center" dir="ltr" style="display:flex;flex-direction:row;justify-content:center;text-align:center;">
    <img alt="logo" src="https://yun.swimly.cn/source/ldesign/logo.svg" height="48" style="margin-bottom: 10px;">
</p>

<h1 align="center" style="display:flex;flex-direction:row;justify-content:center;text-align:center;">LDesign 脚手架</h1>


### 准备工作

需联系管理员索要`npm`平台的账号密码，然后在系统中登录该账号。

``` bash
// 不推荐，新手容易出错。
npm login --registry http://npm.longrise.cn:6286/
```

随后依次输入账号密码即可。

#### 使用内置命令登陆

自`0.6.0`支持脚手架内部登录npm，并会在本机保存用户名和密码（加密保存），后续如果忘记可通过命令查看。

``` bash
ldesign login --username=xx --password=xx
```

> 提示：哪怕没有手动登录`npm`，再第一次执行ldesign命令的时候也会自动提示输入用户名和密码进行登录。

### 安装

可通过下面命令进行全局安装，只有第一次需要执行下面的命令，以后每次升级脚手架只需执行：`ldesign upgrade`

``` bash
npm install -g @ldesign/cli --registry=http://npm.longrise.cn:6286/
```

### 更新

从`0.4.5`版本开始，脚手架支持内部升级。

``` bash
ldesign upgrade
```

### 初始化项目

脚手架可用来初始化多模板的项目，通过下面的命令选择模板及相关配置。

> 注意：在初始化项目的时候需先创建一个空的文件夹，并在空文件夹中打开终端执行下面的命令（文件夹名称便是项目名称，请谨慎。）

``` bash
ldesign init
```

### 安装项目依赖

默认情况下，初始化完成之后会自动安装依赖，如果是从gitlab拉取的项目并未经过初始化的过程，可通过下面的命令来安装依赖

``` bash
ldesign install // 或者 ldesign i
```

### 更新项目模板

在开发过程中，如需升级项目模板，只需通过下面的命令更新项目依赖即可。

``` bash
ldesign update
```

### 项目打包

取代原有的`vite build`命令，集成静态资源打包和`jar`打包，自`0.5.6`版本开始支持。

``` bash
ldesign build
```

### 安装外部依赖

自`0.6.0`开始支持安装外部依赖。

``` bash
ldesign add xx
```

### 移除项目依赖

自`0.6.1`开始支持从项目中移除依赖，谨慎操作！

``` bash
ldesign remove [xx]
```

### 查看项目依赖

可通过下面的命令查看当前项目的依赖包

``` bash
ldesign depends

// 自0.6.0版本后更改为下面的命令
ldesign deps
```

### 修改脚手架配置

可通过下面的命令来修改 `host`gitlab的地址（用于git同步），`token`（gitlab的token），`registry`npm私有源。

```
ldesign set --host=xx
ldesign set --registry=xx
ldesign set --token=xx
```

> 提示：上面三个命令也可以合并成一个：`ldesign set --host=xx --registry=xx --token=xx`


### 如何使用git

脚手架中支持在创建项目的时候自动创建gitlab远程仓库并添加远程仓库，实现代码同步功能，在开始之前需进行如下操作：

#### 获取gitlab token

访问[https://git.longrise.cn:6285/-/profile/personal_TOKENs]()，填入token名称并勾选全部的权限，点击创建即可。

创建成功后，会得到一串token字符串，复制字符串。

#### 配置token

在终端执行下面的命令，选择 `Gitlab 密钥`,并回车，将刚刚复制的token粘贴上去再次回车即可。

``` bash
ldesign config
```

到此位置，gitlab的相关配置就完成了。