bin/cli - jsdoc-scribe API

Functions(4)

#printHelp

Signature

printHelp()

#parseArgs

line 56

Parameter	Type	Optional	Description
`argv`	`any`

Returns: any

Signature

parseArgs(argv: any): any

#isInsideGitRepo

line 78

Parameter	Type	Optional	Description
`startDir`	`any`

Returns: any

Signature

isInsideGitRepo(startDir: any): any

#main

line 88

Signature

main()

Variables & Constants(45)

#fs

line 4

const fs: any

const

Signature

const fs: any

#path

line 5

const path: any

const

Signature

const path: any

#{ processFile, analyseFile, collectFiles }

line 6

const { processFile, analyseFile, collectFiles }: any

const

Signature

const { processFile, analyseFile, collectFiles }: any

#pkg

line 7

const pkg: any

const

Signature

const pkg: any

#args

line 57

const args: Object

const

Signature

const args: Object

line 59

const a: any

const

Signature

const a: any

#dir

line 79

let dir: any

var

Signature

let dir: any

#parent

line 82

const parent: any

const

Signature

const parent: any

#argv

line 89

const argv: any

const

Signature

const argv: any

#{ inputs, write, force, help, version, dryRun, check, checkDrift, lint, fix, coverageBadge }

line 90

const { inputs, write, force, help, version, dryRun, check, checkDrift, lint, fix, coverageBadge }: any

const

Signature

const { inputs, write, force, help, version, dryRun, check, checkDrift, lint, fix, coverageBadge }: any

#files

line 109

let files: Array

var

Signature

let files: Array

#{ extractModule }

line 127

const { extractModule }: any

const

Signature

const { extractModule }: any

#{ detectDrift }

line 128

const { detectDrift }: any

const

Signature

const { detectDrift }: any

#{ lintModule }

line 129

const { lintModule }: any

const

Signature

const { lintModule }: any

#{ fixModule }

line 130

const { fixModule }: any

const

Signature

const { fixModule }: any

#driftTotal

line 135

let driftTotal: number

var

Signature

let driftTotal: number

#lintTotal

line 136

let lintTotal: number

var

Signature

let lintTotal: number

#fixedTotal

line 137

let fixedTotal: number

var

Signature

let fixedTotal: number

#filesFixed

line 138

let filesFixed: number

var

Signature

let filesFixed: number

#failedTotal

line 139

let failedTotal: number

var

Signature

let failedTotal: number

#moduleData

line 143

let moduleData: any

var

Signature

let moduleData: any

#issues

line 151

const issues: any

const

Signature

const issues: any

#loc

line 155

const loc: any

const

Signature

const loc: any

#detail

line 156

const detail: any

const

Signature

const detail: any

#result

line 168

let result: any

var

Signature

let result: any

#loc

line 184

const loc: any

const

Signature

const loc: any

#moduleData

line 190

let moduleData: any

var

Signature

let moduleData: any

#issues

line 198

const issues: any

const

Signature

const issues: any

#loc

line 202

const loc: any

const

Signature

const loc: any

#{ aggregateCoverage, renderBadgeSvg }

line 232

const { aggregateCoverage, renderBadgeSvg }: any

const

Signature

const { aggregateCoverage, renderBadgeSvg }: any

#fileResults

line 233

const fileResults: Array

const

Signature

const fileResults: Array

#failedTotal

line 234

let failedTotal: number

var

Signature

let failedTotal: number

#agg

line 243

const agg: any

const

Signature

const agg: any

#svgPath

line 245

const svgPath: any

const

Signature

const svgPath: any

#jsonPath

line 246

const jsonPath: any

const

Signature

const jsonPath: any

#{ aggregateCoverage }

line 266

const { aggregateCoverage }: any

const

Signature

const { aggregateCoverage }: any

#fileResults

line 267

const fileResults: Array

const

Signature

const fileResults: Array

#failedTotal

line 268

let failedTotal: number

var

Signature

let failedTotal: number

#stats

line 271

const stats: any

const

Signature

const stats: any

#agg

line 282

const agg: any

const

Signature

const agg: any

#{ documented: documentedSymbols, total: totalSymbols, undocumented: undocumentedSymbols, pct }

line 283

const { documented: documentedSymbols, total: totalSymbols, undocumented: undocumentedSymbols, pct }: any

const

Signature

const { documented: documentedSymbols, total: totalSymbols, undocumented: undocumentedSymbols, pct }: any

#totalBlocks

line 304

let totalBlocks: number

var

Signature

let totalBlocks: number

#touchedFiles

line 305

let touchedFiles: number

var

Signature

let touchedFiles: number

#failedTotal

line 306

let failedTotal: number

var

Signature

let failedTotal: number

#count

line 309

const count: any

const

Signature

const count: any