PreCommitAnalyzer

class neophile.analysis.pre_commit.PreCommitAnalyzer(scanner: PreCommitScanner, inventory: GitHubInventory)

Bases: neophile.analysis.base.BaseAnalyzer

Analyze a tree for needed pre-commit hook updates.

Parameters

Methods Summary

analyze([update])

Analyze a tree and return a list of needed pre-commit hook changes.

name()

The name of the analyzer type.

Methods Documentation

async analyze(update: bool = False) List[Update]

Analyze a tree and return a list of needed pre-commit hook changes.

Parameters

update (bool, optional) – Ignored for this analyzer.

Returns

results – A list of updates.

Return type

List[neophile.update.base.Update]

name() str

The name of the analyzer type.

Returns

name – A string representing the type of analyzer this is. Used for reporting results accumulated from a bunch of analyzers.

Return type

str