Source code for flexlate_dev.ignore

import os.path
from dataclasses import dataclass, field
from pathlib import Path
from typing import Callable, Final, List, Union

from pathspec import PathSpec

ALWAYS_IGNORE: Final[List[str]] = [".git/"]


@dataclass
class IgnoreSpecification:
    ignore_list: List[str]
    _ignore_matches: Callable[[Union[str, Path]], bool] = field(init=False)

    def __post_init__(self):
        self._ignore_matches = self._build_ignore_matches()

    @property
    def all_ignores(self) -> List[str]:
        return [*ALWAYS_IGNORE, *self.ignore_list]

    def _build_ignore_matches(self) -> Callable[[str], bool]:
        return parse_gitignore_list_into_matcher(self.all_ignores)

    def file_is_ignored(self, file_path: Union[str, Path]) -> bool:
        return self._ignore_matches(file_path)


def parse_gitignore_list_into_matcher(
    gitignore_list: List[str],
) -> Callable[[Union[str, Path]], bool]:
    spec = PathSpec.from_lines("gitwildmatch", gitignore_list)

    def matcher(file_path: Union[str, Path]) -> bool:
        """
        Adjust the base_matcher from pathspec gitwildmatch so that passed
        directories end in a trailing slash.
        """
        path = Path(file_path)
        if path.is_dir():
            match_path = str(path) + os.path.sep
        else:
            match_path = str(path)
        return spec.match_file(match_path)

    return matcher