Class JiraCheck

Hierarchy

Constructors

constructor

Properties

cacheFilePath cacheInfo config? isCheckAll logger stats tag whiteList

Accessors

statsInfo

Methods

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

Constructors

constructor

Properties

ProtectedcacheFilePath

cacheFilePath: string = ''

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

ProtectedcacheInfo

cacheInfo: LintCacheInfo<Record<string, unknown>> = ...

要缓存到 cacheFilePath 的信息

Protected Optionalconfig

config?: JiraCheckConfig

ProtectedisCheckAll

isCheckAll: boolean = false

Protectedlogger

logger: NLogger

Protectedstats

stats: JiraCheckResult = ...

统计信息

Protectedtag

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

ProtectedwhiteList

whiteList: WhiteListInfo<unknown> = ...

Accessors

statsInfo

  • get statsInfo(): R

  • 返回执行结果统计信息

    Returns R

Methods

ProtectedbeforeStart

  • beforeStart(): true | "请配置 `jiraHome` 参数"

  • start 之前调用。返回 true 才会继续执行

    Returns true | "请配置 `jiraHome` 参数"

Protectedcheck

  • check(): Promise<JiraCheckResult>

  • 执行检测

    Returns Promise<JiraCheckResult>

ProtectedcheckForPackages

ProtectedcheckInChildProc

  • checkInChildProc(config?): Promise<JiraCheckResult>

  • 在 fork 子进程中执行

    Parameters

    Returns Promise<JiraCheckResult>

ProtectedcheckInWorkThreads

  • checkInWorkThreads(config?): Promise<JiraCheckResult>

  • 在 work_threads 子线程中执行

    Parameters

    Returns Promise<JiraCheckResult>

ProtectedfilesFilter

  • filesFilter(fileList, isFilterByExt?, cacheFilter?): string[]

  • 通用文件过滤，基于 include、exclude 和 extensions

    Parameters

    • fileList: string | string[]
    • isFilterByExt: boolean = true
    • cacheFilter: boolean = true

    Returns string[]

ProtectedgetCacheInfo

getCommitId

  • getCommitId(): string

  • Returns string

ProtectedgetInitStats

  • getInitStats(): JiraCheckResult

  • 获取初始化的统计信息

    Returns JiraCheckResult

Protectedinit

parseConfig

ProtectedsaveCache

  • saveCache(filepath, info, isReset?): void

  • Parameters

    • filepath: string
    • info: unknown
    • isReset: boolean = false

    Returns void

start

  • start(fileList?): Promise<JiraCheckResult>

  • Parameters

    • fileList: string[] = ...

    Returns Promise<JiraCheckResult>

validCommitMsgs

  • validCommitMsgs(msgs): Promise<{
        isvalid: boolean;
        smartCommit: string;
    }>

  • Parameters

    • msgs: string[]

    Returns Promise<{
        isvalid: boolean;
        smartCommit: string;
    }>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods