Dokumentacja programu MSBuild dla systemu projektu JavaScript

  • Artykuł

Ten artykuł zawiera informacje referencyjne dotyczące właściwości i elementów programu MSBuild, których można użyć do konfigurowania projektów na podstawie systemu JavaScript Project System (JSPS), które używają formatu esproj .

Uwaga

Właściwości opisane w tym artykule rozszerzają właściwości programu MSBuild domyślnie. Aby uzyskać listę typowych właściwości programu MSBuild, zobacz Typowe właściwości programu MSBuild.

Właściwości ShouldRun

Następujące właściwości programu MSBuild są udokumentowane w tej sekcji:

ShouldRunNpmInstall

Właściwość ShouldRunNpmInstall określa, czy uruchamiać polecenia kompilacji i przywracania, czy nie npm install . Wartość domyślna właściwości to true , jeśli nie jest ustawiona.

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

Dwa typowe scenariusze, w których nie uruchomiono npm install , są pożądane:

  1. Gdy używany jest menedżer pakietów innych niż npm (np. yarn lub pnpm). W tym scenariuszu najlepszym rozwiązaniem jest utworzenie obiektu docelowego uruchamianego przed BeforeRestore ręcznym uruchomieniem instalacji.
  2. Gdy w rozwiązaniu istnieje mechanizm instalacji pakietu globalnego, który sprawia, że uruchamianie poszczególnych instalacji jest niepotrzebne.

ShouldRunBuildScript

Właściwość ShouldRunBuildScript określa, czy należy uruchamiać npm run build polecenia kompilacji. Wartość domyślna właściwości to true , jeśli nie jest ustawiona.

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

W przypadku projektów zawierających tylko język JavaScript, który nie wymaga kompilowania, ustaw tę właściwość na falsewartość . Nowo utworzone projekty React, Vue i Angular zwykle należą do tej kategorii. W tym scenariuszu kompilacja jest używana do środowiska produkcyjnego, a nie do debugowania. Należy pamiętać, że Build polecenia i Publish są oddzielone w projektach JSPS i Publish nadal są uruchamiane nawet wtedy, gdy ta właściwość jest ustawiona.

Właściwości polecenia

Właściwości polecenia to właściwości przeznaczone do mapowania typowych skryptów package.json na obiekty docelowe programu MSBuild. Wartości domyślne są obsługiwane dla wszystkich tych właściwości, zgodnie z opisem w tej sekcji.

Ustaw te właściwości podczas korzystania z menedżerów pakietów innych niż npm lub aparatów skryptów, takich jak gulp.

Następujące właściwości programu MSBuild zostały opisane w tej sekcji:

Kompilujpolecenia

Właściwość BuildCommand określa zachowanie obiektu build docelowego. Jeśli skojarzony plik package.json zawiera build skrypt lub compile , wartość domyślna BuildCommand jest już ustawiona, aby je uruchomić.

Aby zmodyfikować polecenie, uwzględnij npm run element w przypadku używania polecenia npm.

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

StartupCommand

Właściwość StartupCommand określa zachowanie obiektu dotnet run docelowego. Jeśli skojarzony package.json skrypt zawiera startskrypt , serverlub dev , wartość domyślna StartupCommand jest już ustawiona na uruchomienie tych skryptów.

Jeśli zmodyfikujesz polecenie, uwzględnij npm run je podczas korzystania z polecenia npm.

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

Polecenie testowe

Właściwość TestCommand określa zachowanie obiektu test docelowego. Jeśli skojarzony package.json skrypt zawiera test skrypt, wartość domyślna TestCommand jest już ustawiona na uruchomienie tego skryptu.

Jeśli zmodyfikujesz polecenie, uwzględnij npm run je podczas korzystania z polecenia npm.

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

CleanCommand

Właściwość CleanCommand określa zachowanie obiektu clean docelowego. Jeśli skojarzony package.json skrypt zawiera clean skrypt, wartość domyślna CleanCommand jest już ustawiona na uruchomienie tego skryptu.

Jeśli zmodyfikujesz polecenie, uwzględnij npm run je podczas korzystania z polecenia npm.

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

Publikujpolecenia

Właściwość PublishCommand określa zachowanie obiektu publish docelowego. Jeśli skojarzony package.json skrypt zawiera publish skrypt, wartość domyślna PublishCommand jest już ustawiona na uruchomienie tego skryptu. W narzędziu npm często używane są skrypty wstępne i po opublikowaniu, które również będą uruchamiane.

Jeśli zmodyfikujesz polecenie, uwzględnij npm run je podczas korzystania z polecenia npm.

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

Zobacz też