External module "lib/slocCommand"

Index

Functions

Object literals

SlocCommand

Functions

Const SlocInspection

SlocInspection(p: Project, ci: SdmContext): Promise<LanguagesReport>

- Defined in lib/slocCommand.ts:40
Inspection that reports on languages used in a project

Parameters
- p: Project
- ci: SdmContext
Returns Promise<LanguagesReport>

formatLanguageReport

formatLanguageReport(report: LanguageReport): string

- Defined in lib/slocCommand.ts:87
Parameters
- report: LanguageReport
Returns string

formatLanguageStats

formatLanguageStats(report: LanguageStats): string

- Defined in lib/slocCommand.ts:92
Parameters
- report: LanguageStats
Returns string

reportForProject

reportForProject(result: CodeInspectionResult<LanguagesReport>): string

- Defined in lib/slocCommand.ts:82
Format a string for the report for the project

Parameters
- result: CodeInspectionResult<LanguagesReport>
Returns string

Object literals

Const SlocCommand

SlocCommand: object

Command to display lines of code in current project or projects to Slack, across understood languages. Also displays aggregate data.

inspection

inspection: function = SlocInspection

Type declaration

- (p: Project, papi: PushAwareParametersInvocation<P>): Promise<R>
- Parameters
  - p: Project
  - papi: PushAwareParametersInvocation<P>
  Returns Promise<R>

intent

intent: string[] = ["compute sloc", "sloc"]

name

name: string = "sloc"

onInspectionResults

onInspectionResults(results: CodeInspectionResult<LanguagesReport>[], ci: CommandListenerInvocation<NoParameters>): Promise<void>

- Defined in lib/slocCommand.ts:55
Parameters
- results: CodeInspectionResult<LanguagesReport>[]
- ci: CommandListenerInvocation<NoParameters>
Returns Promise<void>

Generated using TypeDoc