modules

@listenai/lisa_core / Exports

@listenai/lisa_core

Table of contents

Namespaces

• Table
• fs

Enumerations

• LisaEnv

Classes

• ActionBase
• Application
• Config
• ExitError
• PipelineObject

Interfaces

• IPromptOptions

Type aliases

• Pipeline
• TaskObject
• TaskOptions

Variables

• Tasks
• application
• cli
• cmd
• config
• got
• project_lang
• store
• ux

Functions

• argv
• flags
• job
• load
• loadConfig
• loadDependencies
• loadDevDependencies
• loadFile
• loadPackageJSON
• loadTask
• loadTypescript
• minimist
• parsePackageJSON
• reloadApplication
• runner

Type aliases

Pipeline

Ƭ Pipeline: Object

pipeline定义

Index signature

▪ [key: string]: PipelineObject

Defined in

src/application.ts:16

---

TaskObject

Ƭ TaskObject: Listr.ListrTask<Listr.ListrContext>

Defined in

src/application.ts:10

---

TaskOptions

Ƭ TaskOptions: Listr.ListrOptions

Defined in

src/application.ts:11

Variables

Tasks

• Const Tasks: typeof Listr

引用Listr来执行task指令

Defined in

src/index.ts:15

---

application

• application: Application

Defined in

src/index.ts:26

---

cli

• Const cli: Object

Type declaration

Name	Type	Description
action	ActionBase	-
anykey	anykey	"press anykey to continue"
config	Config	-
confirm	confirm	-
error	typeof Errors.error	-
exit	typeof Errors.exit	-
open	default	-
prideAction	ActionBase	-
progress	default	-
prompt	prompt	-
styledHeader	default	-
styledJSON	default	-
table	typeof table	-
tree	default	-
wait	(ms?: number) => Promise<unknown>	-
warn	typeof Errors.warn	-
annotation	(text: string, annotation: string) => void	-
debug	(format: string, ...args: string[]) => void	-
done	() => Promise<void>	-
flush	() => Promise<void>	-
info	(format: string, ...args: string[]) => void	-
log	(format?: string, ...args: string[]) => void	-
styledObject	(obj: any, keys?: string[]) => void	-
trace	(format: string, ...args: string[]) => void	-
url	(text: string, uri: string, params?: {}) => void	-

Defined in

node_modules/cli-ux/lib/index.d.ts:38

---

cmd

• Const cmd: Object

Call signature

▸ (file, arguments?, options?): ExecaChildProcess<string>

Execute a file.

Think of this as a mix of child_process.execFile and child_process.spawn.

example

