MSBuild-Referenz für JavaScript Project System

  • Artikel

Dieser Artikel enthält Referenzinformationen zu den MSBuild-Eigenschaften und -Elementen, mit denen Sie Projekte basierend auf JavaScript Project System (JSPS) konfigurieren können, die das Format .esproj nutzen.

Hinweis

Die in diesem Artikel beschriebenen Eigenschaften erweitern standardmäßig die von MSBuild bereitgestellten Eigenschaften. Eine Liste der gängigen MSBuild-Eigenschaften finden Sie unter Gemeinsame MSBuild-Projekteigenschaften.

ShouldRun-Eigenschaften

Die folgenden MSBuild-Eigenschaften sind in diesem Abschnitt dokumentiert:

ShouldRunNpmInstall

Die Eigenschaft ShouldRunNpmInstall gibt an, ob npm install für Build- und Wiederherstellungsbefehle ausgeführt werden soll. Der Standardwert für die Eigenschaft lautet true, falls er nicht festgelegt wird.

<PropertyGroup>
  <ShouldRunNpmInstall>false</ShouldRunNpmInstall>
</PropertyGroup>

Zwei gängige Szenarien, in denen es wünschenswert ist, npm install nicht auszuführen:

  1. Wenn ein Nicht-npm-Paket-Manager (z. B. Yarn oder pnpm) verwendet wird. In diesem Szenario besteht die beste Lösung darin, ein Ziel zu erstellen, das vor BeforeRestore ausgeführt wird, um die Installation manuell auszuführen.
  2. Wenn in der Lösung ein globaler Paketinstallationsmechanismus vorhanden ist, der die Ausführung einzelner Installationen unnötig macht

ShouldRunBuildScript

Die Eigenschaft ShouldRunBuildScript gibt an, ob npm run build für Buildbefehle ausgeführt werden soll. Der Standardwert für die Eigenschaft lautet true, falls er nicht festgelegt wird.

<PropertyGroup>
  <ShouldRunNpmBuildScript>false</ShouldRunNpmBuildScript>
</PropertyGroup>

Legen Sie für Projekte, die nur JavaScript enthalten und keine Erstellung erfordern, diese Eigenschaft auf false fest. Neu erstellte React-, Vue- und Angular-Projekte fallen in der Regel in diese Kategorie. In diesem Szenario wird „build“ für die Produktion und nicht für das Debuggen verwendet. Beachten Sie, dass die Befehle Build und Publish in JSPS-Projekten getrennt sind und Publish auch dann weiterhin ausgeführt wird, wenn diese Eigenschaft festgelegt ist.

Command Properties

Befehlseigenschaften sind Eigenschaften, die zum Zuordnen allgemeiner package.json-Skripts zu MSBuild-Zielen vorgesehen sind. Standardwerte werden für alle diese Eigenschaften unterstützt, wie in diesem Abschnitt beschrieben.

Legen Sie diese Eigenschaften fest, wenn Sie andere Paket-Manager als npm oder Skript-Engines wie gulp verwenden.

Die folgenden MSBuild-Eigenschaften werden in diesem Abschnitt beschrieben:

BuildCommand

Die Eigenschaft BuildCommand gibt das Verhalten für das Ziel build an. Wenn die zugeordnete Datei vom Typ package.json ein build- oder compile-Skript enthält, ist der BuildCommand-Standardwert bereits festgelegt, um sie auszuführen.

Um den Befehl zu ändern, schließen Sie npm run bei Verwendung von npm ein.

<PropertyGroup>
  <BuildCommand>npm run build</BuildCommand>
</PropertyGroup>

StartupCommand

Die Eigenschaft StartupCommand gibt das Verhalten für das Ziel dotnet run an. Wenn die zugeordnete Datei vom Typ package.json ein start-, server- oder dev-Skript enthält, ist der StartupCommand-Standardwert bereits festgelegt, um sie auszuführen.

Wenn Sie den Befehl ändern, schließen Sie npm run bei Verwendung von npm ein.

<PropertyGroup>
  <StartupCommand>npm run serve</StartupCommand>
</PropertyGroup>

TestCommand

Die Eigenschaft TestCommand gibt das Verhalten für das Ziel test an. Wenn die zugeordnete Datei vom Typ package.json ein test-Skript enthält, ist der TestCommand-Standardwert bereits festgelegt, um dieses Skript auszuführen.

Wenn Sie den Befehl ändern, schließen Sie npm run bei Verwendung von npm ein.

<PropertyGroup>
  <TestCommand>ng test</TestCommand>
</PropertyGroup>

CleanCommand

Die Eigenschaft CleanCommand gibt das Verhalten für das Ziel clean an. Wenn die zugeordnete Datei vom Typ package.json ein clean-Skript enthält, ist der CleanCommand-Standardwert bereits festgelegt, um dieses Skript auszuführen.

Wenn Sie den Befehl ändern, schließen Sie npm run bei Verwendung von npm ein.

<PropertyGroup>
  <CleanCommand>npm run clean</CleanCommand>
</PropertyGroup>

PublishCommand

Die Eigenschaft PublishCommand gibt das Verhalten für das Ziel publish an. Wenn die zugeordnete Datei vom Typ package.json ein publish-Skript enthält, ist der PublishCommand-Standardwert bereits festgelegt, um dieses Skript auszuführen. In npm gibt es üblicherweise auch Skripts, die vor und nach der Veröffentlichung ausgeführt werden.

Wenn Sie den Befehl ändern, schließen Sie npm run bei Verwendung von npm ein.

<PropertyGroup>
  <PublishCommand>npm run publish</PublishCommand>
</PropertyGroup>

Siehe auch