Coverage for src / python_commitlint / __init__.py: 100%

1"""python-commitlint — pure-Python validator for Conventional Commits. 

2 

3This package exposes the public API for linting commit messages and for 

4converting legacy ``commitlint.config.js`` files into ``.commitlintrc.yaml``. 

5 

6Most users only need: 

7 

8- :class:`CommitLinterFactory` to construct a linter (with optional config path) 

9- :class:`LintResult` and :class:`ValidationError` for inspecting results 

10- :class:`CommitMessage` if writing custom rules or callbacks 

11- :class:`ConfigurationError` to handle config-loading failures 

12- :func:`convert_js_to_yaml` for one-shot JS-to-YAML config conversion 

13""" 

14 

15from python_commitlint.config.converter import ( 

16 CommitlintConfigConverter, 

17 convert_js_to_yaml, 

18) 

19from python_commitlint.core.exceptions import ConfigurationError 

20from python_commitlint.core.models import ( 

21 CommitMessage, 

22 LintResult, 

23 ValidationError, 

24) 

25from python_commitlint.linter import CommitLinterFactory 

26 

27__all__ = [ 

28 "CommitLinterFactory", 

29 "CommitMessage", 

30 "CommitlintConfigConverter", 

31 "ConfigurationError", 

32 "LintResult", 

33 "ValidationError", 

34 "convert_js_to_yaml", 

35]