diff options
| -rw-r--r-- | docs/mod-build-config.md | 4 | ||||
| -rw-r--r-- | src/SMAPI.ModBuildConfig/build/smapi.targets | 4 | ||||
| -rw-r--r-- | src/SMAPI.ModBuildConfig/package.nuspec | 1 |
3 files changed, 8 insertions, 1 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md index 4ffc34a9..22180059 100644 --- a/docs/mod-build-config.md +++ b/docs/mod-build-config.md @@ -8,7 +8,8 @@ The package... * packages the mod into your `Mods` folder when you rebuild the code (configurable); * creates a release zip (configurable); * configures Visual Studio to enable debugging into the code when the game is running (_Windows only_); -* adds C# analyzers to warn for Stardew Valley-specific issues. +* adds C# analyzers to warn for Stardew Valley-specific issues; +* preconfigures common settings (e.g. enable line numbers in stack traces). ## Contents * [Install](#install) @@ -233,6 +234,7 @@ _[Game path](#game-path)_ above. * For projects using the new `.csproj` format: * platform target is now set to x86 automatically to avoid mismatching platform target warnings; * added GAC to assembly search paths to fix references to XNA Framework. +* Builds now include `.pdb` files by default, to enable line numbers in error stack traces. * Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly. * Fixed `<IgnoreModFilePatterns>` not working for `i18n` files. * Dropped support for older versions of SMAPI and Visual Studio. diff --git a/src/SMAPI.ModBuildConfig/build/smapi.targets b/src/SMAPI.ModBuildConfig/build/smapi.targets index 103e996a..f797b0d1 100644 --- a/src/SMAPI.ModBuildConfig/build/smapi.targets +++ b/src/SMAPI.ModBuildConfig/build/smapi.targets @@ -17,6 +17,10 @@ <Platforms>x86</Platforms> <PlatformTarget>x86</PlatformTarget> + <!-- include PDB file by default to enable line numbers in stack traces --> + <DebugType>pdbonly</DebugType> + <DebugSymbols>true</DebugSymbols> + <!-- recognise XNA Framework DLLs in the GAC (only affects mods using new csproj format) --> <AssemblySearchPaths>$(AssemblySearchPaths);{GAC}</AssemblySearchPaths> diff --git a/src/SMAPI.ModBuildConfig/package.nuspec b/src/SMAPI.ModBuildConfig/package.nuspec index e82bded4..d7860ee1 100644 --- a/src/SMAPI.ModBuildConfig/package.nuspec +++ b/src/SMAPI.ModBuildConfig/package.nuspec @@ -19,6 +19,7 @@ - For projects using the new `.csproj` format: - platform target is now set to x86 automatically to avoid mismatching platform target warnings; - added GAC to assembly search paths to fix references to XNA Framework. + - Builds now include `.pdb` files by default, to enable line numbers in error stack traces. - Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly. - Fixed `<IgnoreModFilePatterns>` not working for `i18n` files. - Dropped support for older versions of SMAPI and Visual Studio. |