VL016#

class src.ansys.pre_commit_hooks.quality_rules.vale.VL016#

Bases: Vale

The Vale styles .gitignore preserves configured vocabulary files.

Overview#

check

Check the ignore patterns of /.gitignore.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.vale import VL016

Method detail#

static VL016.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#

Check the ignore patterns of /.gitignore.

Returns:
bool or str

True when the file contains a complete supported pattern set, otherwise a "WARNING: ..." message naming missing patterns.