application

@listenai/lisa_core / Exports / Application

Class: Application

Table of contents#

Constructors#

constructor

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new Application()

Properties#

_apiHost#

• Private Optional _apiHost: string

lisa server api host

Defined in#

src/application.ts:86

_apiPrefix#

• Private Optional _apiPrefix: string

lisa server api prefix

Defined in#

src/application.ts:99

_cacheDir#

• Private Optional _cacheDir: string

lisa cache 缓存目录

Defined in#

src/application.ts:112

_context#

• Private _context: any = {}

自定义参数

Defined in#

src/application.ts:213

_lisaAccessToken#

• Private Optional _lisaAccessToken: string

lisa accessToken

Defined in#

src/application.ts:60

_logPath#

• Private Optional _logPath: string

log 路径

Defined in#

src/application.ts:279

_lpmRegistryUrl#

• Private Optional _lpmRegistryUrl: string

lpm registry url

Defined in#

src/application.ts:73

_lscloudPersonalToken#

• Private Optional _lscloudPersonalToken: string

lscloud personalToken

Defined in#

src/application.ts:47

argv#

• argv: string[] = []

执行命令的参数

Defined in#

src/application.ts:255

description#

• description: string = "CSK 项目"

项目说明

Defined in#

src/application.ts:142

download_path#

• download_path: string

download 目录

Defined in#

src/application.ts:157

errors#

• errors: ValidationError[] = []

验证错误信息

Defined in#

src/application.ts:167

firmwareConfiguration#

• firmwareConfiguration: any = {}

固件配置

Defined in#

src/application.ts:126

flashLpkPath#

• flashLpkPath: string

烧录的lpk包地址

Defined in#

src/application.ts:172

hardwareConfiguration#

• hardwareConfiguration: any = {}

pin脚设置

Defined in#

src/application.ts:131

packageJSON#

• packageJSON: any = null

package.json 信息

Defined in#

src/application.ts:42

pipeline#

• pipeline: Pipeline

创建项目时的参数

Defined in#

src/application.ts:195

root#

• root: string

项目主目录

Defined in#

src/application.ts:147

task_path#

• Optional task_path: string

task 文件地址

Defined in#

src/application.ts:162

tasks#

• tasks: Object = {}

Index signature#

▪ [key: string]: TaskObject

Defined in#

src/application.ts:37

template_path#

• template_path: string

template 目录

Defined in#

src/application.ts:152

version#

• version: string = "1.0.0"

设置版本号，要求为三位表达式, eg: 1.0.0

Defined in#

src/application.ts:137

Accessors#

apiHost#

• get apiHost(): string

Returns#

string

Defined in#

src/application.ts:92

• set apiHost(url): void

Parameters#

Name	Type
`url`	`string`

Returns#

void

Defined in#

src/application.ts:88

apiPrefix#

• get apiPrefix(): string

Returns#

string

Defined in#

src/application.ts:105

• set apiPrefix(url): void

Parameters#

Name	Type
`url`	`string`

Returns#

void

Defined in#

src/application.ts:101

cacheDir#

• get cacheDir(): string

Returns#

string

Defined in#

src/application.ts:118

• set cacheDir(url): void

Parameters#

Name	Type
`url`	`string`

Returns#

void

Defined in#

src/application.ts:114

context#

• get context(): any

Returns#

any

Defined in#

src/application.ts:214

lisaAccessToken#

• get lisaAccessToken(): string

Returns#

string

Defined in#

src/application.ts:66

• set lisaAccessToken(token): void

Parameters#

Name	Type
`token`	`string`

Returns#

void

Defined in#

src/application.ts:62

logPath#

• get logPath(): string

Returns#

string

Defined in#

src/application.ts:285

• set logPath(url): void

Parameters#

Name	Type
`url`	`string`

Returns#

void

Defined in#

src/application.ts:281

lpmRegistryUrl#

• get lpmRegistryUrl(): string

Returns#

string

Defined in#

src/application.ts:79

• set lpmRegistryUrl(url): void

Parameters#

Name	Type
`url`	`string`

Returns#

void

Defined in#

src/application.ts:75

lscloudPersonalToken#

• get lscloudPersonalToken(): string

Returns#

string

Defined in#

src/application.ts:53

• set lscloudPersonalToken(token): void

Parameters#

Name	Type
`token`	`string`

Returns#

void

Defined in#

src/application.ts:49

Methods#

addContext#

▸ addContext(packageName, context): void

添加指定包的自定义参数

Parameters#

Name	Type	Description
`packageName`	`string`	lisa lib包名
`context`	`Object`	自定义参数

Returns#

void

Defined in#

src/application.ts:223

addGlobalContext#

▸ addGlobalContext(context): void

添加全局的自定义参数

Parameters#

Name	Type	Description
`context`	`Object`	自定义参数

Returns#

void

Defined in#

src/application.ts:236

configuration#

▸ configuration(callback): void

程序设置

Parameters#

Name	Type
`callback`	`ConfigFunc`

Returns#

void

Defined in#

src/application.ts:178

env#

▸ env(): LisaEnv

获取 Lisa 在某个环境中使用, 不可以通过代码设置，仅允许通过环境变量 LISA_ENV 来设置可选参数 dev prod test 默认是 dev，不用做多修改，允许测试的时候请你使用

npm run build && LISA_ENV=test jest --coverage

Returns#

LisaEnv

Defined in#

src/application.ts:265

errorLog#

▸ errorLog(stderr): void

log stderr 输出

Parameters#

Name	Type	Description
`stderr`	`string`	输出内容

Returns#

void

Defined in#

src/application.ts:333

getContextFromPackageName#

▸ getContextFromPackageName(packaegName): any

获取包名下面的Context属性

Parameters#

Name	Type	Description
`packaegName`	`string`	包名

Returns#

any

Defined in#

src/application.ts:244

gitignore#

▸ gitignore(path, args): void

gitignore 设置git忽略的目录文件

Parameters#

Name	Type	Description
`path`	`string`	.gitignore 路径
`args`	`string`[]	要忽略的目录文件

Returns#

void

Defined in#

src/application.ts:294

log#

▸ log(stdout): void

log stdout 输出

Parameters#

Name	Type	Description
`stdout`	`string`	输出内容

Returns#

void

Defined in#

src/application.ts:317

logReport#

▸ logReport(options): Promise<void>

上报到日志服务

Parameters#

Name	Type	Description
`options`	`Object`	Object 需要上报的内容
`options.cid?`	`string` \| `number`	-
`options.company_id?`	`string` \| `number`	-
`options.content?`	`string`	-
`options.csk_commit?`	`string` \| `number`	-
`options.project_name?`	`string`	-
`options.res?`	`null` \| `string`	-
`options.type`	`string`	-
`options.user_id?`	`string` \| `number`	-
`options.version?`	`string`	-

Returns#

Promise<void>

Defined in#

src/application.ts:351

validateConfig#

▸ validateConfig(): Promise<boolean>

Returns#

Promise<boolean>

Defined in#

src/application.ts:182