crytic_compile.utils.npm

 1"""
 2Module handling NPM related features
 3"""
 4import json
 5from pathlib import Path
 6from typing import TYPE_CHECKING, Optional, Union, Dict
 7
 8# Cycle dependency
 9if TYPE_CHECKING:
10    from crytic_compile.platform.solc_standard_json import SolcStandardJson
11
12
13def get_package_name(target_txt: Union[str, "SolcStandardJson"]) -> Optional[str]:
14    """Return the npm package's name
15
16    Args:
17        target_txt (Union[str,SolcStandardJson): path to the target
18
19    Returns:
20        Optional[str]: npm package name
21    """
22
23    # Verify the target path is a string (exported zip archives are lists)
24    if not isinstance(target_txt, str):
25        return None
26
27    # Obtain the path the target string represents
28    try:
29        target = Path(target_txt)
30        if target.is_dir():
31            package = Path(target, "package.json")
32            if package.exists():
33                with open(package, "r", encoding="utf8") as file_desc:
34                    try:
35                        package_dict: Dict[str, str] = json.load(file_desc)
36                        return package_dict.get("name", None)
37                    except json.JSONDecodeError:
38                        return None
39        return None
40
41    except (OSError, ValueError):
42        # Can happen if the target is a very large string, is_dir will throw an exception
43        return None