Module "pack/node/inspection/npmAudit"

Index

Interfaces

Variables

npmAuditReviewCategory

Functions

Object literals

NpmAuditAutoInspectRegistration

Variables

Const npmAuditReviewCategory

npmAuditReviewCategory: "npm audit" = "npm audit"

Functions

mapNpmAuditResultsToReviewComments

mapNpmAuditResultsToReviewComments(npmAuditOutput: string): ReviewComment[]

- Defined in lib/pack/node/inspection/npmAudit.ts:57
Parameters
- npmAuditOutput: string
Returns ReviewComment[]

npmAuditInspection

npmAuditInspection(options?: NpmAuditOptions): CodeInspectionRegistration<ProjectReview, NoParameters>

- Defined in lib/pack/node/inspection/npmAudit.ts:140
Provide a code inspection that runs npm audit and returns a ProjectReview.

Parameters
- Default value options: NpmAuditOptions = DefaultNpmAuditOptions
Returns CodeInspectionRegistration<ProjectReview, NoParameters>

npmAuditReviewComment

npmAuditReviewComment(detail: string, rule: string, severity?: Severity): ReviewComment

- Defined in lib/pack/node/inspection/npmAudit.ts:48
Parameters
- detail: string
- rule: string
- Default value severity: Severity = "info"
Returns ReviewComment

runNpmAuditOnProject

runNpmAuditOnProject(options?: NpmAuditOptions): CodeInspection<ProjectReview, NoParameters>

- Defined in lib/pack/node/inspection/npmAudit.ts:103
Parameters
- Default value options: NpmAuditOptions = DefaultNpmAuditOptions
Returns CodeInspection<ProjectReview, NoParameters>

Object literals

Const NpmAuditAutoInspectRegistration

NpmAuditAutoInspectRegistration: object

Provide an auto inspect registration that runs npm audit and returns a ProjectReview.

inspection

inspection: CodeInspection<ProjectReview, NoParameters> = runNpmAuditOnProject()

name

name: string = "NpmAuditAutoInspection"

pushTest

pushTest: PredicatePushTest = IsNode

Generated using TypeDoc