|
| 1 | +import re |
| 2 | +from typing import Any |
| 3 | + |
| 4 | +from typing_extensions import override |
| 5 | + |
| 6 | +from twyn.dependency_parser.parsers.abstract_parser import AbstractParser |
| 7 | +from twyn.dependency_parser.parsers.constants import PNPM_LOCK_YAML |
| 8 | + |
| 9 | + |
| 10 | +class PnpmLockParser(AbstractParser): |
| 11 | + """Parser for pnpm-lock.yaml dependencies.""" |
| 12 | + |
| 13 | + _SCOPED_PACKAGE_PATTERN = re.compile(r"^(@[^@]+/[^@]+)@") |
| 14 | + _REGULAR_PACKAGE_PATTERN = re.compile(r"^([^@]+)@") |
| 15 | + _PACKAGE_NAME_VALIDATION_PATTERN = re.compile(r"^(@[a-zA-Z0-9_.-]+\/)?[a-zA-Z0-9_.-]+$") |
| 16 | + |
| 17 | + def __init__(self, file_path: str = PNPM_LOCK_YAML) -> None: |
| 18 | + super().__init__(file_path) |
| 19 | + |
| 20 | + @override |
| 21 | + def parse(self) -> set[str]: |
| 22 | + """Parse pnpm-lock.yaml file and extract package names.""" |
| 23 | + import yaml # noqa: PLC0415 |
| 24 | + |
| 25 | + content = self.file_handler.read() |
| 26 | + try: |
| 27 | + data = yaml.safe_load(content) |
| 28 | + except yaml.YAMLError as e: |
| 29 | + raise ValueError(f"Invalid YAML in pnpm-lock.yaml: {e}") from e |
| 30 | + |
| 31 | + if not isinstance(data, dict): |
| 32 | + return set() |
| 33 | + |
| 34 | + packages: set[str] = set() |
| 35 | + |
| 36 | + # Parse root-level dependencies (if any) |
| 37 | + self._extract_from_pnpm_dependencies(data.get("dependencies", {}), packages) |
| 38 | + self._extract_from_pnpm_dependencies(data.get("devDependencies", {}), packages) |
| 39 | + self._extract_from_pnpm_dependencies(data.get("optionalDependencies", {}), packages) |
| 40 | + |
| 41 | + # Parse packages section (all resolved packages) |
| 42 | + self._extract_from_packages(data.get("packages", {}), packages) |
| 43 | + |
| 44 | + # Parse importers section (workspace packages) |
| 45 | + importers = data.get("importers", {}) |
| 46 | + if isinstance(importers, dict): |
| 47 | + for importer_data in importers.values(): |
| 48 | + if isinstance(importer_data, dict): |
| 49 | + self._extract_from_pnpm_dependencies(importer_data.get("dependencies", {}), packages) |
| 50 | + self._extract_from_pnpm_dependencies(importer_data.get("devDependencies", {}), packages) |
| 51 | + self._extract_from_pnpm_dependencies(importer_data.get("optionalDependencies", {}), packages) |
| 52 | + |
| 53 | + return packages |
| 54 | + |
| 55 | + def _extract_from_pnpm_dependencies(self, deps: dict[str, Any], packages: set[str]) -> None: |
| 56 | + """Extract package names from pnpm-lock.yaml dependencies section. |
| 57 | +
|
| 58 | + In pnpm-lock.yaml, dependencies have the format: |
| 59 | + { |
| 60 | + "package-name": { |
| 61 | + "specifier": "^1.0.0", |
| 62 | + "version": "1.0.0" |
| 63 | + } |
| 64 | + } |
| 65 | + """ |
| 66 | + if not isinstance(deps, dict): |
| 67 | + return |
| 68 | + |
| 69 | + for dep_name, _dep_info in deps.items(): |
| 70 | + if isinstance(dep_name, str): |
| 71 | + # Handle scoped packages (@scope/package) |
| 72 | + normalized_name = self._normalize_package_name(dep_name) |
| 73 | + if normalized_name: |
| 74 | + packages.add(normalized_name) |
| 75 | + |
| 76 | + def _extract_from_packages(self, packages_section: dict[str, Any], packages: set[str]) -> None: |
| 77 | + """Extract package names from packages section. |
| 78 | +
|
| 79 | + In pnpm-lock.yaml v9+, package keys are in the format: |
| 80 | + |
| 81 | + |
| 82 | + """ |
| 83 | + if not isinstance(packages_section, dict): |
| 84 | + return |
| 85 | + |
| 86 | + for package_key in packages_section: |
| 87 | + if isinstance(package_key, str): |
| 88 | + # Package keys are in format: package@version or @scope/package@version |
| 89 | + package_name = self._extract_package_name_from_key(package_key) |
| 90 | + if package_name: |
| 91 | + normalized_name = self._normalize_package_name(package_name) |
| 92 | + if normalized_name: |
| 93 | + packages.add(normalized_name) |
| 94 | + |
| 95 | + def _extract_package_name_from_key(self, package_key: str) -> str | None: |
| 96 | + """Extract package name from package key. |
| 97 | +
|
| 98 | + In pnpm-lock.yaml v9+, package keys are in formats like: |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | +
|
| 103 | + """ |
| 104 | + if not package_key: |
| 105 | + return None |
| 106 | + |
| 107 | + # Handle scoped packages (@scope/package@version) |
| 108 | + if package_key.startswith("@"): |
| 109 | + # Pattern: @scope/package@version or @scope/package@version_peer-deps |
| 110 | + match = self._SCOPED_PACKAGE_PATTERN.match(package_key) |
| 111 | + if match: |
| 112 | + return match.group(1) |
| 113 | + else: |
| 114 | + # Pattern: package@version or package@version_peer-deps |
| 115 | + match = self._REGULAR_PACKAGE_PATTERN.match(package_key) |
| 116 | + if match: |
| 117 | + return match.group(1) |
| 118 | + |
| 119 | + return None |
| 120 | + |
| 121 | + def _normalize_package_name(self, name: str) -> str | None: |
| 122 | + """Normalize package name by removing invalid characters.""" |
| 123 | + if not name or not isinstance(name, str): |
| 124 | + return None |
| 125 | + |
| 126 | + # Remove any trailing whitespace and validate |
| 127 | + normalized = name.strip() |
| 128 | + |
| 129 | + # Basic validation for npm package names |
| 130 | + if not normalized or len(normalized) > 214: |
| 131 | + return None |
| 132 | + |
| 133 | + # Check for valid npm package name characters |
| 134 | + # Allow letters, numbers, hyphens, underscores, dots, and scoped packages |
| 135 | + if not self._PACKAGE_NAME_VALIDATION_PATTERN.match(normalized): |
| 136 | + return None |
| 137 | + |
| 138 | + return normalized |
0 commit comments