aarnott / readonlysourcetree Goto Github PK

7.0 2.0 3.0 45 KB

A NuGet package that makes your project build to top-level bin and obj directories.

License: Other

C# 100.00%

readonlysourcetree's Introduction

Read only source tree

This project contains a NuGet package that will cause any project it is installed into to build its primary output and intermediate files to bin and obj directories at the root of your repository instead of as subdirectories to the project directory.

This makes structuring your repository after this pattern much easier:

RepoRoot\
    README.md
    LICENSE
    src\
        solution.sln
        project1\
        project2\
    bin\
        debug\
            project1\
            project2\
    obj\
        debug\
            project1\
            project2\
    packages\
        binary_dependency1\
        binary_dependency2\

This isolation of source files from build outputs can be useful for many reasons, including:

Delete all build outputs for your entire repository just by deleting the top level bin and obj folders.
Zip up your src directory and only get source -- no binaries.

Additional steps

Identifying the root of your repository

Heuristics are used by default to determine where the root of your repository is. You can see the heuristics in this MSBuild file's definition of the MSBuild RepoRoot property. It looks for files that are commonly found in the root of the repo. If the heuristics don't fit your repository, you can create an empty .RepoSrcRoot file in the top-level src folder of your repository.

Consolidate all NuGet packages

By default NuGet will expand packages to a directory beneath your solution directory. To get it to install packages to a sibling of your src directory instead, create a nuget.config file in the root of your repository with this content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <config>
    <add key="repositorypath" value="packages" />
  </config>
</configuration>

readonlysourcetree's People

Contributors

Stargazers

Watchers

Forkers

cammouren bubdm

readonlysourcetree's Issues

Test Explorer does not show tests when test project

Build folder and Intermediate build folder are created and used inside the project folder

Steps to repro:
-Zip the current repo
-Extract the "DefaultCSharpClassLibrary" folder
-Open it Under VS14.0.24720.0 CE using File->Open-Project/Solution
-Save a solution file under the parent folder ".."
-Modify MSBuild project build output verbosity in VS to diagnostic
-Restore the "ReadOnlySourceTree" Nuget package updating it to the current latest (1.13)
-Clean the solution
-Build the solution
-Copy and paste MSBuild output to a log file (attached in for my system here... sorry but in french because I have not found a way to output it in english)
MSBuildLog.txt

Support bin/obj folders that require $(platform) distinguishers

When a project builds for AnyCPU and x86, for example, the default output folders move x86 to a subfolder. This project should do the same thing.

IntermediateOutputPath needs to be set before .targets

The ReadOnlySourceTree.targets may not be imported before other NuGet packages that need to read such properties as IntermediateOutputPath. This causes build failures in consuming projects because other .targets will read the properties during evaluation model and try to write to files in directories that do not exist.

DocumentationFile is not redirected properly to the binaries location

Nuget package: ReadOnlySourceTree.0.1.37-beta
A csproj uses this Nuget package and has this property:

  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    ...
    <DocumentationFile>bin\Debug\Foo.xml</DocumentationFile>
    ...
  </PropertyGroup>

Build fails with this error:

CSC : error CS0016: Could not write to output file '.....\bin\Debug\Foo.xml' -- 'Could not find a part of the path

It looks like the build doesn't set the DocumentationFile property to point to the same folder at the binary.

The workaround is to have this property. The condition is for ensuring that the documentation file is not generated when the project is being built by GenerateTemporaryTargetAssembly, when ReadOnlySourceTree is not imported.

<DocumentationFile Condition="'$(OutputPath)' != ''">$(OutputPath)$(AssemblyName).xml</DocumentationFile>

Add tests to verify output groups have correct paths

I'm pretty sure the xml documentation output group will have the wrong path. Others may also.

Support for native projects

(first: this is a great project--thanks!)

I tried adding the ReadOnlySourceTree NuGet package to a solution that contained a native DLL project. It correctly got rid of the bin/obj directories from under the native DLL's project source directory, but instead of the resulting native DLLs going into \bin, they just went at the root (\x64\Debug and \x64\Release for x64 binaries; \Debug and \Release for x86 binaries.

FxCop doesn't recognize the redirected output path

Suppress XML doc file generation under project folder

Because the C#/VB project systems tend to write out the explicit project-relative output path for the XML file, it needs to be explicitly rewritten in the readonlysourcetree.targets to prevent its generation under src. It is already copied to the proper bin folder. We just need to keep it out of the wrong folder in the first place.