Class PrettierCheck

Hierarchy

LintBase<PrettierCheckConfig, PrettierCheckResult>
- PrettierCheck

Index

Constructors

Properties

cacheFilePath cacheInfo config? isCheckAll logger stats tag whiteList

Accessors

Methods

beforeStart check checkForPackages checkInChildProc checkInWorkThreads filesFilter getCacheInfo getCommitId getFileList getInitStats getOptions init parseConfig saveCache start

Constructors

constructor

new PrettierCheck(config?: PrettierCheckConfig): PrettierCheck
Parameters
- config: PrettierCheckConfig = {}
Returns PrettierCheck
Overrides LintBase<PrettierCheckConfig, PrettierCheckResult>.constructor
- Defined in lint/prettier-check.ts:24

Properties

`Protected`cacheFilePath

cacheFilePath: string = ''

检测缓存文件的路径。不应提交至 git 仓库

`Protected`cacheInfo

cacheInfo: LintCacheInfo = ...

要缓存到 cacheFilePath 的信息

`Protected` `Optional`config

config?: PrettierCheckConfig

`Protected`isCheckAll

isCheckAll: boolean = false

`Protected`logger

logger: NLogger

`Protected`stats

stats: PrettierCheckResult = ...

统计信息

`Protected`tag

tag: "eslint" | "tscheck" | "jest" | "jira" | "prettier"

`Protected`whiteList

whiteList: WhiteListInfo = ...

Accessors

statsInfo

get statsInfo(): R
返回执行结果统计信息

Returns R
Inherited from LintBase.statsInfo
- Defined in lint/LintBase.ts:103

Methods

`Protected`beforeStart

beforeStart(): boolean
start 之前调用。返回 true 才会继续执行

Returns boolean
Overrides LintBase.beforeStart
- Defined in lint/prettier-check.ts:230

`Protected`check

check(fileList?: string[]): Promise<PrettierCheckResult>
执行检测
Parameters
- fileList: string[] = ...
Returns Promise<PrettierCheckResult>
Overrides LintBase.check
- Defined in lint/prettier-check.ts:114

`Protected`checkForPackages

checkForPackages(): Promise<LintResult>
Returns Promise<LintResult>
Inherited from LintBase.checkForPackages
- Defined in lint/LintBase.ts:196

`Protected`checkInChildProc

checkInChildProc(config?: PrettierCheckConfig): Promise<PrettierCheckResult>
在 fork 子进程中执行
Parameters
- config: PrettierCheckConfig = ...
Returns Promise<PrettierCheckResult>
Inherited from LintBase.checkInChildProc
- Defined in lint/LintBase.ts:127

`Protected`checkInWorkThreads

checkInWorkThreads(config?: PrettierCheckConfig): Promise<PrettierCheckResult>
在 work_threads 子线程中执行
Parameters
- config: PrettierCheckConfig = ...
Returns Promise<PrettierCheckResult>
Inherited from LintBase.checkInWorkThreads
- Defined in lint/LintBase.ts:141

`Protected`filesFilter

filesFilter(
    fileList: string | string[],
    isFilterByExt?: boolean,
    cacheFilter?: boolean,
): string[]
通用文件过滤，基于 include、exclude 和 extensions
Parameters
- fileList: string | string[]
- isFilterByExt: boolean = true
- cacheFilter: boolean = true
Returns string[]
Inherited from LintBase.filesFilter
- Defined in lint/LintBase.ts:108

`Protected`getCacheInfo

getCacheInfo(): LintCacheInfo
Returns LintCacheInfo
Inherited from LintBase.getCacheInfo
- Defined in lint/LintBase.ts:159

getCommitId

getCommitId(): string
Returns string
Inherited from LintBase.getCommitId
- Defined in lint/LintBase.ts:155

`Protected`getFileList

getFileList(fileList: string[]): Promise<string[]>
Parameters
- fileList: string[]
Returns Promise<string[]>
- Defined in lint/prettier-check.ts:62

`Protected`getInitStats

getInitStats(): PrettierCheckResult
获取初始化的统计信息

Returns PrettierCheckResult
Overrides LintBase.getInitStats
- Defined in lint/prettier-check.ts:27

`Protected`getOptions

getOptions(_fileList: string[]): Promise<Config>
Parameters
- _fileList: string[]
Returns Promise<Config>
- Defined in lint/prettier-check.ts:47

`Protected`init

init(): void
Returns void
Overrides LintBase.init
- Defined in lint/prettier-check.ts:43

parseConfig

parseConfig(config: PrettierCheckConfig): PrettierCheckConfig
配置参数格式化
Parameters
- config: PrettierCheckConfig
Returns PrettierCheckConfig
Overrides LintBase.parseConfig
- Defined in lint/prettier-check.ts:35

`Protected`saveCache

saveCache(filepath: string, info: unknown, isReset?: boolean): void
Parameters
- filepath: string
- info: unknown
- isReset: boolean = false
Returns void
Inherited from LintBase.saveCache
- Defined in lint/LintBase.ts:176

start

start(fileList?: string[]): Promise<PrettierCheckResult>
Parameters
- fileList: string[] = ...
Returns Promise<PrettierCheckResult>
Inherited from LintBase.start
- Defined in lint/LintBase.ts:274