import execa = require('execa');
(async () => {const {stdout} = await execa('echo', ['unicorns']);console.log(stdout);//=> 'unicorns'
// Cancelling a spawned process
const subprocess = execa('node');
setTimeout(() => {subprocess.cancel()}, 1000);
try {await subprocess;} catch (error) {console.log(subprocess.killed); // trueconsole.log(error.isCanceled); // true}})();
// Pipe the child process stdout to the current stdoutexeca('echo', ['unicorns']).stdout.pipe(process.stdout);

Parameters

Name	Type	Description
file	string	The program/script to execute.
arguments?	readonly string[]	Arguments to pass to file on execution.
options?	Options<string>	-

Returns

ExecaChildProcess<string>

A child_process instance, which is enhanced to also be a Promise for a result Object with stdout and stderr properties.

▸ (file, arguments?, options?): ExecaChildProcess<Buffer>

引用execa来执行shell命令，解决windows一些兼容性问题，具体请查看 execa

Parameters

Name	Type
file	string
arguments?	readonly string[]
options?	Options<null>

Returns

ExecaChildProcess<Buffer>

▸ (file, options?): ExecaChildProcess<string>

引用execa来执行shell命令，解决windows一些兼容性问题，具体请查看 execa

Parameters

Name	Type
file	string
options?	Options<string>

Returns

ExecaChildProcess<string>

▸ (file, options?): ExecaChildProcess<Buffer>

引用execa来执行shell命令，解决windows一些兼容性问题，具体请查看 execa

Parameters

Name	Type
file	string
options?	Options<null>

Returns

ExecaChildProcess<Buffer>

Type declaration

Name	Type
command	(command: string, options?: Options<string>) => ExecaChildProcess<string>(command: string, options?: Options<null>) => ExecaChildProcess<Buffer>
commandSync	(command: string, options?: SyncOptions<string>) => ExecaSyncReturnValue<string>(command: string, options?: SyncOptions<null>) => ExecaSyncReturnValue<Buffer>
node	(scriptPath: string, arguments?: readonly string[], options?: NodeOptions<string>) => ExecaChildProcess<string>(scriptPath: string, arguments?: readonly string[], options?: Options<null>) => ExecaChildProcess<Buffer>(scriptPath: string, options?: Options<string>) => ExecaChildProcess<string>(scriptPath: string, options?: Options<null>) => ExecaChildProcess<Buffer>
sync	(file: string, arguments?: readonly string[], options?: SyncOptions<string>) => ExecaSyncReturnValue<string>(file: string, arguments?: readonly string[], options?: SyncOptions<null>) => ExecaSyncReturnValue<Buffer>(file: string, options?: SyncOptions<string>) => ExecaSyncReturnValue<string>(file: string, options?: SyncOptions<null>) => ExecaSyncReturnValue<Buffer>

Defined in

src/index.ts:47

---

config

• Const config: Config

Defined in

node_modules/cli-ux/lib/config.d.ts:19

---

got

• Const got: Got

使用 Got 来处理 HTTP 请求，具体请查看 GOT

Defined in

src/index.ts:20

---

project_lang

• project_lang: string

项目引导能力，用于命令行引导程序

Defined in

src/load.ts:9

---

store

• Const store: Configstore

Defined in

src/index.ts:21

---

ux

• Const ux: Object

Type declaration

Name	Type	Description
action	ActionBase	-
anykey	anykey	"press anykey to continue"
config	Config	-
confirm	confirm	-
error	typeof Errors.error	-
exit	typeof Errors.exit	-
open	default	-
prideAction	ActionBase	-
progress	default	-
prompt	prompt	-
styledHeader	default	-
styledJSON	default	-
table	typeof table	-
tree	default	-
wait	(ms?: number) => Promise<unknown>	-
warn	typeof Errors.warn	-
annotation	(text: string, annotation: string) => void	-
debug	(format: string, ...args: string[]) => void	-
done	() => Promise<void>	-
flush	() => Promise<void>	-
info	(format: string, ...args: string[]) => void	-
log	(format?: string, ...args: string[]) => void	-
styledObject	(obj: any, keys?: string[]) => void	-
trace	(format: string, ...args: string[]) => void	-
url	(text: string, uri: string, params?: {}) => void	-

Defined in

node_modules/cli-ux/lib/index.d.ts:7

Functions

argv

▸ argv(argv?, opts?): ParsedArgs

获取环境变量

Parameters

Name	Type	Description
argv	string[]	-
opts?	_minimist.Opts	设置解析参数

Returns

ParsedArgs

Defined in

src/argv.ts:10

---

flags

▸ flags(key): (target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<fn>) => void

仅供typescript代码使用

example

export class CliUx {@flags("project_path")async getProjectPath() {const projectPath = await cli.prompt("请输入项目路径", {default: '.'})return path.resolve(projectPath)}
@flags('author')async getAuthor() {const author = await cli.prompt('请输入作者名称', {default: ''}) as stringreturn author}
getProjectName(projectPath: string) {return path.basename(projectPath)}}

Parameters

Name	Type	Description
key	string	方法字段

Returns

fn

▸ (target, propertyKey, descriptor): void

Parameters

Name	Type
target	any
propertyKey	string
descriptor	TypedPropertyDescriptor<fn>

Returns

void

Defined in

src/argv.ts:42

---

job

▸ job(cmdName, task): void

创建任务

example

job("lisa_core:pre_build", { title: "编译任务1", task: async() => {   console.log("a")   await fs.remove("./out")   fs.project.root = "./out"   await fs.project.mkdir("app", "config", "target") }})

Parameters

Name	Type	Description
cmdName	string	任务名称，必须是类似 build:pre 的名称；请注意，如果任务名称相同，不可知道任务是否会被替换，推荐使用 {包名}:{任务名}的命名规范
task	TaskObject	任务对象

Returns

void

Defined in

src/task/index.ts:21

---

load

▸ load(): @listenai/lisa_core

Returns

@listenai/lisa_core

Defined in

src/load.ts:169

---

loadConfig

▸ loadConfig(configPath?): void

加载 config.[js|ts]

Parameters

Name	Type	Description
configPath?	string	config地址，默认为packge.json中配置的地址，如果没有配置，读取项目中config.js

Returns

void

Defined in

src/load.ts:39

---

loadDependencies

▸ loadDependencies(): void

Returns

void

Defined in

src/load.ts:105

---

loadDevDependencies

▸ loadDevDependencies(): void

Returns

void

Defined in

src/load.ts:145

---

loadFile

▸ loadFile(file): void

Parameters

Name	Type	Description
file	string	加载路径

Returns

void

Defined in

src/load.ts:15

---

loadPackageJSON

▸ loadPackageJSON(packagePath?): void

Parameters

Name	Type
packagePath?	string

Returns

void

Defined in

src/load.ts:95

---

loadTask

▸ loadTask(taskPath?): void

加载 task.[js|ts]

Parameters

Name	Type	Description
taskPath?	string	task地址，默认为packge.json中配置的地址，如果没有配置，读取项目中 task.js

Returns

void

Defined in

src/load.ts:65

---

loadTypescript

▸ loadTypescript(): void

Returns

void

Defined in

src/load.ts:99

---

minimist

▸ Const minimist(args?, opts?): minimist.ParsedArgs

Parameters

Name	Type
args?	string[]
opts?	minimist.Opts

Returns

minimist.ParsedArgs

Defined in

src/argv.ts:4

▸ Const minimist<T>(args?, opts?): T & minimist.ParsedArgs

Type parameters

Name
T

Parameters

Name	Type
args?	string[]
opts?	minimist.Opts

Returns

T & minimist.ParsedArgs

Defined in

src/argv.ts:4

▸ Const minimist<T>(args?, opts?): T

Type parameters

Name	Type
T	extends ParsedArgs

Parameters

Name	Type
args?	string[]
opts?	minimist.Opts

Returns

T

Defined in

src/argv.ts:4

---

parsePackageJSON

▸ parsePackageJSON(packagePath?): any

Parameters

Name	Type
packagePath?	string

Returns

any

Defined in

src/load.ts:85

---

reloadApplication

▸ reloadApplication(): void

危险：仅供测试使用

Returns

void

Defined in

src/index.ts:52

---

runner

▸ runner(job_list?, ctx?, verbose?): Promise<unknown>

Parameters

Name	Type
job_list?	string
ctx?	Object
verbose?	boolean

Returns

Promise<unknown>

Defined in

src/task/index.ts:25