File size: 110,261 Bytes
87a4202 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 | /**
* Plugin Loader Module
*
* This module is responsible for discovering, loading, and validating Claude Code plugins
* from various sources including marketplaces and git repositories.
*
* NPM packages are also supported but must be referenced through marketplaces - the marketplace
* entry contains the NPM package information.
*
* Plugin Discovery Sources (in order of precedence):
* 1. Marketplace-based plugins (plugin@marketplace format in settings)
* 2. Session-only plugins (from --plugin-dir CLI flag or SDK plugins option)
*
* Plugin Directory Structure:
* ```
* my-plugin/
* βββ plugin.json # Optional manifest with metadata
* βββ commands/ # Custom slash commands
* β βββ build.md
* β βββ deploy.md
* βββ agents/ # Custom AI agents
* β βββ test-runner.md
* βββ hooks/ # Hook configurations
* βββ hooks.json # Hook definitions
* ```
*
* The loader handles:
* - Plugin manifest validation
* - Hooks configuration loading and variable resolution
* - Duplicate name detection
* - Enable/disable state management
* - Error collection and reporting
*/
import {
copyFile,
readdir,
readFile,
readlink,
realpath,
rename,
rm,
rmdir,
stat,
symlink,
} from 'fs/promises'
import memoize from 'lodash-es/memoize.js'
import { basename, dirname, join, relative, resolve, sep } from 'path'
import { getInlinePlugins } from '../../bootstrap/state.js'
import {
BUILTIN_MARKETPLACE_NAME,
getBuiltinPlugins,
} from '../../plugins/builtinPlugins.js'
import type {
LoadedPlugin,
PluginComponent,
PluginError,
PluginLoadResult,
PluginManifest,
} from '../../types/plugin.js'
import { logForDebugging } from '../debug.js'
import { isEnvTruthy } from '../envUtils.js'
import {
errorMessage,
getErrnoPath,
isENOENT,
isFsInaccessible,
toError,
} from '../errors.js'
import { execFileNoThrow, execFileNoThrowWithCwd } from '../execFileNoThrow.js'
import { pathExists } from '../file.js'
import { getFsImplementation } from '../fsOperations.js'
import { gitExe } from '../git.js'
import { lazySchema } from '../lazySchema.js'
import { logError } from '../log.js'
import { getSettings_DEPRECATED } from '../settings/settings.js'
import {
clearPluginSettingsBase,
getPluginSettingsBase,
resetSettingsCache,
setPluginSettingsBase,
} from '../settings/settingsCache.js'
import type { HooksSettings } from '../settings/types.js'
import { SettingsSchema } from '../settings/types.js'
import { jsonParse, jsonStringify } from '../slowOperations.js'
import { getAddDirEnabledPlugins } from './addDirPluginSettings.js'
import { verifyAndDemote } from './dependencyResolver.js'
import { classifyFetchError, logPluginFetch } from './fetchTelemetry.js'
import { checkGitAvailable } from './gitAvailability.js'
import { getInMemoryInstalledPlugins } from './installedPluginsManager.js'
import { getManagedPluginNames } from './managedPlugins.js'
import {
formatSourceForDisplay,
getBlockedMarketplaces,
getStrictKnownMarketplaces,
isSourceAllowedByPolicy,
isSourceInBlocklist,
} from './marketplaceHelpers.js'
import {
getMarketplaceCacheOnly,
getPluginByIdCacheOnly,
loadKnownMarketplacesConfigSafe,
} from './marketplaceManager.js'
import { getPluginSeedDirs, getPluginsDirectory } from './pluginDirectories.js'
import { parsePluginIdentifier } from './pluginIdentifier.js'
import { validatePathWithinBase } from './pluginInstallationHelpers.js'
import { calculatePluginVersion } from './pluginVersioning.js'
import {
type CommandMetadata,
PluginHooksSchema,
PluginIdSchema,
PluginManifestSchema,
type PluginMarketplaceEntry,
type PluginSource,
} from './schemas.js'
import {
convertDirectoryToZipInPlace,
extractZipToDirectory,
getSessionPluginCachePath,
isPluginZipCacheEnabled,
} from './zipCache.js'
/**
* Get the path where plugin cache is stored
*/
export function getPluginCachePath(): string {
return join(getPluginsDirectory(), 'cache')
}
/**
* Compute the versioned cache path under a specific base plugins directory.
* Used to probe both primary and seed caches.
*
* @param baseDir - Base plugins directory (e.g. getPluginsDirectory() or seed dir)
* @param pluginId - Plugin identifier in format "name@marketplace"
* @param version - Version string (semver, git SHA, etc.)
* @returns Absolute path to versioned plugin directory under baseDir
*/
export function getVersionedCachePathIn(
baseDir: string,
pluginId: string,
version: string,
): string {
const { name: pluginName, marketplace } = parsePluginIdentifier(pluginId)
const sanitizedMarketplace = (marketplace || 'unknown').replace(
/[^a-zA-Z0-9\-_]/g,
'-',
)
const sanitizedPlugin = (pluginName || pluginId).replace(
/[^a-zA-Z0-9\-_]/g,
'-',
)
// Sanitize version to prevent path traversal attacks
const sanitizedVersion = version.replace(/[^a-zA-Z0-9\-_.]/g, '-')
return join(
baseDir,
'cache',
sanitizedMarketplace,
sanitizedPlugin,
sanitizedVersion,
)
}
/**
* Get versioned cache path for a plugin under the primary plugins directory.
* Format: ~/.claude/plugins/cache/{marketplace}/{plugin}/{version}/
*
* @param pluginId - Plugin identifier in format "name@marketplace"
* @param version - Version string (semver, git SHA, etc.)
* @returns Absolute path to versioned plugin directory
*/
export function getVersionedCachePath(
pluginId: string,
version: string,
): string {
return getVersionedCachePathIn(getPluginsDirectory(), pluginId, version)
}
/**
* Get versioned ZIP cache path for a plugin.
* This is the zip cache variant of getVersionedCachePath.
*/
export function getVersionedZipCachePath(
pluginId: string,
version: string,
): string {
return `${getVersionedCachePath(pluginId, version)}.zip`
}
/**
* Probe seed directories for a populated cache at this plugin version.
* Seeds are checked in precedence order; first hit wins. Returns null if no
* seed is configured or none contains a populated directory at this version.
*/
async function probeSeedCache(
pluginId: string,
version: string,
): Promise<string | null> {
for (const seedDir of getPluginSeedDirs()) {
const seedPath = getVersionedCachePathIn(seedDir, pluginId, version)
try {
const entries = await readdir(seedPath)
if (entries.length > 0) return seedPath
} catch {
// Try next seed
}
}
return null
}
/**
* When the computed version is 'unknown', probe seed/cache/<m>/<p>/ for an
* actual version dir. Handles the first-boot chicken-and-egg where the
* version can only be known after cloning, but seed already has the clone.
*
* Per seed, only matches when exactly one version exists (typical BYOC case).
* Multiple versions within a single seed β ambiguous β try next seed.
* Seeds are checked in precedence order; first match wins.
*/
export async function probeSeedCacheAnyVersion(
pluginId: string,
): Promise<string | null> {
for (const seedDir of getPluginSeedDirs()) {
// The parent of the version dir β computed the same way as
// getVersionedCachePathIn, just without the version component.
const pluginDir = dirname(getVersionedCachePathIn(seedDir, pluginId, '_'))
try {
const versions = await readdir(pluginDir)
if (versions.length !== 1) continue
const versionDir = join(pluginDir, versions[0]!)
const entries = await readdir(versionDir)
if (entries.length > 0) return versionDir
} catch {
// Try next seed
}
}
return null
}
/**
* Get legacy (non-versioned) cache path for a plugin.
* Format: ~/.claude/plugins/cache/{plugin-name}/
*
* Used for backward compatibility with existing installations.
*
* @param pluginName - Plugin name (without marketplace suffix)
* @returns Absolute path to legacy plugin directory
*/
export function getLegacyCachePath(pluginName: string): string {
const cachePath = getPluginCachePath()
return join(cachePath, pluginName.replace(/[^a-zA-Z0-9\-_]/g, '-'))
}
/**
* Resolve plugin path with fallback to legacy location.
*
* Always:
* 1. Try versioned path first if version is provided
* 2. Fall back to legacy path for existing installations
* 3. Return versioned path for new installations
*
* @param pluginId - Plugin identifier in format "name@marketplace"
* @param version - Optional version string
* @returns Absolute path to plugin directory
*/
export async function resolvePluginPath(
pluginId: string,
version?: string,
): Promise<string> {
// Try versioned path first
if (version) {
const versionedPath = getVersionedCachePath(pluginId, version)
if (await pathExists(versionedPath)) {
return versionedPath
}
}
// Fall back to legacy path for existing installations
const pluginName = parsePluginIdentifier(pluginId).name || pluginId
const legacyPath = getLegacyCachePath(pluginName)
if (await pathExists(legacyPath)) {
return legacyPath
}
// Return versioned path for new installations
return version ? getVersionedCachePath(pluginId, version) : legacyPath
}
/**
* Recursively copy a directory.
* Exported for testing purposes.
*/
export async function copyDir(src: string, dest: string): Promise<void> {
await getFsImplementation().mkdir(dest)
const entries = await readdir(src, { withFileTypes: true })
for (const entry of entries) {
const srcPath = join(src, entry.name)
const destPath = join(dest, entry.name)
if (entry.isDirectory()) {
await copyDir(srcPath, destPath)
} else if (entry.isFile()) {
await copyFile(srcPath, destPath)
} else if (entry.isSymbolicLink()) {
const linkTarget = await readlink(srcPath)
// Resolve the symlink to get the actual target path
// This prevents circular symlinks when src and dest overlap (e.g., via symlink chains)
let resolvedTarget: string
try {
resolvedTarget = await realpath(srcPath)
} catch {
// Broken symlink - copy the raw link target as-is
await symlink(linkTarget, destPath)
continue
}
// Resolve the source directory to handle symlinked source dirs
let resolvedSrc: string
try {
resolvedSrc = await realpath(src)
} catch {
resolvedSrc = src
}
// Check if target is within the source tree (using proper path prefix matching)
const srcPrefix = resolvedSrc.endsWith(sep)
? resolvedSrc
: resolvedSrc + sep
if (
resolvedTarget.startsWith(srcPrefix) ||
resolvedTarget === resolvedSrc
) {
// Target is within source tree - create relative symlink that preserves
// the same structure in the destination
const targetRelativeToSrc = relative(resolvedSrc, resolvedTarget)
const destTargetPath = join(dest, targetRelativeToSrc)
const relativeLinkPath = relative(dirname(destPath), destTargetPath)
await symlink(relativeLinkPath, destPath)
} else {
// Target is outside source tree - use absolute resolved path
await symlink(resolvedTarget, destPath)
}
}
}
}
/**
* Copy plugin files to versioned cache directory.
*
* For local plugins: Uses entry.source from marketplace.json as the single source of truth.
* For remote plugins: Falls back to copying sourcePath (the downloaded content).
*
* @param sourcePath - Path to the plugin source (used as fallback for remote plugins)
* @param pluginId - Plugin identifier in format "name@marketplace"
* @param version - Version string for versioned path
* @param entry - Optional marketplace entry containing the source field
* @param marketplaceDir - Marketplace directory for resolving entry.source (undefined for remote plugins)
* @returns Path to the cached plugin directory
* @throws Error if the source directory is not found
* @throws Error if the destination directory is empty after copy
*/
export async function copyPluginToVersionedCache(
sourcePath: string,
pluginId: string,
version: string,
entry?: PluginMarketplaceEntry,
marketplaceDir?: string,
): Promise<string> {
// When zip cache is enabled, the canonical format is a ZIP file
const zipCacheMode = isPluginZipCacheEnabled()
const cachePath = getVersionedCachePath(pluginId, version)
const zipPath = getVersionedZipCachePath(pluginId, version)
// If cache already exists (directory or ZIP), return it
if (zipCacheMode) {
if (await pathExists(zipPath)) {
logForDebugging(
`Plugin ${pluginId} version ${version} already cached at ${zipPath}`,
)
return zipPath
}
} else if (await pathExists(cachePath)) {
const entries = await readdir(cachePath)
if (entries.length > 0) {
logForDebugging(
`Plugin ${pluginId} version ${version} already cached at ${cachePath}`,
)
return cachePath
}
// Directory exists but is empty, remove it so we can recreate with content
logForDebugging(
`Removing empty cache directory for ${pluginId} at ${cachePath}`,
)
await rmdir(cachePath)
}
// Seed cache hit β return seed path in place (read-only, no copy).
// Callers handle both directory and .zip paths; this returns a directory.
const seedPath = await probeSeedCache(pluginId, version)
if (seedPath) {
logForDebugging(
`Using seed cache for ${pluginId}@${version} at ${seedPath}`,
)
return seedPath
}
// Create parent directories
await getFsImplementation().mkdir(dirname(cachePath))
// For local plugins: copy entry.source directory (the single source of truth)
// For remote plugins: marketplaceDir is undefined, fall back to copying sourcePath
if (entry && typeof entry.source === 'string' && marketplaceDir) {
const sourceDir = validatePathWithinBase(marketplaceDir, entry.source)
logForDebugging(
`Copying source directory ${entry.source} for plugin ${pluginId}`,
)
try {
await copyDir(sourceDir, cachePath)
} catch (e: unknown) {
// Only remap ENOENT from the top-level sourceDir itself β nested ENOENTs
// from recursive copyDir (broken symlinks, raced deletes) should preserve
// their original path in the error.
if (isENOENT(e) && getErrnoPath(e) === sourceDir) {
throw new Error(
`Plugin source directory not found: ${sourceDir} (from entry.source: ${entry.source})`,
)
}
throw e
}
} else {
// Fallback for remote plugins (already downloaded) or plugins without entry.source
logForDebugging(
`Copying plugin ${pluginId} to versioned cache (fallback to full copy)`,
)
await copyDir(sourcePath, cachePath)
}
// Remove .git directory from cache if present
const gitPath = join(cachePath, '.git')
await rm(gitPath, { recursive: true, force: true })
// Validate that cache has content - if empty, throw so fallback can be used
const cacheEntries = await readdir(cachePath)
if (cacheEntries.length === 0) {
throw new Error(
`Failed to copy plugin ${pluginId} to versioned cache: destination is empty after copy`,
)
}
// Zip cache mode: convert directory to ZIP and remove the directory
if (zipCacheMode) {
await convertDirectoryToZipInPlace(cachePath, zipPath)
logForDebugging(
`Successfully cached plugin ${pluginId} as ZIP at ${zipPath}`,
)
return zipPath
}
logForDebugging(`Successfully cached plugin ${pluginId} at ${cachePath}`)
return cachePath
}
/**
* Validate a git URL using Node.js URL parsing
*/
function validateGitUrl(url: string): string {
try {
const parsed = new URL(url)
if (!['https:', 'http:', 'file:'].includes(parsed.protocol)) {
if (!/^git@[a-zA-Z0-9.-]+:/.test(url)) {
throw new Error(
`Invalid git URL protocol: ${parsed.protocol}. Only HTTPS, HTTP, file:// and SSH (git@) URLs are supported.`,
)
}
}
return url
} catch {
if (/^git@[a-zA-Z0-9.-]+:/.test(url)) {
return url
}
throw new Error(`Invalid git URL: ${url}`)
}
}
/**
* Install a plugin from npm using a global cache (exported for testing)
*/
export async function installFromNpm(
packageName: string,
targetPath: string,
options: { registry?: string; version?: string } = {},
): Promise<void> {
const npmCachePath = join(getPluginsDirectory(), 'npm-cache')
await getFsImplementation().mkdir(npmCachePath)
const packageSpec = options.version
? `${packageName}@${options.version}`
: packageName
const packagePath = join(npmCachePath, 'node_modules', packageName)
const needsInstall = !(await pathExists(packagePath))
if (needsInstall) {
logForDebugging(`Installing npm package ${packageSpec} to cache`)
const args = ['install', packageSpec, '--prefix', npmCachePath]
if (options.registry) {
args.push('--registry', options.registry)
}
const result = await execFileNoThrow('npm', args, { useCwd: false })
if (result.code !== 0) {
throw new Error(`Failed to install npm package: ${result.stderr}`)
}
}
await copyDir(packagePath, targetPath)
logForDebugging(
`Copied npm package ${packageName} from cache to ${targetPath}`,
)
}
/**
* Clone a git repository (exported for testing)
*
* @param gitUrl - The git URL to clone
* @param targetPath - Where to clone the repository
* @param ref - Optional branch or tag to checkout
* @param sha - Optional specific commit SHA to checkout
*/
export async function gitClone(
gitUrl: string,
targetPath: string,
ref?: string,
sha?: string,
): Promise<void> {
// Use --recurse-submodules to initialize submodules
// Always start with shallow clone for efficiency
const args = [
'clone',
'--depth',
'1',
'--recurse-submodules',
'--shallow-submodules',
]
// Add --branch flag for specific ref (works for both branches and tags)
if (ref) {
args.push('--branch', ref)
}
// If sha is specified, use --no-checkout since we'll checkout the SHA separately
if (sha) {
args.push('--no-checkout')
}
args.push(gitUrl, targetPath)
const cloneStarted = performance.now()
const cloneResult = await execFileNoThrow(gitExe(), args)
if (cloneResult.code !== 0) {
logPluginFetch(
'plugin_clone',
gitUrl,
'failure',
performance.now() - cloneStarted,
classifyFetchError(cloneResult.stderr),
)
throw new Error(`Failed to clone repository: ${cloneResult.stderr}`)
}
// If sha is specified, fetch and checkout that specific commit
if (sha) {
// Try shallow fetch of the specific SHA first (most efficient)
const shallowFetchResult = await execFileNoThrowWithCwd(
gitExe(),
['fetch', '--depth', '1', 'origin', sha],
{ cwd: targetPath },
)
if (shallowFetchResult.code !== 0) {
// Some servers don't support fetching arbitrary SHAs
// Fall back to unshallow fetch to get full history
logForDebugging(
`Shallow fetch of SHA ${sha} failed, falling back to unshallow fetch`,
)
const unshallowResult = await execFileNoThrowWithCwd(
gitExe(),
['fetch', '--unshallow'],
{ cwd: targetPath },
)
if (unshallowResult.code !== 0) {
logPluginFetch(
'plugin_clone',
gitUrl,
'failure',
performance.now() - cloneStarted,
classifyFetchError(unshallowResult.stderr),
)
throw new Error(
`Failed to fetch commit ${sha}: ${unshallowResult.stderr}`,
)
}
}
// Checkout the specific commit
const checkoutResult = await execFileNoThrowWithCwd(
gitExe(),
['checkout', sha],
{ cwd: targetPath },
)
if (checkoutResult.code !== 0) {
logPluginFetch(
'plugin_clone',
gitUrl,
'failure',
performance.now() - cloneStarted,
classifyFetchError(checkoutResult.stderr),
)
throw new Error(
`Failed to checkout commit ${sha}: ${checkoutResult.stderr}`,
)
}
}
// Fire success only after ALL network ops (clone + optional SHA fetch)
// complete β same telemetry-scope discipline as mcpb and marketplace_url.
logPluginFetch(
'plugin_clone',
gitUrl,
'success',
performance.now() - cloneStarted,
)
}
/**
* Install a plugin from a git URL
*/
async function installFromGit(
gitUrl: string,
targetPath: string,
ref?: string,
sha?: string,
): Promise<void> {
const safeUrl = validateGitUrl(gitUrl)
await gitClone(safeUrl, targetPath, ref, sha)
const refMessage = ref ? ` (ref: ${ref})` : ''
logForDebugging(
`Cloned repository from ${safeUrl}${refMessage} to ${targetPath}`,
)
}
/**
* Install a plugin from GitHub
*/
async function installFromGitHub(
repo: string,
targetPath: string,
ref?: string,
sha?: string,
): Promise<void> {
if (!/^[a-zA-Z0-9-_.]+\/[a-zA-Z0-9-_.]+$/.test(repo)) {
throw new Error(
`Invalid GitHub repository format: ${repo}. Expected format: owner/repo`,
)
}
// Use HTTPS for CCR (no SSH keys), SSH for normal CLI
const gitUrl = isEnvTruthy(process.env.CLAUDE_CODE_REMOTE)
? `https://github.com/${repo}.git`
: `git@github.com:${repo}.git`
return installFromGit(gitUrl, targetPath, ref, sha)
}
/**
* Resolve a git-subdir `url` field to a clonable git URL.
* Accepts GitHub owner/repo shorthand (converted to ssh or https depending on
* CLAUDE_CODE_REMOTE) or any URL that passes validateGitUrl (https, http,
* file, git@ ssh).
*/
function resolveGitSubdirUrl(url: string): string {
if (/^[a-zA-Z0-9-_.]+\/[a-zA-Z0-9-_.]+$/.test(url)) {
return isEnvTruthy(process.env.CLAUDE_CODE_REMOTE)
? `https://github.com/${url}.git`
: `git@github.com:${url}.git`
}
return validateGitUrl(url)
}
/**
* Install a plugin from a subdirectory of a git repository (exported for
* testing).
*
* Uses partial clone (--filter=tree:0) + sparse-checkout so only the tree
* objects along the path and the blobs under it are downloaded. For large
* monorepos this is dramatically cheaper than a full clone β the tree objects
* for a million-file repo can be hundreds of MB, all avoided here.
*
* Sequence:
* 1. clone --depth 1 --filter=tree:0 --no-checkout [--branch ref]
* 2. sparse-checkout set --cone -- <path>
* 3. If sha: fetch --depth 1 origin <sha> (fallback: --unshallow), then
* checkout <sha>. The partial-clone filter is stored in remote config so
* subsequent fetches respect it; --unshallow gets all commits but trees
* and blobs remain lazy.
* If no sha: checkout HEAD (points to ref if --branch was used).
* 4. Move <cloneDir>/<path> to targetPath and discard the clone.
*
* The clone is ephemeral β it goes into a sibling temp directory and is
* removed after the subdir is extracted. targetPath ends up containing only
* the plugin files with no .git directory.
*/
export async function installFromGitSubdir(
url: string,
targetPath: string,
subdirPath: string,
ref?: string,
sha?: string,
): Promise<string | undefined> {
if (!(await checkGitAvailable())) {
throw new Error(
'git-subdir plugin source requires git to be installed and on PATH. ' +
'Install git (version 2.25 or later for sparse-checkout cone mode) and try again.',
)
}
const gitUrl = resolveGitSubdirUrl(url)
// Clone into a sibling temp dir (same filesystem β rename works, no EXDEV).
const cloneDir = `${targetPath}.clone`
const cloneArgs = [
'clone',
'--depth',
'1',
'--filter=tree:0',
'--no-checkout',
]
if (ref) {
cloneArgs.push('--branch', ref)
}
cloneArgs.push(gitUrl, cloneDir)
const cloneResult = await execFileNoThrow(gitExe(), cloneArgs)
if (cloneResult.code !== 0) {
throw new Error(
`Failed to clone repository for git-subdir source: ${cloneResult.stderr}`,
)
}
try {
const sparseResult = await execFileNoThrowWithCwd(
gitExe(),
['sparse-checkout', 'set', '--cone', '--', subdirPath],
{ cwd: cloneDir },
)
if (sparseResult.code !== 0) {
throw new Error(
`git sparse-checkout set failed (git >= 2.25 required for cone mode): ${sparseResult.stderr}`,
)
}
// Capture the resolved commit SHA before discarding the clone. The
// extracted subdir has no .git, so the caller can't rev-parse it later.
// If the source specified a full 40-char sha we already know it; otherwise
// read HEAD (which points to ref's tip after --branch, or the remote
// default branch if no ref was given).
let resolvedSha: string | undefined
if (sha) {
const fetchSha = await execFileNoThrowWithCwd(
gitExe(),
['fetch', '--depth', '1', 'origin', sha],
{ cwd: cloneDir },
)
if (fetchSha.code !== 0) {
logForDebugging(
`Shallow fetch of SHA ${sha} failed for git-subdir, falling back to unshallow fetch`,
)
const unshallow = await execFileNoThrowWithCwd(
gitExe(),
['fetch', '--unshallow'],
{ cwd: cloneDir },
)
if (unshallow.code !== 0) {
throw new Error(`Failed to fetch commit ${sha}: ${unshallow.stderr}`)
}
}
const checkout = await execFileNoThrowWithCwd(
gitExe(),
['checkout', sha],
{ cwd: cloneDir },
)
if (checkout.code !== 0) {
throw new Error(`Failed to checkout commit ${sha}: ${checkout.stderr}`)
}
resolvedSha = sha
} else {
// checkout HEAD materializes the working tree (this is where blobs are
// lazy-fetched β the slow, network-bound step). It doesn't move HEAD;
// --branch at clone time already positioned it. rev-parse HEAD is a
// purely read-only ref lookup (no index lock), so it runs safely in
// parallel with checkout and we avoid waiting on the network for it.
const [checkout, revParse] = await Promise.all([
execFileNoThrowWithCwd(gitExe(), ['checkout', 'HEAD'], {
cwd: cloneDir,
}),
execFileNoThrowWithCwd(gitExe(), ['rev-parse', 'HEAD'], {
cwd: cloneDir,
}),
])
if (checkout.code !== 0) {
throw new Error(
`git checkout after sparse-checkout failed: ${checkout.stderr}`,
)
}
if (revParse.code === 0) {
resolvedSha = revParse.stdout.trim()
}
}
// Path traversal guard: resolve+verify the subdir stays inside cloneDir
// before moving it out. rename ENOENT is wrapped with a friendlier
// message that references the source path, not internal temp dirs.
const resolvedSubdir = validatePathWithinBase(cloneDir, subdirPath)
try {
await rename(resolvedSubdir, targetPath)
} catch (e: unknown) {
if (isENOENT(e)) {
throw new Error(
`Subdirectory '${subdirPath}' not found in repository ${gitUrl}${ref ? ` (ref: ${ref})` : ''}. ` +
'Check that the path is correct and exists at the specified ref/sha.',
)
}
throw e
}
const refMsg = ref ? ` ref=${ref}` : ''
const shaMsg = resolvedSha ? ` sha=${resolvedSha}` : ''
logForDebugging(
`Extracted subdir ${subdirPath} from ${gitUrl}${refMsg}${shaMsg} to ${targetPath}`,
)
return resolvedSha
} finally {
await rm(cloneDir, { recursive: true, force: true })
}
}
/**
* Install a plugin from a local path
*/
async function installFromLocal(
sourcePath: string,
targetPath: string,
): Promise<void> {
if (!(await pathExists(sourcePath))) {
throw new Error(`Source path does not exist: ${sourcePath}`)
}
await copyDir(sourcePath, targetPath)
const gitPath = join(targetPath, '.git')
await rm(gitPath, { recursive: true, force: true })
}
/**
* Generate a temporary cache name for a plugin
*/
export function generateTemporaryCacheNameForPlugin(
source: PluginSource,
): string {
const timestamp = Date.now()
const random = Math.random().toString(36).substring(2, 8)
let prefix: string
if (typeof source === 'string') {
prefix = 'local'
} else {
switch (source.source) {
case 'npm':
prefix = 'npm'
break
case 'pip':
prefix = 'pip'
break
case 'github':
prefix = 'github'
break
case 'url':
prefix = 'git'
break
case 'git-subdir':
prefix = 'subdir'
break
default:
prefix = 'unknown'
}
}
return `temp_${prefix}_${timestamp}_${random}`
}
/**
* Cache a plugin from an external source
*/
export async function cachePlugin(
source: PluginSource,
options?: {
manifest?: PluginManifest
},
): Promise<{ path: string; manifest: PluginManifest; gitCommitSha?: string }> {
const cachePath = getPluginCachePath()
await getFsImplementation().mkdir(cachePath)
const tempName = generateTemporaryCacheNameForPlugin(source)
const tempPath = join(cachePath, tempName)
let shouldCleanup = false
let gitCommitSha: string | undefined
try {
logForDebugging(
`Caching plugin from source: ${jsonStringify(source)} to temporary path ${tempPath}`,
)
shouldCleanup = true
if (typeof source === 'string') {
await installFromLocal(source, tempPath)
} else {
switch (source.source) {
case 'npm':
await installFromNpm(source.package, tempPath, {
registry: source.registry,
version: source.version,
})
break
case 'github':
await installFromGitHub(source.repo, tempPath, source.ref, source.sha)
break
case 'url':
await installFromGit(source.url, tempPath, source.ref, source.sha)
break
case 'git-subdir':
gitCommitSha = await installFromGitSubdir(
source.url,
tempPath,
source.path,
source.ref,
source.sha,
)
break
case 'pip':
throw new Error('Python package plugins are not yet supported')
default:
throw new Error(`Unsupported plugin source type`)
}
}
} catch (error) {
if (shouldCleanup && (await pathExists(tempPath))) {
logForDebugging(`Cleaning up failed installation at ${tempPath}`)
try {
await rm(tempPath, { recursive: true, force: true })
} catch (cleanupError) {
logForDebugging(`Failed to clean up installation: ${cleanupError}`, {
level: 'error',
})
}
}
throw error
}
const manifestPath = join(tempPath, '.claude-plugin', 'plugin.json')
const legacyManifestPath = join(tempPath, 'plugin.json')
let manifest: PluginManifest
if (await pathExists(manifestPath)) {
try {
const content = await readFile(manifestPath, { encoding: 'utf-8' })
const parsed = jsonParse(content)
const result = PluginManifestSchema().safeParse(parsed)
if (result.success) {
manifest = result.data
} else {
// Manifest exists but is invalid - throw error
const errors = result.error.issues
.map(err => `${err.path.join('.')}: ${err.message}`)
.join(', ')
logForDebugging(`Invalid manifest at ${manifestPath}: ${errors}`, {
level: 'error',
})
throw new Error(
`Plugin has an invalid manifest file at ${manifestPath}. Validation errors: ${errors}`,
)
}
} catch (error) {
// Check if this is a validation error we just threw
if (
error instanceof Error &&
error.message.includes('invalid manifest file')
) {
throw error
}
// JSON parse error
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to parse manifest at ${manifestPath}: ${errorMsg}`,
{
level: 'error',
},
)
throw new Error(
`Plugin has a corrupt manifest file at ${manifestPath}. JSON parse error: ${errorMsg}`,
)
}
} else if (await pathExists(legacyManifestPath)) {
try {
const content = await readFile(legacyManifestPath, {
encoding: 'utf-8',
})
const parsed = jsonParse(content)
const result = PluginManifestSchema().safeParse(parsed)
if (result.success) {
manifest = result.data
} else {
// Manifest exists but is invalid - throw error
const errors = result.error.issues
.map(err => `${err.path.join('.')}: ${err.message}`)
.join(', ')
logForDebugging(
`Invalid legacy manifest at ${legacyManifestPath}: ${errors}`,
{ level: 'error' },
)
throw new Error(
`Plugin has an invalid manifest file at ${legacyManifestPath}. Validation errors: ${errors}`,
)
}
} catch (error) {
// Check if this is a validation error we just threw
if (
error instanceof Error &&
error.message.includes('invalid manifest file')
) {
throw error
}
// JSON parse error
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to parse legacy manifest at ${legacyManifestPath}: ${errorMsg}`,
{
level: 'error',
},
)
throw new Error(
`Plugin has a corrupt manifest file at ${legacyManifestPath}. JSON parse error: ${errorMsg}`,
)
}
} else {
manifest = options?.manifest || {
name: tempName,
description: `Plugin cached from ${typeof source === 'string' ? source : source.source}`,
}
}
const finalName = manifest.name.replace(/[^a-zA-Z0-9-_]/g, '-')
const finalPath = join(cachePath, finalName)
if (await pathExists(finalPath)) {
logForDebugging(`Removing old cached version at ${finalPath}`)
await rm(finalPath, { recursive: true, force: true })
}
await rename(tempPath, finalPath)
logForDebugging(`Successfully cached plugin ${manifest.name} to ${finalPath}`)
return {
path: finalPath,
manifest,
...(gitCommitSha && { gitCommitSha }),
}
}
/**
* Loads and validates a plugin manifest from a JSON file.
*
* The manifest provides metadata about the plugin including name, version,
* description, author, and other optional fields. If no manifest exists,
* a minimal one is created to allow the plugin to function.
*
* Example plugin.json:
* ```json
* {
* "name": "code-assistant",
* "version": "1.2.0",
* "description": "AI-powered code assistance tools",
* "author": {
* "name": "John Doe",
* "email": "john@example.com"
* },
* "keywords": ["coding", "ai", "assistant"],
* "homepage": "https://example.com/code-assistant",
* "hooks": "./custom-hooks.json",
* "commands": ["./extra-commands/*.md"]
* }
* ```
*/
/**
* Loads and validates a plugin manifest from a JSON file.
*
* The manifest provides metadata about the plugin including name, version,
* description, author, and other optional fields. If no manifest exists,
* a minimal one is created to allow the plugin to function.
*
* Unknown keys in the manifest are silently stripped (PluginManifestSchema
* uses zod's default strip behavior, not .strict()). Type mismatches and
* other validation errors still fail.
*
* Behavior:
* - Missing file: Creates default with provided name and source
* - Invalid JSON: Throws error with parse details
* - Schema validation failure: Throws error with validation details
*
* @param manifestPath - Full path to the plugin.json file
* @param pluginName - Name to use in default manifest (e.g., "my-plugin")
* @param source - Source description for default manifest (e.g., "git:repo" or ".claude-plugin/name")
* @returns A valid PluginManifest object (either loaded or default)
* @throws Error if manifest exists but is invalid (corrupt JSON or schema validation failure)
*/
export async function loadPluginManifest(
manifestPath: string,
pluginName: string,
source: string,
): Promise<PluginManifest> {
// Check if manifest file exists
// If not, create a minimal manifest to allow plugin to function
if (!(await pathExists(manifestPath))) {
// Return default manifest with provided name and source
return {
name: pluginName,
description: `Plugin from ${source}`,
}
}
try {
// Read and parse the manifest JSON file
const content = await readFile(manifestPath, { encoding: 'utf-8' })
const parsedJson = jsonParse(content)
// Validate against the PluginManifest schema
const result = PluginManifestSchema().safeParse(parsedJson)
if (result.success) {
// Valid manifest - return the validated data
return result.data
}
// Schema validation failed but JSON was valid
const errors = result.error.issues
.map(err =>
err.path.length > 0
? `${err.path.join('.')}: ${err.message}`
: err.message,
)
.join(', ')
logForDebugging(
`Plugin ${pluginName} has an invalid manifest file at ${manifestPath}. Validation errors: ${errors}`,
{ level: 'error' },
)
throw new Error(
`Plugin ${pluginName} has an invalid manifest file at ${manifestPath}.\n\nValidation errors: ${errors}`,
)
} catch (error) {
// Check if this is the error we just threw (validation error)
if (
error instanceof Error &&
error.message.includes('invalid manifest file')
) {
throw error
}
// JSON parsing failed or file read error
const errorMsg = errorMessage(error)
logForDebugging(
`Plugin ${pluginName} has a corrupt manifest file at ${manifestPath}. Parse error: ${errorMsg}`,
{ level: 'error' },
)
throw new Error(
`Plugin ${pluginName} has a corrupt manifest file at ${manifestPath}.\n\nJSON parse error: ${errorMsg}`,
)
}
}
/**
* Loads and validates plugin hooks configuration from a JSON file.
* IMPORTANT: Only call this when the hooks file is expected to exist.
*
* @param hooksConfigPath - Full path to the hooks.json file
* @param pluginName - Plugin name for error messages
* @returns Validated HooksSettings
* @throws Error if file doesn't exist or is invalid
*/
async function loadPluginHooks(
hooksConfigPath: string,
pluginName: string,
): Promise<HooksSettings> {
if (!(await pathExists(hooksConfigPath))) {
throw new Error(
`Hooks file not found at ${hooksConfigPath} for plugin ${pluginName}. If the manifest declares hooks, the file must exist.`,
)
}
const content = await readFile(hooksConfigPath, { encoding: 'utf-8' })
const rawHooksConfig = jsonParse(content)
// The hooks.json file has a wrapper structure with description and hooks
// Use PluginHooksSchema to validate and extract the hooks property
const validatedPluginHooks = PluginHooksSchema().parse(rawHooksConfig)
return validatedPluginHooks.hooks as HooksSettings
}
/**
* Validate a list of plugin component relative paths by checking existence in parallel.
*
* This helper parallelizes the pathExists checks (the expensive async part) while
* preserving deterministic error/log ordering by iterating results sequentially.
*
* Introduced to fix a perf regression from the syncβasync fs migration: sequential
* `for { await pathExists }` loops add ~1-5ms of event-loop overhead per iteration.
* With many plugins Γ several component types, this compounds to hundreds of ms.
*
* @param relPaths - Relative paths from the manifest/marketplace entry to validate
* @param pluginPath - Plugin root directory to resolve relative paths against
* @param pluginName - Plugin name for error messages
* @param source - Source identifier for PluginError records
* @param component - Which component these paths belong to (for error records)
* @param componentLabel - Human-readable label for log messages (e.g. "Agent", "Skill")
* @param contextLabel - Where the path came from, for log messages
* (e.g. "specified in manifest but", "from marketplace entry")
* @param errors - Error array to push path-not-found errors into (mutated)
* @returns Array of full paths that exist on disk, in original order
*/
async function validatePluginPaths(
relPaths: string[],
pluginPath: string,
pluginName: string,
source: string,
component: PluginComponent,
componentLabel: string,
contextLabel: string,
errors: PluginError[],
): Promise<string[]> {
// Parallelize the async pathExists checks
const checks = await Promise.all(
relPaths.map(async relPath => {
const fullPath = join(pluginPath, relPath)
return { relPath, fullPath, exists: await pathExists(fullPath) }
}),
)
// Process results in original order to keep error/log ordering deterministic
const validPaths: string[] = []
for (const { relPath, fullPath, exists } of checks) {
if (exists) {
validPaths.push(fullPath)
} else {
logForDebugging(
`${componentLabel} path ${relPath} ${contextLabel} not found at ${fullPath} for ${pluginName}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${fullPath} for ${pluginName}`,
),
)
errors.push({
type: 'path-not-found',
source,
plugin: pluginName,
path: fullPath,
component,
})
}
}
return validPaths
}
/**
* Creates a LoadedPlugin object from a plugin directory path.
*
* This is the central function that assembles a complete plugin representation
* by scanning the plugin directory structure and loading all components.
* It handles both fully-featured plugins with manifests and minimal plugins
* with just commands or agents directories.
*
* Directory structure it looks for:
* ```
* plugin-directory/
* βββ plugin.json # Optional: Plugin manifest
* βββ commands/ # Optional: Custom slash commands
* β βββ build.md # /build command
* β βββ test.md # /test command
* βββ agents/ # Optional: Custom AI agents
* β βββ reviewer.md # Code review agent
* β βββ optimizer.md # Performance optimization agent
* βββ hooks/ # Optional: Hook configurations
* βββ hooks.json # Hook definitions
* ```
*
* Component detection:
* - Manifest: Loaded from plugin.json if present, otherwise creates default
* - Commands: Sets commandsPath if commands/ directory exists
* - Agents: Sets agentsPath if agents/ directory exists
* - Hooks: Loads from hooks/hooks.json if present
*
* The function is tolerant of missing components - a plugin can have
* any combination of the above directories/files. Missing component files
* are reported as errors but don't prevent plugin loading.
*
* @param pluginPath - Absolute path to the plugin directory
* @param source - Source identifier (e.g., "git:repo", ".claude-plugin/my-plugin")
* @param enabled - Initial enabled state (may be overridden by settings)
* @param fallbackName - Name to use if manifest doesn't specify one
* @param strict - When true, adds errors for duplicate hook files (default: true)
* @returns Object containing the LoadedPlugin and any errors encountered
*/
export async function createPluginFromPath(
pluginPath: string,
source: string,
enabled: boolean,
fallbackName: string,
strict = true,
): Promise<{ plugin: LoadedPlugin; errors: PluginError[] }> {
const errors: PluginError[] = []
// Step 1: Load or create the plugin manifest
// This provides metadata about the plugin (name, version, etc.)
const manifestPath = join(pluginPath, '.claude-plugin', 'plugin.json')
const manifest = await loadPluginManifest(manifestPath, fallbackName, source)
// Step 2: Create the base plugin object
// Start with required fields from manifest and parameters
const plugin: LoadedPlugin = {
name: manifest.name, // Use name from manifest (or fallback)
manifest, // Store full manifest for later use
path: pluginPath, // Absolute path to plugin directory
source, // Source identifier (e.g., "git:repo" or ".claude-plugin/name")
repository: source, // For backward compatibility with Plugin Repository
enabled, // Current enabled state
}
// Step 3: Auto-detect optional directories in parallel
const [
commandsDirExists,
agentsDirExists,
skillsDirExists,
outputStylesDirExists,
] = await Promise.all([
!manifest.commands ? pathExists(join(pluginPath, 'commands')) : false,
!manifest.agents ? pathExists(join(pluginPath, 'agents')) : false,
!manifest.skills ? pathExists(join(pluginPath, 'skills')) : false,
!manifest.outputStyles
? pathExists(join(pluginPath, 'output-styles'))
: false,
])
const commandsPath = join(pluginPath, 'commands')
if (commandsDirExists) {
plugin.commandsPath = commandsPath
}
// Step 3a: Process additional command paths from manifest
if (manifest.commands) {
// Check if it's an object mapping (record of command name β metadata)
const firstValue = Object.values(manifest.commands)[0]
if (
typeof manifest.commands === 'object' &&
!Array.isArray(manifest.commands) &&
firstValue &&
typeof firstValue === 'object' &&
('source' in firstValue || 'content' in firstValue)
) {
// Object mapping format: { "about": { "source": "./README.md", ... } }
const commandsMetadata: Record<string, CommandMetadata> = {}
const validPaths: string[] = []
// Parallelize pathExists checks; process results in order to keep
// error/log ordering deterministic.
const entries = Object.entries(manifest.commands)
const checks = await Promise.all(
entries.map(async ([commandName, metadata]) => {
if (!metadata || typeof metadata !== 'object') {
return { commandName, metadata, kind: 'skip' as const }
}
if (metadata.source) {
const fullPath = join(pluginPath, metadata.source)
return {
commandName,
metadata,
kind: 'source' as const,
fullPath,
exists: await pathExists(fullPath),
}
}
if (metadata.content) {
return { commandName, metadata, kind: 'content' as const }
}
return { commandName, metadata, kind: 'skip' as const }
}),
)
for (const check of checks) {
if (check.kind === 'skip') continue
if (check.kind === 'content') {
// For inline content commands, add metadata without path
commandsMetadata[check.commandName] = check.metadata
continue
}
// kind === 'source'
if (check.exists) {
validPaths.push(check.fullPath)
commandsMetadata[check.commandName] = check.metadata
} else {
logForDebugging(
`Command ${check.commandName} path ${check.metadata.source} specified in manifest but not found at ${check.fullPath} for ${manifest.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${manifest.name}`,
),
)
errors.push({
type: 'path-not-found',
source,
plugin: manifest.name,
path: check.fullPath,
component: 'commands',
})
}
}
// Set commandsPaths if there are file-based commands
if (validPaths.length > 0) {
plugin.commandsPaths = validPaths
}
// Set commandsMetadata if there are any commands (file-based or inline)
if (Object.keys(commandsMetadata).length > 0) {
plugin.commandsMetadata = commandsMetadata
}
} else {
// Path or array of paths format
const commandPaths = Array.isArray(manifest.commands)
? manifest.commands
: [manifest.commands]
// Parallelize pathExists checks; process results in order.
const checks = await Promise.all(
commandPaths.map(async cmdPath => {
if (typeof cmdPath !== 'string') {
return { cmdPath, kind: 'invalid' as const }
}
const fullPath = join(pluginPath, cmdPath)
return {
cmdPath,
kind: 'path' as const,
fullPath,
exists: await pathExists(fullPath),
}
}),
)
const validPaths: string[] = []
for (const check of checks) {
if (check.kind === 'invalid') {
logForDebugging(
`Unexpected command format in manifest for ${manifest.name}`,
{ level: 'error' },
)
continue
}
if (check.exists) {
validPaths.push(check.fullPath)
} else {
logForDebugging(
`Command path ${check.cmdPath} specified in manifest but not found at ${check.fullPath} for ${manifest.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${manifest.name}`,
),
)
errors.push({
type: 'path-not-found',
source,
plugin: manifest.name,
path: check.fullPath,
component: 'commands',
})
}
}
if (validPaths.length > 0) {
plugin.commandsPaths = validPaths
}
}
}
// Step 4: Register agents directory if detected
const agentsPath = join(pluginPath, 'agents')
if (agentsDirExists) {
plugin.agentsPath = agentsPath
}
// Step 4a: Process additional agent paths from manifest
if (manifest.agents) {
const agentPaths = Array.isArray(manifest.agents)
? manifest.agents
: [manifest.agents]
const validPaths = await validatePluginPaths(
agentPaths,
pluginPath,
manifest.name,
source,
'agents',
'Agent',
'specified in manifest but',
errors,
)
if (validPaths.length > 0) {
plugin.agentsPaths = validPaths
}
}
// Step 4b: Register skills directory if detected
const skillsPath = join(pluginPath, 'skills')
if (skillsDirExists) {
plugin.skillsPath = skillsPath
}
// Step 4c: Process additional skill paths from manifest
if (manifest.skills) {
const skillPaths = Array.isArray(manifest.skills)
? manifest.skills
: [manifest.skills]
const validPaths = await validatePluginPaths(
skillPaths,
pluginPath,
manifest.name,
source,
'skills',
'Skill',
'specified in manifest but',
errors,
)
if (validPaths.length > 0) {
plugin.skillsPaths = validPaths
}
}
// Step 4d: Register output-styles directory if detected
const outputStylesPath = join(pluginPath, 'output-styles')
if (outputStylesDirExists) {
plugin.outputStylesPath = outputStylesPath
}
// Step 4e: Process additional output style paths from manifest
if (manifest.outputStyles) {
const outputStylePaths = Array.isArray(manifest.outputStyles)
? manifest.outputStyles
: [manifest.outputStyles]
const validPaths = await validatePluginPaths(
outputStylePaths,
pluginPath,
manifest.name,
source,
'output-styles',
'Output style',
'specified in manifest but',
errors,
)
if (validPaths.length > 0) {
plugin.outputStylesPaths = validPaths
}
}
// Step 5: Load hooks configuration
let mergedHooks: HooksSettings | undefined
const loadedHookPaths = new Set<string>() // Track loaded hook files
// Load from standard hooks/hooks.json if it exists
const standardHooksPath = join(pluginPath, 'hooks', 'hooks.json')
if (await pathExists(standardHooksPath)) {
try {
mergedHooks = await loadPluginHooks(standardHooksPath, manifest.name)
// Track the normalized path to prevent duplicate loading
try {
loadedHookPaths.add(await realpath(standardHooksPath))
} catch {
// If realpathSync fails, use original path
loadedHookPaths.add(standardHooksPath)
}
logForDebugging(
`Loaded hooks from standard location for plugin ${manifest.name}: ${standardHooksPath}`,
)
} catch (error) {
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to load hooks for ${manifest.name}: ${errorMsg}`,
{
level: 'error',
},
)
logError(toError(error))
errors.push({
type: 'hook-load-failed',
source,
plugin: manifest.name,
hookPath: standardHooksPath,
reason: errorMsg,
})
}
}
// Load and merge hooks from manifest.hooks if specified
if (manifest.hooks) {
const manifestHooksArray = Array.isArray(manifest.hooks)
? manifest.hooks
: [manifest.hooks]
for (const hookSpec of manifestHooksArray) {
if (typeof hookSpec === 'string') {
// Path to additional hooks file
const hookFilePath = join(pluginPath, hookSpec)
if (!(await pathExists(hookFilePath))) {
logForDebugging(
`Hooks file ${hookSpec} specified in manifest but not found at ${hookFilePath} for ${manifest.name}`,
{ level: 'error' },
)
logError(
new Error(
`Plugin component file not found: ${hookFilePath} for ${manifest.name}`,
),
)
errors.push({
type: 'path-not-found',
source,
plugin: manifest.name,
path: hookFilePath,
component: 'hooks',
})
continue
}
// Check if this path resolves to an already-loaded hooks file
let normalizedPath: string
try {
normalizedPath = await realpath(hookFilePath)
} catch {
// If realpathSync fails, use original path
normalizedPath = hookFilePath
}
if (loadedHookPaths.has(normalizedPath)) {
logForDebugging(
`Skipping duplicate hooks file for plugin ${manifest.name}: ${hookSpec} ` +
`(resolves to already-loaded file: ${normalizedPath})`,
)
if (strict) {
const errorMsg = `Duplicate hooks file detected: ${hookSpec} resolves to already-loaded file ${normalizedPath}. The standard hooks/hooks.json is loaded automatically, so manifest.hooks should only reference additional hook files.`
logError(new Error(errorMsg))
errors.push({
type: 'hook-load-failed',
source,
plugin: manifest.name,
hookPath: hookFilePath,
reason: errorMsg,
})
}
continue
}
try {
const additionalHooks = await loadPluginHooks(
hookFilePath,
manifest.name,
)
try {
mergedHooks = mergeHooksSettings(mergedHooks, additionalHooks)
loadedHookPaths.add(normalizedPath)
logForDebugging(
`Loaded and merged hooks from manifest for plugin ${manifest.name}: ${hookSpec}`,
)
} catch (mergeError) {
const mergeErrorMsg = errorMessage(mergeError)
logForDebugging(
`Failed to merge hooks from ${hookSpec} for ${manifest.name}: ${mergeErrorMsg}`,
{ level: 'error' },
)
logError(toError(mergeError))
errors.push({
type: 'hook-load-failed',
source,
plugin: manifest.name,
hookPath: hookFilePath,
reason: `Failed to merge: ${mergeErrorMsg}`,
})
}
} catch (error) {
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to load hooks from ${hookSpec} for ${manifest.name}: ${errorMsg}`,
{ level: 'error' },
)
logError(toError(error))
errors.push({
type: 'hook-load-failed',
source,
plugin: manifest.name,
hookPath: hookFilePath,
reason: errorMsg,
})
}
} else if (typeof hookSpec === 'object') {
// Inline hooks
mergedHooks = mergeHooksSettings(mergedHooks, hookSpec as HooksSettings)
}
}
}
if (mergedHooks) {
plugin.hooksConfig = mergedHooks
}
// Step 6: Load plugin settings
// Settings can come from settings.json in the plugin directory or from manifest.settings
// Only allowlisted keys are kept (currently: agent)
const pluginSettings = await loadPluginSettings(pluginPath, manifest)
if (pluginSettings) {
plugin.settings = pluginSettings
}
return { plugin, errors }
}
/**
* Schema derived from SettingsSchema that only keeps keys plugins are allowed to set.
* Uses .strip() so unknown keys are silently removed during parsing.
*/
const PluginSettingsSchema = lazySchema(() =>
SettingsSchema()
.pick({
agent: true,
})
.strip(),
)
/**
* Parse raw settings through PluginSettingsSchema, returning only allowlisted keys.
* Returns undefined if parsing fails or all keys are filtered out.
*/
function parsePluginSettings(
raw: Record<string, unknown>,
): Record<string, unknown> | undefined {
const result = PluginSettingsSchema().safeParse(raw)
if (!result.success) {
return undefined
}
const data = result.data
if (Object.keys(data).length === 0) {
return undefined
}
return data
}
/**
* Load plugin settings from settings.json file or manifest.settings.
* settings.json takes priority over manifest.settings when both exist.
* Only allowlisted keys are included in the result.
*/
async function loadPluginSettings(
pluginPath: string,
manifest: PluginManifest,
): Promise<Record<string, unknown> | undefined> {
// Try loading settings.json from the plugin directory
const settingsJsonPath = join(pluginPath, 'settings.json')
try {
const content = await readFile(settingsJsonPath, { encoding: 'utf-8' })
const parsed = jsonParse(content)
if (isRecord(parsed)) {
const filtered = parsePluginSettings(parsed)
if (filtered) {
logForDebugging(
`Loaded settings from settings.json for plugin ${manifest.name}`,
)
return filtered
}
}
} catch (e: unknown) {
// Missing/inaccessible is expected - settings.json is optional
if (!isFsInaccessible(e)) {
logForDebugging(
`Failed to parse settings.json for plugin ${manifest.name}: ${e}`,
{ level: 'warn' },
)
}
}
// Fall back to manifest.settings
if (manifest.settings) {
const filtered = parsePluginSettings(
manifest.settings as Record<string, unknown>,
)
if (filtered) {
logForDebugging(
`Loaded settings from manifest for plugin ${manifest.name}`,
)
return filtered
}
}
return undefined
}
/**
* Merge two HooksSettings objects
*/
function mergeHooksSettings(
base: HooksSettings | undefined,
additional: HooksSettings,
): HooksSettings {
if (!base) {
return additional
}
const merged = { ...base }
for (const [event, matchers] of Object.entries(additional)) {
if (!merged[event as keyof HooksSettings]) {
merged[event as keyof HooksSettings] = matchers
} else {
// Merge matchers for this event
merged[event as keyof HooksSettings] = [
...(merged[event as keyof HooksSettings] || []),
...matchers,
]
}
}
return merged
}
/**
* Shared discovery/policy/merge pipeline for both load modes.
*
* Resolves enabledPlugins β marketplace entries, runs enterprise policy
* checks, pre-loads catalogs, then dispatches each entry to the full or
* cache-only per-entry loader. The ONLY difference between loadAllPlugins
* and loadAllPluginsCacheOnly is which loader runs β discovery and policy
* are identical.
*/
async function loadPluginsFromMarketplaces({
cacheOnly,
}: {
cacheOnly: boolean
}): Promise<{
plugins: LoadedPlugin[]
errors: PluginError[]
}> {
const settings = getSettings_DEPRECATED()
// Merge --add-dir plugins at lowest priority; standard settings win on conflict
const enabledPlugins = {
...getAddDirEnabledPlugins(),
...(settings.enabledPlugins || {}),
}
const plugins: LoadedPlugin[] = []
const errors: PluginError[] = []
// Filter to plugin@marketplace format and validate
const marketplacePluginEntries = Object.entries(enabledPlugins).filter(
([key, value]) => {
// Check if it's in plugin@marketplace format (includes both enabled and disabled)
const isValidFormat = PluginIdSchema().safeParse(key).success
if (!isValidFormat || value === undefined) return false
// Skip built-in plugins β handled separately by getBuiltinPlugins()
const { marketplace } = parsePluginIdentifier(key)
return marketplace !== BUILTIN_MARKETPLACE_NAME
},
)
// Load known marketplaces config to look up sources for policy checking.
// Use the Safe variant so a corrupted config file doesn't crash all plugin
// loading β this is a read-only path, so returning {} degrades gracefully.
const knownMarketplaces = await loadKnownMarketplacesConfigSafe()
// Fail-closed guard for enterprise policy: if a policy IS configured and we
// cannot resolve a marketplace's source (config returned {} due to corruption,
// or entry missing), we must NOT silently skip the policy check and load the
// plugin anyway. Before Safe, a corrupted config crashed everything (loud,
// fail-closed). With Safe + no guard, the policy check short-circuits on
// undefined marketplaceConfig and the fallback path (getPluginByIdCacheOnly)
// loads the plugin unchecked β a silent fail-open. This guard restores
// fail-closed: unknown source + active policy β block.
//
// Allowlist: any value (including []) is active β empty allowlist = deny all.
// Blocklist: empty [] is a semantic no-op β only non-empty counts as active.
const strictAllowlist = getStrictKnownMarketplaces()
const blocklist = getBlockedMarketplaces()
const hasEnterprisePolicy =
strictAllowlist !== null || (blocklist !== null && blocklist.length > 0)
// Pre-load marketplace catalogs once per marketplace rather than re-reading
// known_marketplaces.json + marketplace.json for every plugin. This is the
// hot path β with N plugins across M marketplaces, the old per-plugin
// getPluginByIdCacheOnly() did 2N config reads + N catalog reads; this does M.
const uniqueMarketplaces = new Set(
marketplacePluginEntries
.map(([pluginId]) => parsePluginIdentifier(pluginId).marketplace)
.filter((m): m is string => !!m),
)
const marketplaceCatalogs = new Map<
string,
Awaited<ReturnType<typeof getMarketplaceCacheOnly>>
>()
await Promise.all(
[...uniqueMarketplaces].map(async name => {
marketplaceCatalogs.set(name, await getMarketplaceCacheOnly(name))
}),
)
// Look up installed versions once so the first-pass ZIP cache check
// can hit even when the marketplace entry omits `version`.
const installedPluginsData = getInMemoryInstalledPlugins()
// Load all marketplace plugins in parallel for faster startup
const results = await Promise.allSettled(
marketplacePluginEntries.map(async ([pluginId, enabledValue]) => {
const { name: pluginName, marketplace: marketplaceName } =
parsePluginIdentifier(pluginId)
// Check if marketplace source is allowed by enterprise policy
const marketplaceConfig = knownMarketplaces[marketplaceName!]
// Fail-closed: if enterprise policy is active and we can't look up the
// marketplace source (config corrupted/empty, or entry missing), block
// rather than silently skip the policy check. See hasEnterprisePolicy
// comment above for the fail-open hazard this guards against.
//
// This also fires for the "stale enabledPlugins entry with no registered
// marketplace" case, which is a UX trade-off: the user gets a policy
// error instead of plugin-not-found. Accepted because the fallback path
// (getPluginByIdCacheOnly) does a raw cast of known_marketplaces.json
// with NO schema validation β if one entry is malformed enough to fail
// our validation but readable enough for the raw cast, it would load
// unchecked. Unverifiable source + active policy β block, always.
if (!marketplaceConfig && hasEnterprisePolicy) {
// We can't know whether the unverifiable source would actually be in
// the blocklist or not in the allowlist β so pick the error variant
// that matches whichever policy IS configured. If an allowlist exists,
// "not in allowed list" is the right framing; if only a blocklist
// exists, "blocked by blocklist" is less misleading than showing an
// empty allowed-sources list.
errors.push({
type: 'marketplace-blocked-by-policy',
source: pluginId,
plugin: pluginName,
marketplace: marketplaceName!,
blockedByBlocklist: strictAllowlist === null,
allowedSources: (strictAllowlist ?? []).map(s =>
formatSourceForDisplay(s),
),
})
return null
}
if (
marketplaceConfig &&
!isSourceAllowedByPolicy(marketplaceConfig.source)
) {
// Check if explicitly blocked vs not in allowlist for better error context
const isBlocked = isSourceInBlocklist(marketplaceConfig.source)
const allowlist = getStrictKnownMarketplaces() || []
errors.push({
type: 'marketplace-blocked-by-policy',
source: pluginId,
plugin: pluginName,
marketplace: marketplaceName!,
blockedByBlocklist: isBlocked,
allowedSources: isBlocked
? []
: allowlist.map(s => formatSourceForDisplay(s)),
})
return null
}
// Look up plugin entry from pre-loaded marketplace catalog (no per-plugin I/O).
// Fall back to getPluginByIdCacheOnly if the catalog couldn't be pre-loaded.
let result: Awaited<ReturnType<typeof getPluginByIdCacheOnly>> = null
const marketplace = marketplaceCatalogs.get(marketplaceName!)
if (marketplace && marketplaceConfig) {
const entry = marketplace.plugins.find(p => p.name === pluginName)
if (entry) {
result = {
entry,
marketplaceInstallLocation: marketplaceConfig.installLocation,
}
}
} else {
result = await getPluginByIdCacheOnly(pluginId)
}
if (!result) {
errors.push({
type: 'plugin-not-found',
source: pluginId,
pluginId: pluginName!,
marketplace: marketplaceName!,
})
return null
}
// installed_plugins.json records what's actually cached on disk
// (version for the full loader's first-pass probe, installPath for
// the cache-only loader's direct read).
const installEntry = installedPluginsData.plugins[pluginId]?.[0]
return cacheOnly
? loadPluginFromMarketplaceEntryCacheOnly(
result.entry,
result.marketplaceInstallLocation,
pluginId,
enabledValue === true,
errors,
installEntry?.installPath,
)
: loadPluginFromMarketplaceEntry(
result.entry,
result.marketplaceInstallLocation,
pluginId,
enabledValue === true,
errors,
installEntry?.version,
)
}),
)
for (const [i, result] of results.entries()) {
if (result.status === 'fulfilled' && result.value) {
plugins.push(result.value)
} else if (result.status === 'rejected') {
const err = toError(result.reason)
logError(err)
const pluginId = marketplacePluginEntries[i]![0]
errors.push({
type: 'generic-error',
source: pluginId,
plugin: pluginId.split('@')[0],
error: err.message,
})
}
}
return { plugins, errors }
}
/**
* Cache-only variant of loadPluginFromMarketplaceEntry.
*
* Skips network (cachePlugin) and disk-copy (copyPluginToVersionedCache).
* Reads directly from the recorded installPath; if missing, emits
* 'plugin-cache-miss'. Still extracts ZIP-cached plugins (local, fast).
*/
async function loadPluginFromMarketplaceEntryCacheOnly(
entry: PluginMarketplaceEntry,
marketplaceInstallLocation: string,
pluginId: string,
enabled: boolean,
errorsOut: PluginError[],
installPath: string | undefined,
): Promise<LoadedPlugin | null> {
let pluginPath: string
if (typeof entry.source === 'string') {
// Local relative path β read from the marketplace source dir directly.
// Skip copyPluginToVersionedCache; startup doesn't need a fresh copy.
let marketplaceDir: string
try {
marketplaceDir = (await stat(marketplaceInstallLocation)).isDirectory()
? marketplaceInstallLocation
: join(marketplaceInstallLocation, '..')
} catch {
errorsOut.push({
type: 'plugin-cache-miss',
source: pluginId,
plugin: entry.name,
installPath: marketplaceInstallLocation,
})
return null
}
pluginPath = join(marketplaceDir, entry.source)
// finishLoadingPluginFromPath reads pluginPath β its error handling
// surfaces ENOENT as a load failure, no need to pre-check here.
} else {
// External source (npm/github/url/git-subdir) β use recorded installPath.
if (!installPath || !(await pathExists(installPath))) {
errorsOut.push({
type: 'plugin-cache-miss',
source: pluginId,
plugin: entry.name,
installPath: installPath ?? '(not recorded)',
})
return null
}
pluginPath = installPath
}
// Zip cache extraction β must still happen in cacheOnly mode (invariant 4)
if (isPluginZipCacheEnabled() && pluginPath.endsWith('.zip')) {
const sessionDir = await getSessionPluginCachePath()
const extractDir = join(
sessionDir,
pluginId.replace(/[^a-zA-Z0-9@\-_]/g, '-'),
)
try {
await extractZipToDirectory(pluginPath, extractDir)
pluginPath = extractDir
} catch (error) {
logForDebugging(`Failed to extract plugin ZIP ${pluginPath}: ${error}`, {
level: 'error',
})
errorsOut.push({
type: 'plugin-cache-miss',
source: pluginId,
plugin: entry.name,
installPath: pluginPath,
})
return null
}
}
// Delegate to the shared tail β identical to the full loader from here
return finishLoadingPluginFromPath(
entry,
pluginId,
enabled,
errorsOut,
pluginPath,
)
}
/**
* Load a plugin from a marketplace entry based on its source configuration.
*
* Handles different source types:
* - Relative path: Loads from marketplace repo directory
* - npm/github/url: Caches then loads from cache
*
* @param installedVersion - Version from installed_plugins.json, used as a
* first-pass hint for the versioned cache lookup when the marketplace entry
* omits `version`. Avoids re-cloning external plugins just to discover the
* version we already recorded at install time.
*
* Returns both the loaded plugin and any errors encountered during loading.
* Errors include missing component files and hook load failures.
*/
async function loadPluginFromMarketplaceEntry(
entry: PluginMarketplaceEntry,
marketplaceInstallLocation: string,
pluginId: string,
enabled: boolean,
errorsOut: PluginError[],
installedVersion?: string,
): Promise<LoadedPlugin | null> {
logForDebugging(
`Loading plugin ${entry.name} from source: ${jsonStringify(entry.source)}`,
)
let pluginPath: string
if (typeof entry.source === 'string') {
// Relative path - resolve relative to marketplace install location
const marketplaceDir = (
await stat(marketplaceInstallLocation)
).isDirectory()
? marketplaceInstallLocation
: join(marketplaceInstallLocation, '..')
const sourcePluginPath = join(marketplaceDir, entry.source)
if (!(await pathExists(sourcePluginPath))) {
const error = new Error(`Plugin path not found: ${sourcePluginPath}`)
logForDebugging(`Plugin path not found: ${sourcePluginPath}`, {
level: 'error',
})
logError(error)
errorsOut.push({
type: 'generic-error',
source: pluginId,
error: `Plugin directory not found at path: ${sourcePluginPath}. Check that the marketplace entry has the correct path.`,
})
return null
}
// Always copy local plugins to versioned cache
try {
// Try to load manifest from plugin directory to check for version field first
const manifestPath = join(
sourcePluginPath,
'.claude-plugin',
'plugin.json',
)
let pluginManifest: PluginManifest | undefined
try {
pluginManifest = await loadPluginManifest(
manifestPath,
entry.name,
entry.source,
)
} catch {
// Manifest loading failed - will fall back to provided version or git SHA
}
// Calculate version with fallback order:
// 1. Plugin manifest version, 2. Marketplace entry version, 3. Git SHA, 4. 'unknown'
const version = await calculatePluginVersion(
pluginId,
entry.source,
pluginManifest,
marketplaceDir,
entry.version, // Marketplace entry version as fallback
)
// Copy to versioned cache
pluginPath = await copyPluginToVersionedCache(
sourcePluginPath,
pluginId,
version,
entry,
marketplaceDir,
)
logForDebugging(
`Resolved local plugin ${entry.name} to versioned cache: ${pluginPath}`,
)
} catch (error) {
// If copy fails, fall back to loading from marketplace directly
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to copy plugin ${entry.name} to versioned cache: ${errorMsg}. Using marketplace path.`,
{ level: 'warn' },
)
pluginPath = sourcePluginPath
}
} else {
// External source (npm, github, url, pip) - always use versioned cache
try {
// Calculate version with fallback order:
// 1. No manifest yet, 2. installed_plugins.json version,
// 3. Marketplace entry version, 4. source.sha (pinned commits β the
// exact value the post-clone call at cached.gitCommitSha would see),
// 5. 'unknown' β ref-tracked, falls through to clone by design.
const version = await calculatePluginVersion(
pluginId,
entry.source,
undefined,
undefined,
installedVersion ?? entry.version,
'sha' in entry.source ? entry.source.sha : undefined,
)
const versionedPath = getVersionedCachePath(pluginId, version)
// Check for cached version β ZIP file (zip cache mode) or directory
const zipPath = getVersionedZipCachePath(pluginId, version)
if (isPluginZipCacheEnabled() && (await pathExists(zipPath))) {
logForDebugging(
`Using versioned cached plugin ZIP ${entry.name} from ${zipPath}`,
)
pluginPath = zipPath
} else if (await pathExists(versionedPath)) {
logForDebugging(
`Using versioned cached plugin ${entry.name} from ${versionedPath}`,
)
pluginPath = versionedPath
} else {
// Seed cache probe (CCR pre-baked images, read-only). Seed content is
// frozen at image build time β no freshness concern, 'whatever's there'
// is what the image builder put there. Primary cache is NOT probed
// here; ref-tracked sources fall through to clone (the re-clone IS
// the freshness mechanism). If the clone fails, the plugin is simply
// disabled for this session β errorsOut.push below surfaces it.
const seedPath =
(await probeSeedCache(pluginId, version)) ??
(version === 'unknown'
? await probeSeedCacheAnyVersion(pluginId)
: null)
if (seedPath) {
pluginPath = seedPath
logForDebugging(
`Using seed cache for external plugin ${entry.name} at ${seedPath}`,
)
} else {
// Download to temp location, then copy to versioned cache
const cached = await cachePlugin(entry.source, {
manifest: { name: entry.name },
})
// If the pre-clone version was deterministic (source.sha /
// entry.version / installedVersion), REUSE it. The post-clone
// recomputation with cached.manifest can return a DIFFERENT value
// β manifest.version (step 1) outranks gitCommitSha (step 3) β
// which would cache at e.g. "2.0.0/" while every warm start
// probes "{sha12}-{hash}/". Mismatched keys = re-clone forever.
// Recomputation is only needed when pre-clone was 'unknown'
// (ref-tracked, no hints) β the clone is the ONLY way to learn.
const actualVersion =
version !== 'unknown'
? version
: await calculatePluginVersion(
pluginId,
entry.source,
cached.manifest,
cached.path,
installedVersion ?? entry.version,
cached.gitCommitSha,
)
// Copy to versioned cache
// For external sources, marketplaceDir is not applicable (already downloaded)
pluginPath = await copyPluginToVersionedCache(
cached.path,
pluginId,
actualVersion,
entry,
undefined,
)
// Clean up temp path
if (cached.path !== pluginPath) {
await rm(cached.path, { recursive: true, force: true })
}
}
}
} catch (error) {
const errorMsg = errorMessage(error)
logForDebugging(`Failed to cache plugin ${entry.name}: ${errorMsg}`, {
level: 'error',
})
logError(toError(error))
errorsOut.push({
type: 'generic-error',
source: pluginId,
error: `Failed to download/cache plugin ${entry.name}: ${errorMsg}`,
})
return null
}
}
// Zip cache mode: extract ZIP to session temp dir before loading
if (isPluginZipCacheEnabled() && pluginPath.endsWith('.zip')) {
const sessionDir = await getSessionPluginCachePath()
const extractDir = join(
sessionDir,
pluginId.replace(/[^a-zA-Z0-9@\-_]/g, '-'),
)
try {
await extractZipToDirectory(pluginPath, extractDir)
logForDebugging(`Extracted plugin ZIP to session dir: ${extractDir}`)
pluginPath = extractDir
} catch (error) {
// Corrupt ZIP: delete it so next install attempt re-creates it
logForDebugging(
`Failed to extract plugin ZIP ${pluginPath}, deleting corrupt file: ${error}`,
)
await rm(pluginPath, { force: true }).catch(() => {})
throw error
}
}
return finishLoadingPluginFromPath(
entry,
pluginId,
enabled,
errorsOut,
pluginPath,
)
}
/**
* Shared tail of both loadPluginFromMarketplaceEntry variants.
*
* Once pluginPath is resolved (via clone, cache, or installPath lookup),
* the rest of the load β manifest probe, createPluginFromPath, marketplace
* entry supplementation β is identical. Extracted so the cache-only path
* doesn't duplicate ~500 lines.
*/
async function finishLoadingPluginFromPath(
entry: PluginMarketplaceEntry,
pluginId: string,
enabled: boolean,
errorsOut: PluginError[],
pluginPath: string,
): Promise<LoadedPlugin | null> {
const errors: PluginError[] = []
// Check if plugin.json exists to determine if we should use marketplace manifest
const manifestPath = join(pluginPath, '.claude-plugin', 'plugin.json')
const hasManifest = await pathExists(manifestPath)
const { plugin, errors: pluginErrors } = await createPluginFromPath(
pluginPath,
pluginId,
enabled,
entry.name,
entry.strict ?? true, // Respect marketplace entry's strict setting
)
errors.push(...pluginErrors)
// Set sha from source if available (for github and url source types)
if (
typeof entry.source === 'object' &&
'sha' in entry.source &&
entry.source.sha
) {
plugin.sha = entry.source.sha
}
// If there's no plugin.json, use marketplace entry as manifest (regardless of strict mode)
if (!hasManifest) {
plugin.manifest = {
...entry,
id: undefined,
source: undefined,
strict: undefined,
} as PluginManifest
plugin.name = plugin.manifest.name
// Process commands from marketplace entry
if (entry.commands) {
// Check if it's an object mapping
const firstValue = Object.values(entry.commands)[0]
if (
typeof entry.commands === 'object' &&
!Array.isArray(entry.commands) &&
firstValue &&
typeof firstValue === 'object' &&
('source' in firstValue || 'content' in firstValue)
) {
// Object mapping format
const commandsMetadata: Record<string, CommandMetadata> = {}
const validPaths: string[] = []
// Parallelize pathExists checks; process results in order.
const entries = Object.entries(entry.commands)
const checks = await Promise.all(
entries.map(async ([commandName, metadata]) => {
if (!metadata || typeof metadata !== 'object' || !metadata.source) {
return { commandName, metadata, skip: true as const }
}
const fullPath = join(pluginPath, metadata.source)
return {
commandName,
metadata,
skip: false as const,
fullPath,
exists: await pathExists(fullPath),
}
}),
)
for (const check of checks) {
if (check.skip) continue
if (check.exists) {
validPaths.push(check.fullPath)
commandsMetadata[check.commandName] = check.metadata
} else {
logForDebugging(
`Command ${check.commandName} path ${check.metadata.source} from marketplace entry not found at ${check.fullPath} for ${entry.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${entry.name}`,
),
)
errors.push({
type: 'path-not-found',
source: pluginId,
plugin: entry.name,
path: check.fullPath,
component: 'commands',
})
}
}
if (validPaths.length > 0) {
plugin.commandsPaths = validPaths
plugin.commandsMetadata = commandsMetadata
}
} else {
// Path or array of paths format
const commandPaths = Array.isArray(entry.commands)
? entry.commands
: [entry.commands]
// Parallelize pathExists checks; process results in order.
const checks = await Promise.all(
commandPaths.map(async cmdPath => {
if (typeof cmdPath !== 'string') {
return { cmdPath, kind: 'invalid' as const }
}
const fullPath = join(pluginPath, cmdPath)
return {
cmdPath,
kind: 'path' as const,
fullPath,
exists: await pathExists(fullPath),
}
}),
)
const validPaths: string[] = []
for (const check of checks) {
if (check.kind === 'invalid') {
logForDebugging(
`Unexpected command format in marketplace entry for ${entry.name}`,
{ level: 'error' },
)
continue
}
if (check.exists) {
validPaths.push(check.fullPath)
} else {
logForDebugging(
`Command path ${check.cmdPath} from marketplace entry not found at ${check.fullPath} for ${entry.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${entry.name}`,
),
)
errors.push({
type: 'path-not-found',
source: pluginId,
plugin: entry.name,
path: check.fullPath,
component: 'commands',
})
}
}
if (validPaths.length > 0) {
plugin.commandsPaths = validPaths
}
}
}
// Process agents from marketplace entry
if (entry.agents) {
const agentPaths = Array.isArray(entry.agents)
? entry.agents
: [entry.agents]
const validPaths = await validatePluginPaths(
agentPaths,
pluginPath,
entry.name,
pluginId,
'agents',
'Agent',
'from marketplace entry',
errors,
)
if (validPaths.length > 0) {
plugin.agentsPaths = validPaths
}
}
// Process skills from marketplace entry
if (entry.skills) {
logForDebugging(
`Processing ${Array.isArray(entry.skills) ? entry.skills.length : 1} skill paths for plugin ${entry.name}`,
)
const skillPaths = Array.isArray(entry.skills)
? entry.skills
: [entry.skills]
// Parallelize pathExists checks; process results in order.
// Note: previously this loop called pathExists() TWICE per iteration
// (once in a debug log template, once in the if) β now called once.
const checks = await Promise.all(
skillPaths.map(async skillPath => {
const fullPath = join(pluginPath, skillPath)
return { skillPath, fullPath, exists: await pathExists(fullPath) }
}),
)
const validPaths: string[] = []
for (const { skillPath, fullPath, exists } of checks) {
logForDebugging(
`Checking skill path: ${skillPath} -> ${fullPath} (exists: ${exists})`,
)
if (exists) {
validPaths.push(fullPath)
} else {
logForDebugging(
`Skill path ${skillPath} from marketplace entry not found at ${fullPath} for ${entry.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${fullPath} for ${entry.name}`,
),
)
errors.push({
type: 'path-not-found',
source: pluginId,
plugin: entry.name,
path: fullPath,
component: 'skills',
})
}
}
logForDebugging(
`Found ${validPaths.length} valid skill paths for plugin ${entry.name}, setting skillsPaths`,
)
if (validPaths.length > 0) {
plugin.skillsPaths = validPaths
}
} else {
logForDebugging(`Plugin ${entry.name} has no entry.skills defined`)
}
// Process output styles from marketplace entry
if (entry.outputStyles) {
const outputStylePaths = Array.isArray(entry.outputStyles)
? entry.outputStyles
: [entry.outputStyles]
const validPaths = await validatePluginPaths(
outputStylePaths,
pluginPath,
entry.name,
pluginId,
'output-styles',
'Output style',
'from marketplace entry',
errors,
)
if (validPaths.length > 0) {
plugin.outputStylesPaths = validPaths
}
}
// Process inline hooks from marketplace entry
if (entry.hooks) {
plugin.hooksConfig = entry.hooks as HooksSettings
}
} else if (
!entry.strict &&
hasManifest &&
(entry.commands ||
entry.agents ||
entry.skills ||
entry.hooks ||
entry.outputStyles)
) {
// In non-strict mode with plugin.json, marketplace entries for commands/agents/skills/hooks/outputStyles are conflicts
const error = new Error(
`Plugin ${entry.name} has both plugin.json and marketplace manifest entries for commands/agents/skills/hooks/outputStyles. This is a conflict.`,
)
logForDebugging(
`Plugin ${entry.name} has both plugin.json and marketplace manifest entries for commands/agents/skills/hooks/outputStyles. This is a conflict.`,
{ level: 'error' },
)
logError(error)
errorsOut.push({
type: 'generic-error',
source: pluginId,
error: `Plugin ${entry.name} has conflicting manifests: both plugin.json and marketplace entry specify components. Set strict: true in marketplace entry or remove component specs from one location.`,
})
return null
} else if (hasManifest) {
// Has plugin.json - marketplace can supplement commands/agents/skills/hooks/outputStyles
// Supplement commands from marketplace entry
if (entry.commands) {
// Check if it's an object mapping
const firstValue = Object.values(entry.commands)[0]
if (
typeof entry.commands === 'object' &&
!Array.isArray(entry.commands) &&
firstValue &&
typeof firstValue === 'object' &&
('source' in firstValue || 'content' in firstValue)
) {
// Object mapping format - merge metadata
const commandsMetadata: Record<string, CommandMetadata> = {
...(plugin.commandsMetadata || {}),
}
const validPaths: string[] = []
// Parallelize pathExists checks; process results in order.
const entries = Object.entries(entry.commands)
const checks = await Promise.all(
entries.map(async ([commandName, metadata]) => {
if (!metadata || typeof metadata !== 'object' || !metadata.source) {
return { commandName, metadata, skip: true as const }
}
const fullPath = join(pluginPath, metadata.source)
return {
commandName,
metadata,
skip: false as const,
fullPath,
exists: await pathExists(fullPath),
}
}),
)
for (const check of checks) {
if (check.skip) continue
if (check.exists) {
validPaths.push(check.fullPath)
commandsMetadata[check.commandName] = check.metadata
} else {
logForDebugging(
`Command ${check.commandName} path ${check.metadata.source} from marketplace entry not found at ${check.fullPath} for ${entry.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${entry.name}`,
),
)
errors.push({
type: 'path-not-found',
source: pluginId,
plugin: entry.name,
path: check.fullPath,
component: 'commands',
})
}
}
if (validPaths.length > 0) {
plugin.commandsPaths = [
...(plugin.commandsPaths || []),
...validPaths,
]
plugin.commandsMetadata = commandsMetadata
}
} else {
// Path or array of paths format
const commandPaths = Array.isArray(entry.commands)
? entry.commands
: [entry.commands]
// Parallelize pathExists checks; process results in order.
const checks = await Promise.all(
commandPaths.map(async cmdPath => {
if (typeof cmdPath !== 'string') {
return { cmdPath, kind: 'invalid' as const }
}
const fullPath = join(pluginPath, cmdPath)
return {
cmdPath,
kind: 'path' as const,
fullPath,
exists: await pathExists(fullPath),
}
}),
)
const validPaths: string[] = []
for (const check of checks) {
if (check.kind === 'invalid') {
logForDebugging(
`Unexpected command format in marketplace entry for ${entry.name}`,
{ level: 'error' },
)
continue
}
if (check.exists) {
validPaths.push(check.fullPath)
} else {
logForDebugging(
`Command path ${check.cmdPath} from marketplace entry not found at ${check.fullPath} for ${entry.name}`,
{ level: 'warn' },
)
logError(
new Error(
`Plugin component file not found: ${check.fullPath} for ${entry.name}`,
),
)
errors.push({
type: 'path-not-found',
source: pluginId,
plugin: entry.name,
path: check.fullPath,
component: 'commands',
})
}
}
if (validPaths.length > 0) {
plugin.commandsPaths = [
...(plugin.commandsPaths || []),
...validPaths,
]
}
}
}
// Supplement agents from marketplace entry
if (entry.agents) {
const agentPaths = Array.isArray(entry.agents)
? entry.agents
: [entry.agents]
const validPaths = await validatePluginPaths(
agentPaths,
pluginPath,
entry.name,
pluginId,
'agents',
'Agent',
'from marketplace entry',
errors,
)
if (validPaths.length > 0) {
plugin.agentsPaths = [...(plugin.agentsPaths || []), ...validPaths]
}
}
// Supplement skills from marketplace entry
if (entry.skills) {
const skillPaths = Array.isArray(entry.skills)
? entry.skills
: [entry.skills]
const validPaths = await validatePluginPaths(
skillPaths,
pluginPath,
entry.name,
pluginId,
'skills',
'Skill',
'from marketplace entry',
errors,
)
if (validPaths.length > 0) {
plugin.skillsPaths = [...(plugin.skillsPaths || []), ...validPaths]
}
}
// Supplement output styles from marketplace entry
if (entry.outputStyles) {
const outputStylePaths = Array.isArray(entry.outputStyles)
? entry.outputStyles
: [entry.outputStyles]
const validPaths = await validatePluginPaths(
outputStylePaths,
pluginPath,
entry.name,
pluginId,
'output-styles',
'Output style',
'from marketplace entry',
errors,
)
if (validPaths.length > 0) {
plugin.outputStylesPaths = [
...(plugin.outputStylesPaths || []),
...validPaths,
]
}
}
// Supplement hooks from marketplace entry
if (entry.hooks) {
plugin.hooksConfig = {
...(plugin.hooksConfig || {}),
...(entry.hooks as HooksSettings),
}
}
}
errorsOut.push(...errors)
return plugin
}
/**
* Load session-only plugins from --plugin-dir CLI flag.
*
* These plugins are loaded directly without going through the marketplace system.
* They appear with source='plugin-name@inline' and are always enabled for the current session.
*
* @param sessionPluginPaths - Array of plugin directory paths from CLI
* @returns LoadedPlugin objects and any errors encountered
*/
async function loadSessionOnlyPlugins(
sessionPluginPaths: Array<string>,
): Promise<{ plugins: LoadedPlugin[]; errors: PluginError[] }> {
if (sessionPluginPaths.length === 0) {
return { plugins: [], errors: [] }
}
const plugins: LoadedPlugin[] = []
const errors: PluginError[] = []
for (const [index, pluginPath] of sessionPluginPaths.entries()) {
try {
const resolvedPath = resolve(pluginPath)
if (!(await pathExists(resolvedPath))) {
logForDebugging(
`Plugin path does not exist: ${resolvedPath}, skipping`,
{ level: 'warn' },
)
errors.push({
type: 'path-not-found',
source: `inline[${index}]`,
path: resolvedPath,
component: 'commands',
})
continue
}
const dirName = basename(resolvedPath)
const { plugin, errors: pluginErrors } = await createPluginFromPath(
resolvedPath,
`${dirName}@inline`, // temporary, will be updated after we know the real name
true, // always enabled
dirName,
)
// Update source to use the actual plugin name from manifest
plugin.source = `${plugin.name}@inline`
plugin.repository = `${plugin.name}@inline`
plugins.push(plugin)
errors.push(...pluginErrors)
logForDebugging(`Loaded inline plugin from path: ${plugin.name}`)
} catch (error) {
const errorMsg = errorMessage(error)
logForDebugging(
`Failed to load session plugin from ${pluginPath}: ${errorMsg}`,
{ level: 'warn' },
)
errors.push({
type: 'generic-error',
source: `inline[${index}]`,
error: `Failed to load plugin: ${errorMsg}`,
})
}
}
if (plugins.length > 0) {
logForDebugging(
`Loaded ${plugins.length} session-only plugins from --plugin-dir`,
)
}
return { plugins, errors }
}
/**
* Merge plugins from session (--plugin-dir), marketplace (installed), and
* builtin sources. Session plugins override marketplace plugins with the
* same name β the user explicitly pointed at a directory for this session.
*
* Exception: marketplace plugins locked by managed settings (policySettings)
* cannot be overridden. Enterprise admin intent beats local dev convenience.
* When a session plugin collides with a managed one, the session copy is
* dropped and an error is returned for surfacing.
*
* Without this dedup, both versions sat in the array and marketplace won
* on first-match, making --plugin-dir useless for iterating on an
* installed plugin.
*/
export function mergePluginSources(sources: {
session: LoadedPlugin[]
marketplace: LoadedPlugin[]
builtin: LoadedPlugin[]
managedNames?: Set<string> | null
}): { plugins: LoadedPlugin[]; errors: PluginError[] } {
const errors: PluginError[] = []
const managed = sources.managedNames
// Managed settings win over --plugin-dir. Drop session plugins whose
// name appears in policySettings.enabledPlugins (whether force-enabled
// OR force-disabled β both are admin intent that --plugin-dir must not
// bypass). Surface an error so the user knows why their dev copy was
// ignored.
//
// NOTE: managedNames contains the pluginId prefix (entry.name), which is
// expected to equal manifest.name by convention (schema description at
// schemas.ts PluginMarketplaceEntry.name). If a marketplace publishes a
// plugin where entry.name β manifest.name, this guard will silently miss β
// but that's a marketplace misconfiguration that breaks other things too
// (e.g., ManagePlugins constructs pluginIds from manifest.name).
const sessionPlugins = sources.session.filter(p => {
if (managed?.has(p.name)) {
logForDebugging(
`Plugin "${p.name}" from --plugin-dir is blocked by managed settings`,
{ level: 'warn' },
)
errors.push({
type: 'generic-error',
source: p.source,
plugin: p.name,
error: `--plugin-dir copy of "${p.name}" ignored: plugin is locked by managed settings`,
})
return false
}
return true
})
const sessionNames = new Set(sessionPlugins.map(p => p.name))
const marketplacePlugins = sources.marketplace.filter(p => {
if (sessionNames.has(p.name)) {
logForDebugging(
`Plugin "${p.name}" from --plugin-dir overrides installed version`,
)
return false
}
return true
})
// Session first, then non-overridden marketplace, then builtin.
// Downstream first-match consumers see session plugins before
// installed ones for any that slipped past the name filter.
return {
plugins: [...sessionPlugins, ...marketplacePlugins, ...sources.builtin],
errors,
}
}
/**
* Main plugin loading function that discovers and loads all plugins.
*
* This function is memoized to avoid repeated filesystem scanning and is
* the primary entry point for the plugin system. It discovers plugins from
* multiple sources and returns categorized results.
*
* Loading order and precedence (see mergePluginSources):
* 1. Session-only plugins (from --plugin-dir CLI flag) β override
* installed plugins with the same name, UNLESS that plugin is
* locked by managed settings (policySettings, either force-enabled
* or force-disabled)
* 2. Marketplace-based plugins (plugin@marketplace format from settings)
* 3. Built-in plugins shipped with the CLI
*
* Name collision: session plugin wins over installed. The user explicitly
* pointed at a directory for this session β that intent beats whatever
* is installed. Exception: managed settings (enterprise policy) win over
* --plugin-dir. Admin intent beats local dev convenience.
*
* Error collection:
* - Non-fatal errors are collected and returned
* - System continues loading other plugins on errors
* - Errors include source information for debugging
*
* @returns Promise resolving to categorized plugin results:
* - enabled: Array of enabled LoadedPlugin objects
* - disabled: Array of disabled LoadedPlugin objects
* - errors: Array of loading errors with source information
*/
export const loadAllPlugins = memoize(async (): Promise<PluginLoadResult> => {
const result = await assemblePluginLoadResult(() =>
loadPluginsFromMarketplaces({ cacheOnly: false }),
)
// A fresh full-load result is strictly valid for cache-only callers
// (both variants share assemblePluginLoadResult). Warm the separate
// memoize so refreshActivePlugins()'s downstream getPluginCommands() /
// getAgentDefinitionsWithOverrides() β which now call
// loadAllPluginsCacheOnly β see just-cloned plugins instead of reading
// an installed_plugins.json that nothing writes mid-session.
loadAllPluginsCacheOnly.cache?.set(undefined, Promise.resolve(result))
return result
})
/**
* Cache-only variant of loadAllPlugins.
*
* Same merge/dependency/settings logic, but the marketplace loader never
* hits the network (no cachePlugin, no copyPluginToVersionedCache). Reads
* from installed_plugins.json's installPath. Plugins not on disk emit
* 'plugin-cache-miss' and are skipped.
*
* Use this in startup consumers (getCommands, loadPluginAgents, MCP/LSP
* config) so interactive startup never blocks on git clones for ref-tracked
* plugins. Use loadAllPlugins() in explicit refresh paths (/plugins,
* refresh.ts, headlessPluginInstall) where fresh source is the intent.
*
* CLAUDE_CODE_SYNC_PLUGIN_INSTALL=1 delegates to the full loader β that
* mode explicitly opts into blocking install before first query, and
* main.tsx's getClaudeCodeMcpConfigs()/getInitialSettings().agent run
* BEFORE runHeadless() can warm this cache. First-run CCR/headless has
* no installed_plugins.json, so cache-only would miss plugin MCP servers
* and plugin settings (the agent key). The interactive startup win is
* preserved since interactive mode doesn't set SYNC_PLUGIN_INSTALL.
*
* Separate memoize cache from loadAllPlugins β a cache-only result must
* never satisfy a caller that wants fresh source. The reverse IS valid:
* loadAllPlugins warms this cache on completion so refresh paths that run
* the full loader don't get plugin-cache-miss from their downstream
* cache-only consumers.
*/
export const loadAllPluginsCacheOnly = memoize(
async (): Promise<PluginLoadResult> => {
if (isEnvTruthy(process.env.CLAUDE_CODE_SYNC_PLUGIN_INSTALL)) {
return loadAllPlugins()
}
return assemblePluginLoadResult(() =>
loadPluginsFromMarketplaces({ cacheOnly: true }),
)
},
)
/**
* Shared body of loadAllPlugins and loadAllPluginsCacheOnly.
*
* The only difference between the two is which marketplace loader runs β
* session plugins, builtins, merge, verifyAndDemote, and cachePluginSettings
* are identical (invariants 1-3).
*/
async function assemblePluginLoadResult(
marketplaceLoader: () => Promise<{
plugins: LoadedPlugin[]
errors: PluginError[]
}>,
): Promise<PluginLoadResult> {
// Load marketplace plugins and session-only plugins in parallel.
// getInlinePlugins() is a synchronous state read with no dependency on
// marketplace loading, so these two sources can be fetched concurrently.
const inlinePlugins = getInlinePlugins()
const [marketplaceResult, sessionResult] = await Promise.all([
marketplaceLoader(),
inlinePlugins.length > 0
? loadSessionOnlyPlugins(inlinePlugins)
: Promise.resolve({ plugins: [], errors: [] }),
])
// 3. Load built-in plugins that ship with the CLI
const builtinResult = getBuiltinPlugins()
// Session plugins (--plugin-dir) override installed ones by name,
// UNLESS the installed plugin is locked by managed settings
// (policySettings). See mergePluginSources() for details.
const { plugins: allPlugins, errors: mergeErrors } = mergePluginSources({
session: sessionResult.plugins,
marketplace: marketplaceResult.plugins,
builtin: [...builtinResult.enabled, ...builtinResult.disabled],
managedNames: getManagedPluginNames(),
})
const allErrors = [
...marketplaceResult.errors,
...sessionResult.errors,
...mergeErrors,
]
// Verify dependencies. Runs AFTER the parallel load β deps are presence
// checks, not load-order, so no topological sort needed. Demotion is
// session-local: does NOT write settings (user fixes intent via /doctor).
const { demoted, errors: depErrors } = verifyAndDemote(allPlugins)
for (const p of allPlugins) {
if (demoted.has(p.source)) p.enabled = false
}
allErrors.push(...depErrors)
const enabledPlugins = allPlugins.filter(p => p.enabled)
logForDebugging(
`Found ${allPlugins.length} plugins (${enabledPlugins.length} enabled, ${allPlugins.length - enabledPlugins.length} disabled)`,
)
// 3. Cache plugin settings for synchronous access by the settings cascade
cachePluginSettings(enabledPlugins)
return {
enabled: enabledPlugins,
disabled: allPlugins.filter(p => !p.enabled),
errors: allErrors,
}
}
/**
* Clears the memoized plugin cache.
*
* Call this when plugins are installed, removed, or settings change
* to force a fresh scan on the next loadAllPlugins call.
*
* Use cases:
* - After installing/uninstalling plugins
* - After modifying .claude-plugin/ directory (for export)
* - After changing enabledPlugins settings
* - When debugging plugin loading issues
*/
export function clearPluginCache(reason?: string): void {
if (reason) {
logForDebugging(
`clearPluginCache: invalidating loadAllPlugins cache (${reason})`,
)
}
loadAllPlugins.cache?.clear?.()
loadAllPluginsCacheOnly.cache?.clear?.()
// If a plugin previously contributed settings, the session settings cache
// holds a merged result that includes them. cachePluginSettings() on reload
// won't bust the cache when the new base is empty (the startup perf win),
// so bust it here to drop stale plugin overrides. When the base is already
// undefined (startup, or no prior plugin settings) this is a no-op.
if (getPluginSettingsBase() !== undefined) {
resetSettingsCache()
}
clearPluginSettingsBase()
// TODO: Clear installed plugins cache when installedPluginsManager is implemented
}
/**
* Merge settings from all enabled plugins into a single record.
* Later plugins override earlier ones for the same key.
* Only allowlisted keys are included (filtering happens at load time).
*/
function mergePluginSettings(
plugins: LoadedPlugin[],
): Record<string, unknown> | undefined {
let merged: Record<string, unknown> | undefined
for (const plugin of plugins) {
if (!plugin.settings) {
continue
}
if (!merged) {
merged = {}
}
for (const [key, value] of Object.entries(plugin.settings)) {
if (key in merged) {
logForDebugging(
`Plugin "${plugin.name}" overrides setting "${key}" (previously set by another plugin)`,
)
}
merged[key] = value
}
}
return merged
}
/**
* Store merged plugin settings in the synchronous cache.
* Called after loadAllPlugins resolves.
*/
export function cachePluginSettings(plugins: LoadedPlugin[]): void {
const settings = mergePluginSettings(plugins)
setPluginSettingsBase(settings)
// Only bust the session settings cache if there are actually plugin settings
// to merge. In the common case (no plugins, or plugins without settings) the
// base layer is empty and loadSettingsFromDisk would produce the same result
// anyway β resetting here would waste ~17ms on startup re-reading and
// re-validating every settings file on the next getSettingsWithErrors() call.
if (settings && Object.keys(settings).length > 0) {
resetSettingsCache()
logForDebugging(
`Cached plugin settings with keys: ${Object.keys(settings).join(', ')}`,
)
}
}
/**
* Type predicate: check if a value is a non-null, non-array object (i.e., a record).
*/
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value)
}
|