check_markdown_links.py File Reference

Go to the source code of this file.

Namespaces
namespace	check_markdown_links

Functions
argparse.Namespace	check_markdown_links.parse_args ()
	Parse command-line arguments.
list[Path]|None	check_markdown_links.git_markdown (Path repo_root)
	List tracked plus non-ignored untracked Markdown files, so the scan set is reproducible for a given commit regardless of local build or scratch output.
	check_markdown_links.iter_markdown_files (Path repo_root, bool include_readme)
	Yield every repository Markdown file the current commit would carry.
bool	check_markdown_links.should_skip_link (str target)
	Perform should skip link.
str	check_markdown_links.normalize_target (str raw_target)
	Remove Markdown angle brackets, fragments, and query strings before resolving a link target.
int	check_markdown_links.main ()
	Entry point for this script.

Variables
	check_markdown_links.LINK_PATTERN = re.compile(r"!\[[^\]]*\]\‍(([^)\s]+)(?:\s+\"[^\"]*\")?\‍)|\[[^\]]*\]\‍(([^)\s]+)(?:\s+\"[^\"]*\")?\‍)")
dict	check_markdown_links.SKIP_DIRS = {".git", "docs_build", "obj", "bin", "stubs", "runs", "studies", "__pycache__", ".pytest_cache"}