Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 4.21 KB

README.md

File metadata and controls

100 lines (63 loc) · 4.21 KB
Raw

Roslyn Hot Reload delta generator

Simple roslyn E&C driver.

Is this the right tool?

For integration into MS Build projects, see ../Microsoft.DotNet.HotReload.Utils.Generator.BuildTool README.md

The standalone hotreload-delta-gen tool is more useful for one-off experiments in which case it is best to install it as a global dotnet tool.

How to install from the dotnet9-transport NuGet feed

Preview versions are published to the dotnet10-transport feed.

dotnet tool install --global --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet10-transport/nuget/v3/index.json hotreload-delta-gen --version [LATEST_VER]

Where [LATEST_VER] is the latest published version (dotnet tool install will tell you the latest available if you omit the --version argument)

Then run the tool as hotreload-delta-gen assuming that ${HOME}/.dotnet/tools is in your PATH.

How to build manually

Run build.sh -restore -build -publish -pack -c Release from the repo root.

That will create the executable artifacts/bin/hotreload-delta-gen/Release/<dotnet version>/publish/hotreload-delta-gen.

How to use it

Usage: hotreload-delta-gen.exe -msbuild:project.csproj [-p:MSBuildProp=Value ...] [-live|-script:script.json [-outputSummary:result.json]]

Example (scripted)

The diff expects that a .csproj has already been compiled to generate a baseline, and then it reads a script of changes to apply to the baseline to generate deltas. Additional properties may be passed to msbuild (for example to identify the build configuration).

dotnet build example/TestClass.csproj /p:Configuration=Debug

dotnet run --project src/hotreload-delta-gen.csproj -- -msbuild:example/TestClass.csproj -p:Configuration=Debug -script:example/diffscript.json -outputSummary:result.json

mdv ../artifacts/TestClass/bin/Debug/net5.0/TestClass.dll /il- /g:../artifacts/TestClass/bin/Debug/net5.0/TestClass.dll.1.dmeta /g:../artifacts/TestClass/bin/Debug/net5.0/TestClass.dll.2.dmeta

Use msbuild to build the project first, then run hotreload-delta-gen to generate a delta with respect to the msbuild-produced baseline.

The format of the JSON script is

{"changes":
    [
        {"document": "relativePath/to/file.cs", "update": "relativePath/to/file_v1.cs"},
        {"document": "file2.cs", "update": "file2_v2.cs"},
        {"document": "relativePath/to/file.cs", "update": "relativePath/to/file_v3.cs"}
    ]
}

The update files can have arbitrary names. The document files should be part of the specified .csproj. Zero or more updates may be included.

The tool will error out if one of the files contains a rude edit or no edits at all.

Each update file file_vN.cs must include the complete cumulative code from file.cs, too, not just the latest changes.

The output summary file will be of the form:

{"deltas": [
    {"assembly": "TestClass.dll", "metadata": ".../TestClass.dll.1.dmeta", "il": ".../TestClass.dll.1.dil", "pdb": ".../TestClass.dll.1.dpdb"},
    {"assembly": "TestClass.dll", "metadata": ".../TestClass.dll.2.dmeta", "il": ".../TestClass.dll.2.dil", "pdb": ".../TestClass.dll.2.dpdb"},
]}

A runnable example is in example/. Build it with dotnet build and it will invoke hotreload-delta-gen to generate deltas.

Example (live coding)

Pass the -live option to start a file system watcher (in the directory of the .csproj to watch for changes). Each time a .cs file is saved, the tool will generate a delta

dotnet build example/TestClass.csproj /p:Configuration=Debug

dotnet run --project src/hotreload-delta-gen.csproj -- -msbuild:example/TestClass.csproj -p:Configuration=Debug -live
# make a change to TestClass.cs and save
# tool generates a delta
# Ctrl-C to terminate

The tool will error out if the file contains a rude edit, or but if a file is semantically unchanged (e.g. comments edited) it will ignore the change and wait for the next one.

Output location

If the baseline files are in DIR/assembly.dll and DIR/assembly.pdb, then roslynildiff saves the deltas to DIR/assembly.dll.1.{dmeta,dil,dpdb}, DIR/assembly.dll.2.{dmeta,dil,dpdb} etc...