Global

Methods

dev()

Simple script to automate routine dev functions. Should be updated accordingly.
Source:

main(args)

Serves as the main entry point to the HubListener CLI app
Parameters:
Name Type Description
args Array.<string> The un-parsed array of command-line arguments
Source:

updatedDoc()

Simple function to run JSDoc on a file or directory. Prints err, stdout, stderr to console.
Source:

Type Definitions

CloneOptions

Repository Cloning options
Type:
  • object
Properties:
Name Type Attributes Default Description
root string <optional>
 path.join(__dirname, 'repos') the root of the path to clone to
clonePath string <optional>
 '' the relative path to clone the repository to
Source:

commitActionFunction(commit, index)

Parameters:
Name Type Description
commit Commit The commit it's applied to.
index number The index of the commit, 1-based.
Source:
Returns:
T - The return value.

commitCatcherFunction(commit, error, index)

Parameters:
Name Type Description
commit Commit The commit it was applied to.
error Error The error thrown.
index number The index of the commit it was applied to, 1 - based.
Source:
Returns:
T - The return value.

CommitInfo

The information for a Git commit
Type:
  • object
Properties:
Name Type Description
commit_id string The id of the commit
commit_date string The date of the commit
Source:

CommitPeriodCount

Count of commits in period
Type:
  • object
Properties:
Name Type Description
start Date The start of the counting period
end Date The end of the counting period
count number The number of commits in the period
Source:

ExtensionSummary

A summary of a file extension
Type:
  • object
Properties:
Name Type Description
numberOfFiles number The number of files with that extension
numberOfLines number The lines of code with that extension
Source:

GenericAnalysisReport

Summary for a generic file extension
Type:
  • object
Properties:
Name Type Description
numberOfFiles number The number of files with the extension
numberOfLines number The total number of physical lines with the extension
Source:

IssueInfo

The information for a GitHub issue
Type:
  • object
Properties:
Name Type Description
state string The state of the issue, i.e. OPEN or CLOSED
createdAt Date The date the issue was created at
closedAt Date The date the issue was closed at, `null` if not closed
Source:

IssuesCount

The count of GitHub issues by state
Type:
  • object
Properties:
Name Type Description
totalIssues number The total number of GitHub issues
openIssues number The number of open GitHub issues
closedIssues number The number of closed GitHub issues
Source:

JsAnalysisReport

Static Analysis report for Javascript code
Type:
  • object
Properties:
Name Type Description
numberOfFiles number
numberOfLines number
numberOfLogicalLines number
numberOfComments number
cyclomaticComplexity number
maintabilityIndex number
halsteadEffort number
halsteadBugs number
halsteadLength number
halsteadDifficulty number
halsteadTime number
halsteadVocabulary number
halsteadVolume number
Source:

keyFunction(row) → {string}

A function to get a unique identifier for a Point from a Row. Used to index points.
Parameters:
Name Type Description
row Row The row to get the unique identifier from.
Source:
Returns:
The unique identifier
Type
string

Point

A point-like object to be processed the the front-end graphs library
Type:
  • object
Properties:
Name Type Description
repo_id number The id of the repository
commit_id string The id of the commit
commit_date Date The date of the commit
file_extension string The file extension
metric_type* number The value of metric of type `metric_type`, these properties are dynamically generated and can differ for each point. Possibilities are subsets of the values in the MetricTypes table. See schema.sql for details.
Source:

ProjectInfo

Information about the GitHub project
Type:
  • object
Properties:
Name Type Description
owner string The GitHub username of the project owner
name string The name of the project
Source:

PyAnalysisReport

Static Analysis report for Python code
Type:
  • object
Properties:
Name Type Description
numberOfFiles number
numberOfLines number
numberOfLogicalLines number
numberOfComments number
cyclomaticComplexity number
maintabilityIndex number
halsteadEffort number
halsteadBugs number
halsteadLength number
halsteadDifficulty number
halsteadTime number
halsteadVocabulary number
halsteadVolume number
Source:

Row

A row-like object outputted by a database query
Type:
  • object
Properties:
Name Type Description
repo_id number The id of the repository
commit_id string The id of the commit
commit_date Date The date of the commit
file_extension string The file extension
metric_type string The name of the metric
metric_value string The value of the metric
Source:

stepperFunction(curr) → {T}

Parameters:
Name Type Description
curr T The current value
Source:
Returns:
next - The next value
Type
T

stopperFunction(curr) → {boolean}

Parameters:
Name Type Description
curr T The current value
Source:
Returns:
stop - Whether to stop generation or not
Type
boolean

WriteToFileOptions

Configuration options for writing to a file
Properties:
Name Type Attributes Default Description
dirname string <optional>
 __dirname the name of the directory of the output file, defaults to current directory.
append boolean <optional>
 false flag to determine if should append (true) or overwrite (false) if file already exists.
indentaion number <optional>
 4 the indentation level for the JSON file.
Source: