ReSharper 2016.3 Help

ReSharper by Language: MSBuild

MSBuild is a platform that is widely used for building applications. Using specific XML tags, you can define how your project should be built or executed. Using ReSharper you can do it faster.

Code inspection

If you mistype names of predefined elements or their attributes, ReSharper informs you about such mismatch via highlighting.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Code_Highlighting_02.png

If you try to reference the property that is not yet defined, ReSharper detects such cases as well.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Code_Highlighting_01.png

To look through the list of available inspections for MSBuild, open the Code Inspection | Inspection Severity page of ReSharper options, and then expand the MSBuild node.

Examples of quick-fixes

Define property
If you have not defined the property yet, but want to, use the quick-fix. ReSharper adds a new markup element with the corresponding name above the usage.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Quick-Fixes__define_property_01.png

Add required attribute
If for some reason you have not added required attributes or even do not remember what attributes are obligatory for an element, do not bother. ReSharper highlights such elements and suggests the quick-fix to fix the problem.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Quick-Fixes__add_attribute_01.png

Code completion

Code completion features are helpful when you start typing predefined elements and their attributes. ReSharper completes them, you save your time.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Code_Completion_01.png

If you have custom elements and they are properly referenced, ReSharper also suggests them.
/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Code_Completion_02.png

ReSharper provides code completion capabilities for MSBuild and NAnt scripts. It suggests tags, their attributes, properties, item groups and metadata names.
/help/img/dotnet/2016.3/Coding_Assistance__Code_Completion__Symbol__build_scripts_01.png
ReSharper distinguishes required elements and adds special icon, so you can easily find them in the completion list. The list includes all symbols visible in the current scope, so pick an item from the list or continue typing to narrow down the scope.
/help/img/dotnet/2016.3/Coding_Assistance__Code_Completion__Symbol__build_scripts_02.png
To invoke the completion list in NAnt scripts, press Ctrl+Space or select ReSharper | Edit | Complete Symbol. In MSBuild scripts ReSharper does it for you, automatically.
In the completion list you see special icons. They help you distinguish between the types of suggested items.

/help/img/dotnet/2016.3/ThemedIcon.PropertyGroup.Screen.[Gray].png represents the PropertyGroup element only
/help/img/dotnet/2016.3/ThemedIcon.Attribute.Screen.[Gray].png represents attributes of elements
/help/img/dotnet/2016.3/ThemedIcon.ItemGroup.Screen.[Gray].png represents the ItemGroup element and its items
/help/img/dotnet/2016.3/ThemedIcon.Property.Screen.[Gray].png represents properties
/help/img/dotnet/2016.3/ThemedIcon.Target.Screen.[Gray].png represents the Target element and targets
/help/img/dotnet/2016.3/ThemedIcon.Task.Screen.[Gray].png represents tasks
/help/img/dotnet/2016.3/ThemedIcon.UsingTask.Screen.[Gray].png represents the UsingTask element only
/help/img/dotnet/2016.3/ThemedIcon.Element.Screen.[Gray].png represents all other structure elements

Navigation

To get a general idea about the structure of your build file, use the File Structure window. You can also double-click an element to navigate directly from the tree to its declaration in source code.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__File_Structure.png

Use Navigate To features to jump to the declaration of a symbol or move through found usages.
/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Navigate_To.png

Search

ReSharper can find usages of properties, item groups and targets. All found usages are listed in the Find Results window.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Find_Usages.png

Refactorings

You can easily rename an element and get its usages updated correspondingly. For more information about the refactoring, see Rename refactoring.

/help/img/dotnet/2016.3/ReSharper_by_Language__MSBuild__Refactorings__Rename_01.png

You can delete elements safely. Before removing an element ReSharper performs a check whether the element has usages or not. If there are usages, they will be listed so that you can make necessary changes or discard the refactoring. For more information about the refactoring, see Safe Delete refactoring.

See Also

Last modified: 12 January 2017