PreCommitScanner

class neophile.scanner.pre_commit.PreCommitScanner(root: Path)

Bases: neophile.scanner.base.BaseScanner

Scan a source tree for pre-commit hook version references.

Parameters

root (pathlib.Path) – The root of the source tree.

Methods Summary

name()	The name of the scanner type.
scan()	Scan a source tree for pre-commit hook version references.

Methods Documentation

name() → str

The name of the scanner type.

Returns

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

Return type

str

scan() → List[PreCommitDependency]

Scan a source tree for pre-commit hook version references.

Returns

results – A list of all discovered pre-commit dependencies.

Return type

List[neophile.dependency.pre_commit.PreCommitDependency]