Fix publish targets

microsoft · Nov 6, 2023 · 870e908 · 870e908
1 parent 95fba96
commit 870e908
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 18 deletions.
diff --git a/examples/Directory.Packages.props b/examples/Directory.Packages.props
@@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <!-- False is the default, but this overrides the True value in the project root. -->
+    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
+  </PropertyGroup>
+</Project>
diff --git a/examples/aot-module/aot-module.csproj b/examples/aot-module/aot-module.csproj
@@ -2,7 +2,6 @@
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PublishAot>true</PublishAot>
     <PublishNodeModule>true</PublishNodeModule>

diff --git a/examples/aot-npm-package/lib/aot-npm-package.csproj b/examples/aot-npm-package/lib/aot-npm-package.csproj
@@ -2,13 +2,21 @@
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
+
+    <!-- The C# xmldoc file is converted to comments in the generated TS type definitions. -->
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
+    <!-- `dotnet publish` will produce node module files in $(PublishDir), with
+      .node native AOT binary files under $(RuntimeIdentifier) subdirectories. -->
     <PublishAot>true</PublishAot>
     <PublishNodeModule>true</PublishNodeModule>
-    <PublishDir>bin</PublishDir><!-- Publish the .node binary to this location. -->
+    <PublishDir>bin</PublishDir>
+    <PublishMultiPlatformNodeModule>true</PublishMultiPlatformNodeModule>
+
+    <!-- `dotnet publish` will produce an npm package in the $(PackageOutputPath) directory. -->
+    <!-- `package.json` is required in the project directory; `.npmignore` is also recommended. -->
     <PackNpmPackage>true</PackNpmPackage>
-    <PackageOutputPath>pkg</PackageOutputPath><!-- Publish the npm .tgz packge to this location.-->
+    <PackageOutputPath>pkg</PackageOutputPath>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/examples/dotnet-module/dotnet-module.csproj b/examples/dotnet-module/dotnet-module.csproj
@@ -2,7 +2,6 @@
 
   <PropertyGroup>
     <TargetFramework>net472</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <OutDir>bin</OutDir>
     <LangVersion>10</LangVersion>

diff --git a/examples/hermes-engine/hermes-engine.csproj b/examples/hermes-engine/hermes-engine.csproj
@@ -3,7 +3,6 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <RootNamespace>Hermes.Example</RootNamespace>

diff --git a/examples/semantic-kernel/semantic-kernel.csproj b/examples/semantic-kernel/semantic-kernel.csproj
@@ -2,7 +2,6 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
     <RestorePackagesPath>$(MSBuildThisFileDirectory)/pkg</RestorePackagesPath>
     <OutDir>bin</OutDir>
     <NodeApiAssemblyJSModuleType>esm</NodeApiAssemblyJSModuleType>

diff --git a/examples/winui-fluid/winui-fluid.csproj b/examples/winui-fluid/winui-fluid.csproj
@@ -4,7 +4,6 @@
     <TargetFramework>net8.0-windows10.0.22000.0</TargetFramework>
     <TargetPlatformMinVersion>10.0.22000.0</TargetPlatformMinVersion>
     <OutputType>WinExe</OutputType>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
 
     <!-- WinUI 3 -->
     <UseWinUI>true</UseWinUI>

diff --git a/examples/wpf/WpfExample.csproj b/examples/wpf/WpfExample.csproj
@@ -2,7 +2,6 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0-windows</TargetFramework>
-    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
     <RestorePackagesPath>$(MSBuildThisFileDirectory)/pkg</RestorePackagesPath>
     <OutDir>bin</OutDir>
     <NodeApiAssemblyJSModuleType>esm</NodeApiAssemblyJSModuleType>

diff --git a/src/NodeApi/NodeApi.targets b/src/NodeApi/NodeApi.targets
@@ -4,23 +4,27 @@
     BeforeTargets="PublishManagedAssembly"
     Condition=" '$(PublishNodeModule)' == 'true' "
   >
-    <!-- Rename the native library (and its symbols file) to have a .node extension. -->
-    <!-- Put them in a rid-specific subdirectory to support publishing for multiple platforms. -->
-
-    <MakeDir Directories="$(PublishDir)$(RuntimeIdentifier)" />
+    <!-- If publishing a node module for for multiple platforms, use an rid-specific subdir. -->
+    <PropertyGroup>
+      <PublishNodeModuleDir  Condition=" '$(PublishMultiPlatformNodeModule)' != 'true' ">$(PublishDir)</PublishNodeModuleDir>
+      <PublishNodeModuleDir  Condition=" '$(PublishMultiPlatformNodeModule)' == 'true' ">$(PublishDir)$(RuntimeIdentifier)/</PublishNodeModuleDir>
+    </PropertyGroup>
+    <MakeDir Directories="$(PublishNodeModuleDir)" />
 
+    <!-- Rename/move the native library (and its symbols file) to have a .node extension. -->
     <Move SourceFiles="$(PublishDir)$(TargetName)$(NativeBinaryExt)"
-      DestinationFiles="$(PublishDir)$(RuntimeIdentifier)/$(TargetName).node" />
+      DestinationFiles="$(PublishNodeModuleDir)$(TargetName).node" />
     <Move Condition="Exists('$(PublishDir)$(TargetName).pdb')"
       SourceFiles="$(PublishDir)$(TargetName).pdb"
-      DestinationFiles="$(PublishDir)$(RuntimeIdentifier)/$(TargetName).node.pdb" />
+      DestinationFiles="$(PublishNodeModuleDir)$(TargetName).node.pdb" />
     <Move Condition="Exists('$(PublishDir)$(TargetName).so.dbg')"
       SourceFiles="$(PublishDir)$(TargetName).so.dbg"
-      DestinationFiles="$(PublishDir)$(RuntimeIdentifier)/$(TargetName).node.dbg" />
+      DestinationFiles="$(PublishNodeModuleDir)$(TargetName).node.dbg" />
 
     <!-- Add a non-rid-specific JS file that redirects to the rid-specific binary. -->
-    <!-- (The rid code is copied from node-api-dotnet/init.js.) -->
-    <WriteLinesToFile File="$(PublishDir)$(TargetName).js" Overwrite="true" Lines=";
+    <!-- (The rid code is the same as node-api-dotnet/init.js.) -->
+    <WriteLinesToFile Condition=" '$(PublishMultiPlatformNodeModule)' == 'true' "
+      File="$(PublishDir)$(TargetName).js" Overwrite="true" Lines=";
 const ridPlatform =
   process.platform === 'win32' ? 'win' :
   process.platform === 'darwin' ? 'osx' :
@@ -36,6 +40,7 @@ module.exports = require(`./${rid}/$(TargetName).node`);
     BeforeTargets="PublishManagedAssembly"
     Condition=" '$(PackNpmPackage)' == 'true' "
   >
+    <MakeDir Directories="$(PackageOutputPath)" />
     <Exec Command="npm pack --pack-destination=&quot;$(PackageOutputPath)&quot;" />
   </Target>
 </Project>