sfdx-project.json

Het configuratiebestand aan de basis van elk source-format project, dat pakketmappen, namespace en pakketafhankelijkheden declareert.

Definitie

sfdx-project.json is het configuratiebestand dat elke Salesforce CLI-opdracht leest aan de basis van een source-format project. Het declareert de pakketmappen (waar source zich bevindt, en welke het standaard doel is voor retrieve), de sourceApiVersion, de geregistreerde namespace indien aanwezig, en, voor 2GP-projecten, de lijst met pakketten met hun aliassen en gedeclareerde afhankelijkheden van elkaars versies. Het is wat een map herkenbaar maakt als Salesforce-project voor de CLI, VS Code-extensies en CI-tools, en het is het bestand dat package aliases bijhoudt naarmate nieuwe versies worden aangemaakt, zodat een leesbare naam wordt gekoppeld aan het daadwerkelijke versie-ID dat Salesforce toewijst. Een misvormde of verouderde sfdx-project.json is een veelvoorkomende bron van verwarrende CLI-fouten, vooral rond dependency-resolutie. Onze Salesforce CLI-gids behandelt de structuur van het bestand uitgebreider.

In de praktijk

Hoe het werkt in Serpent

Serpent leest de sfdx-project.json van een project automatisch om pakketstructuur en afhankelijkheden te begrijpen, en werkt package aliases en versiereferenties bij naarmate builds en promoties plaatsvinden, zodat niemand het bestand na elke release met de hand hoeft te bewerken. Multi-package repo's met gedeclareerde afhankelijkheden werken op dezelfde manier als single-package repo's, zonder extra configuratie. Zie de Serpent VS Code-extensie voor hoe projectconfiguratie synchroniseert met lokale ontwikkeling.

Veelgestelde vragen