fs.project
@listenai/lisa_core / Exports / fs / Project
Class: Project
fs.Project
项目类，用于快捷创建项目结构
Table of contents#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
• new Project()
Defined in#
Properties#
_download_path#
• Private Optional _download_path: string
template 目录
Defined in#
_root#
• Private Optional _root: string
项目主目录
Defined in#
_template_path#
• Private Optional _template_path: string
template 目录
Defined in#
error#
• error: LogFunction
错误日志方法
Defined in#
info#
• info: LogFunction
日志方法
Defined in#
Accessors#
download_path#
• get download_path(): string
Returns#
string
Defined in#
• set download_path(dir): void
Parameters#
| Name | Type |
|---|---|
dir | string |
Returns#
void
Defined in#
root#
• get root(): string
Returns#
string
Defined in#
• set root(dir): void
Parameters#
| Name | Type |
|---|---|
dir | string |
Returns#
void
Defined in#
template_path#
• get template_path(): string
Returns#
string
Defined in#
• set template_path(dir): void
Parameters#
| Name | Type |
|---|---|
dir | string |
Returns#
void
Defined in#
Methods#
copy#
▸ copy(source, target): Promise<void>
文件复制 or 目录复制
Parameters#
| Name | Type | Description |
|---|---|---|
source | string | 模版地址，注意是在项目设置的模版目录中寻找 |
target | string | 目标地址，注意是在项目中对应的地址 |
Returns#
Promise<void>
Defined in#
downloadFile#
▸ downloadFile(opts): Promise<Object>
下载文件
Parameters#
| Name | Type |
|---|---|
opts | Object |
opts.fileName | string |
opts.progress? | (percentage: number, transferred: number, total: number) => void |
opts.targetDir? | string |
opts.url | string |
Returns#
Promise<Object>
Defined in#
download_join#
▸ download_join(...paths): string
获取下载路径
Parameters#
| Name | Type | Description |
|---|---|---|
...paths | string[] | 路径地址 |
Returns#
string
Defined in#
join#
▸ join(...paths): string
获取项目的对应目录
Parameters#
| Name | Type | Description |
|---|---|---|
...paths | string[] | 路径地址 |
Returns#
string
Defined in#
mkdir#
▸ mkdir(...paths): Promise<void>
创建目录
Parameters#
| Name | Type | Description |
|---|---|---|
...paths | string[] | 目录路径，请注意，这是里相对路径 |
Returns#
Promise<void>
Defined in#
template#
▸ template(source, target, data): Promise<void>
模版渲染器
Parameters#
| Name | Type | Description |
|---|---|---|
source | string | 模版地址，注意是在项目设置的模版目录中寻找 |
target | string | 目标地址，注意是在项目中对应的地址 |
data | any | - |
Returns#
Promise<void>
Defined in#
template_join#
▸ template_join(...paths): string
获取模板路径
Parameters#
| Name | Type | Description |
|---|---|---|
...paths | string[] | 路径地址 |
Returns#
string
Defined in#
touch#
▸ touch(...paths): Promise<void>
创建空白文件
Parameters#
| Name | Type |
|---|---|
...paths | string[] |
Returns#
Promise<void>
Defined in#
unzip#
▸ unzip(source, target?): Promise<void>
解压文件
Parameters#
| Name | Type | Description |
|---|---|---|
source | string | zip文件地址 |
target? | string | 解压目录 |
Returns#
Promise<void>
Defined in#
zip#
▸ zip(): AdmZip
获取zip实例
Returns#
AdmZip