Class InteractiveVscodeChecker

交互式 VSCode 配置检查器

Hierarchy (View Summary)

VscodeConfigChecker
- InteractiveVscodeChecker

Index

Constructors

Methods

closeReadline promptForMissingFile promptForUpdateFile checkAndUpdateInteractive batchPromptAndUpdate registerTemplate registerTemplates checkAll checkFile updateFile updateAll generateReport

Constructors

constructor

new InteractiveVscodeChecker(projectRoot: string): InteractiveVscodeChecker
创建检查器实例
Parameters
- projectRoot: string
  项目根目录路径
Returns InteractiveVscodeChecker
Inherited from VscodeConfigChecker.constructor
- Defined in vscode-config/src/vscode-config-checker.ts:21

Methods

closeReadline

closeReadline(): void
关闭 readline 接口

Returns void
- Defined in vscode-config/src/vscode-config-checker-interactive.ts:34

promptForMissingFile

promptForMissingFile(result: CheckResult): Promise<UserChoice>
询问用户对缺失文件的处理方式
Parameters
- result: CheckResult
Returns Promise<UserChoice>
- Defined in vscode-config/src/vscode-config-checker-interactive.ts:71

promptForUpdateFile

promptForUpdateFile(result: CheckResult): Promise<UserChoice>
询问用户对需要更新文件的处理方式
Parameters
- result: CheckResult
Returns Promise<UserChoice>
- Defined in vscode-config/src/vscode-config-checker-interactive.ts:102

checkAndUpdateInteractive

checkAndUpdateInteractive(options?: InteractiveOptions): Promise<void>
交互式检查并更新所有文件
Parameters
- options: InteractiveOptions = {}
Returns Promise<void>
- Defined in vscode-config/src/vscode-config-checker-interactive.ts:133

batchPromptAndUpdate

batchPromptAndUpdate(
results: CheckResult[],
options?: UpdateOptions,
): Promise<void>
批量询问并更新
Parameters
- results: CheckResult[]
- options: UpdateOptions = {}
Returns Promise<void>
- Defined in vscode-config/src/vscode-config-checker-interactive.ts:212

registerTemplate

registerTemplate(file: VscodeConfigFile): void
注册模板文件
Parameters
- file: VscodeConfigFile
  模板文件配置
Returns void
Inherited from VscodeConfigChecker.registerTemplate
- Defined in vscode-config/src/vscode-config-checker.ts:29

registerTemplates

registerTemplates(files: VscodeConfigFile[]): void
批量注册模板文件
Parameters
- files: VscodeConfigFile[]
  模板文件配置数组
Returns void
Inherited from VscodeConfigChecker.registerTemplates
- Defined in vscode-config/src/vscode-config-checker.ts:37

checkAll

checkAll(): CheckResult[]
检查所有已注册的文件

Returns CheckResult[]
检查结果数组
Inherited from VscodeConfigChecker.checkAll
- Defined in vscode-config/src/vscode-config-checker.ts:45

checkFile

checkFile(file: VscodeConfigFile): CheckResult
检查单个文件
Parameters
- file: VscodeConfigFile
  模板文件配置
Returns CheckResult
检查结果
Inherited from VscodeConfigChecker.checkFile
- Defined in vscode-config/src/vscode-config-checker.ts:54

updateFile

updateFile(result: CheckResult, options?: UpdateOptions): void
更新单个文件
Parameters
- result: CheckResult
  检查结果
- options: UpdateOptions = {}
  更新选项
Returns void
Inherited from VscodeConfigChecker.updateFile
- Defined in vscode-config/src/vscode-config-checker.ts:81

updateAll

updateAll(results: CheckResult[], options?: UpdateOptions): void
批量更新文件
Parameters
- results: CheckResult[]
  检查结果数组
- options: UpdateOptions = {}
  更新选项
Returns void
Inherited from VscodeConfigChecker.updateAll
- Defined in vscode-config/src/vscode-config-checker.ts:112

generateReport

generateReport(results: CheckResult[]): string
生成检查报告
Parameters
- results: CheckResult[]
  检查结果数组
Returns string
格式化的报告字符串
Inherited from VscodeConfigChecker.generateReport
- Defined in vscode-config/src/vscode-config-checker.ts:121