Skip to content

Instantly share code, notes, and snippets.

@Jakob-PB

Jakob-PB/csharp-layout-improved.xml

Created November 7, 2020 08:35
Show Gist options
  • Save Jakob-PB/2280e66fa1eb28e9ebaf01e9200d24c2 to your computer and use it in GitHub Desktop.
Save Jakob-PB/2280e66fa1eb28e9ebaf01e9200d24c2 to your computer and use it in GitHub Desktop.
Download ZIP
C# layout templates for Rider code cleanup. Covers Unity classes and standard C# classes. Focused on clearly delineating member types and the public interface of a class via regions.
Raw
csharp-layout-improved.xml
<Patterns xmlns="urn:schemas-jetbrains-com:member-reordering-patterns">
<TypePattern DisplayName="Non-reorderable types">
<TypePattern.Match>
<Or>
<And>
<Kind Is="Interface" />
<Or>
<HasAttribute Name="System.Runtime.InteropServices.InterfaceTypeAttribute" />
<HasAttribute Name="System.Runtime.InteropServices.ComImport" />
</Or>
</And>
<Kind Is="Struct" />
<HasAttribute Name="JetBrains.Annotations.NoReorderAttribute" />
<HasAttribute Name="JetBrains.Annotations.NoReorder" />
</Or>
</TypePattern.Match>
</TypePattern>
<TypePattern DisplayName="xUnit.net Test Classes" RemoveRegions="All">
<TypePattern.Match>
<And>
<Kind Is="Class" />
<HasMember>
<And>
<Kind Is="Method" />
<HasAttribute Name="Xunit.FactAttribute" Inherited="True" />
<HasAttribute Name="Xunit.TheoryAttribute" Inherited="True" />
</And>
</HasMember>
</And>
</TypePattern.Match>
<Region Name="Setup/Teardown">
<Entry DisplayName="Setup/Teardown Methods">
<Entry.Match>
<Or>
<Kind Is="Constructor" />
<And>
<Kind Is="Method" />
<ImplementsInterface Name="System.IDisposable" />
</And>
</Or>
</Entry.Match>
<Entry.SortBy>
<Kind>
<Kind.Order>
<DeclarationKind>Constructor</DeclarationKind>
</Kind.Order>
</Kind>
</Entry.SortBy>
</Entry>
</Region>
<Entry DisplayName="All other members" />
<Entry DisplayName="Test Methods" Priority="100">
<Entry.Match>
<And>
<Kind Is="Method" />
<Or>
<HasAttribute Name="Xunit.FactAttribute" Inherited="false" />
<HasAttribute Name="Xunit.TheoryAttribute" Inherited="false" />
</Or>
</And>
</Entry.Match>
<Entry.SortBy>
<Name />
</Entry.SortBy>
</Entry>
</TypePattern>
<TypePattern DisplayName="NUnit Test Fixtures" RemoveRegions="All">
<TypePattern.Match>
<And>
<Kind Is="Class" />
<Or>
<HasAttribute Name="NUnit.Framework.TestFixtureAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.TestFixtureSourceAttribute" Inherited="true" />
<HasMember>
<And>
<Kind Is="Method" />
<HasAttribute Name="NUnit.Framework.TestAttribute" Inherited="false" />
<HasAttribute Name="NUnit.Framework.TestCaseAttribute" Inherited="false" />
<HasAttribute Name="NUnit.Framework.TestCaseSourceAttribute" Inherited="false" />
</And>
</HasMember>
</Or>
</And>
</TypePattern.Match>
<Region Name="Setup/Teardown">
<Entry DisplayName="Setup/Teardown Methods">
<Entry.Match>
<And>
<Kind Is="Method" />
<Or>
<HasAttribute Name="NUnit.Framework.SetUpAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.TearDownAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.TestFixtureSetUpAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.TestFixtureTearDownAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.OneTimeSetUpAttribute" Inherited="true" />
<HasAttribute Name="NUnit.Framework.OneTimeTearDownAttribute" Inherited="true" />
</Or>
</And>
</Entry.Match>
</Entry>
</Region>
<Entry DisplayName="All other members" />
<Entry DisplayName="Test Methods" Priority="100">
<Entry.Match>
<And>
<Kind Is="Method" />
<Or>
<HasAttribute Name="NUnit.Framework.TestAttribute" Inherited="false" />
<HasAttribute Name="NUnit.Framework.TestCaseAttribute" Inherited="false" />
<HasAttribute Name="NUnit.Framework.TestCaseSourceAttribute" Inherited="false" />
</Or>
</And>
</Entry.Match>
<Entry.SortBy>
<Name />
</Entry.SortBy>
</Entry>
</TypePattern>
<TypePattern DisplayName="Default Pattern">
<Region Name="PUBLIC CONSTANTS ---------------------------------------------------------------------------">
<Entry DisplayName="Public Constants">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Constant" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC READONLY FIELDS ---------------------------------------------------------------------">
<Entry DisplayName="Public Readonly Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Readonly />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC STATIC FIELDS -----------------------------------------------------------------------">
<Entry DisplayName="Public Static Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Static />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC FIELDS ------------------------------------------------------------------------------">
<Entry DisplayName="Public Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="CONSTANTS ----------------------------------------------------------------------------------">
<Entry DisplayName="Constants">
<Entry.Match>
<Kind Is="Constant" />
</Entry.Match>
</Entry>
</Region>
<Region Name="READONLY FIELDS ----------------------------------------------------------------------------">
<Entry DisplayName="Readonly Fields">
<Entry.Match>
<And>
<Readonly />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="STATIC FIELDS ------------------------------------------------------------------------------">
<Entry DisplayName="Static Fields">
<Entry.Match>
<And>
<Static />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="FIELDS -------------------------------------------------------------------------------------">
<Entry DisplayName="Fields">
<Entry.Match>
<And>
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC ENUMS -------------------------------------------------------------------------------">
<Entry DisplayName="Public Enums" Priority="100">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Enum" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="ENUMS --------------------------------------------------------------------------------------">
<Entry DisplayName="Enums" Priority="100">
<Entry.Match>
<Kind Is="Enum" />
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC DELEGATES ---------------------------------------------------------------------------">
<Entry DisplayName="Public Delegates" Priority="100">
<Entry.Match>
<And>
<Access Is="Public" />
<Or>
<Kind Is="Delegate" />
<Kind Is="Event" />
</Or>
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="DELEGATES ----------------------------------------------------------------------------------">
<Entry DisplayName="Delegates" Priority="100">
<Entry.Match>
<Or>
<Kind Is="Delegate" />
<Kind Is="Event" />
</Or>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC PROPERTIES --------------------------------------------------------------------------">
<Entry DisplayName="Public Properties">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Property" />
</And>
</Entry.Match>
<Entry.SortBy>
<Kind>
<Kind.Order>
<DeclarationKind>Autoproperty</DeclarationKind>
</Kind.Order>
</Kind>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="PROPERTIES ---------------------------------------------------------------------------------">
<Entry DisplayName="Properties">
<Entry.Match>
<Kind Is="Property" />
</Entry.Match>
<Entry.SortBy>
<Kind>
<Kind.Order>
<DeclarationKind>Autoproperty</DeclarationKind>
</Kind.Order>
</Kind>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="INDEXERS -----------------------------------------------------------------------------------">
<Entry DisplayName="Indexers">
<Entry.Match>
<Kind Is="Indexer" />
</Entry.Match>
</Entry>
</Region>
<Region Name="OPERATORS ----------------------------------------------------------------------------------">
<Entry DisplayName="Operators">
<Entry.Match>
<Kind Is="Operator" />
</Entry.Match>
</Entry>
</Region>
<Region Name="CONSTRUCTORS -------------------------------------------------------------------------------">
<Entry DisplayName="Constructors">
<Entry.Match>
<Kind Is="Constructor" />
</Entry.Match>
<Entry.SortBy>
<Static/>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="DESTRUCTORS --------------------------------------------------------------------------------">
<Entry DisplayName="Destructors">
<Entry.Match>
<Kind Is="Destructor" />
</Entry.Match>
<Entry.SortBy>
<Static/>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="INTERFACE IMPLEMENTATIONS ------------------------------------------------------------------" Priority="100">
<Region Name="${0}" Priority="100">
<Region.GroupBy>
<ImplementsInterface Immediate="True" />
</Region.GroupBy>
<Entry DisplayName="Interface Members" Priority="100">
<Entry.Match>
<And>
<Kind Is="Member" />
<ImplementsInterface />
</And>
</Entry.Match>
<Entry.SortBy>
<ImplementsInterface Immediate="true" />
</Entry.SortBy>
</Entry>
</Region>
</Region>
<Region Name="PUBLIC METHODS -----------------------------------------------------------------------------">
<Entry DisplayName="Public Methods">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Method" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="METHODS ------------------------------------------------------------------------------------">
<Entry DisplayName="Methods">
<Entry.Match>
<Kind Is="Method" />
</Entry.Match>
</Entry>
</Region>
<Region Name="OTHER MEMBERS ------------------------------------------------------------------------------">
<Entry DisplayName="All Other Members" />
</Region>
<Region Name="PUBLIC NESTED STRUCTS ----------------------------------------------------------------------">
<Entry DisplayName="Public Nested Structs">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Struct" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="NESTED STRUCTS -----------------------------------------------------------------------------">
<Entry DisplayName="Nested STRUCTS">
<Entry.Match>
<Kind Is="Struct" />
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC NESTED CLASSES ----------------------------------------------------------------------">
<Entry DisplayName="Public Nested Classes">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Class" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="NESTED CLASSES -----------------------------------------------------------------------------">
<Entry DisplayName="Nested Classes">
<Entry.Match>
<Kind Is="Class" />
</Entry.Match>
</Entry>
</Region>
</TypePattern>
</Patterns>
Raw
csharp-unity-layout-improved.xml
<Patterns xmlns="urn:schemas-jetbrains-com:member-reordering-patterns"
xmlns:unity="urn:schemas-jetbrains-com:member-reordering-patterns-unity">
<!-- Pattern to match classes used by Unity that contain serialised fields and event
function methods. Based on the standard "Default Pattern", this will also order
event functions before normal methods, and does not reorder serialised fields,
as this order is reflected in the Unity editor's Inspector.
Additionally, this pattern wraps type members in regions -->
<TypePattern DisplayName="Unity classes" Priority="100">
<TypePattern.Match>
<unity:SerializableClass />
</TypePattern.Match>
<Region Name="PUBLIC CONSTANTS ---------------------------------------------------------------------------">
<Entry DisplayName="Public Constants">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Constant" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC READONLY FIELDS ---------------------------------------------------------------------">
<Entry DisplayName="Public Readonly Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Readonly />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC STATIC FIELDS -----------------------------------------------------------------------">
<Entry DisplayName="Public Static Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Static />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC FIELDS ------------------------------------------------------------------------------">
<Entry DisplayName="Public Fields">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Field" />
<HasAttribute Name="NonSerialized" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="INSPECTOR FIELDS ---------------------------------------------------------------------------">
<Entry DisplayName="Serialized Fields">
<Entry.Match>
<unity:SerializedField />
</Entry.Match>
<!-- Don't sort serialized fields or their set values will be lost -->
</Entry>
</Region>
<Region Name="CONSTANTS ----------------------------------------------------------------------------------">
<Entry DisplayName="Constants">
<Entry.Match>
<Kind Is="Constant" />
</Entry.Match>
</Entry>
</Region>
<Region Name="READONLY FIELDS ----------------------------------------------------------------------------">
<Entry DisplayName="Readonly Fields">
<Entry.Match>
<And>
<Readonly />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="STATIC FIELDS ------------------------------------------------------------------------------">
<Entry DisplayName="Static Fields">
<Entry.Match>
<And>
<Static />
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="FIELDS -------------------------------------------------------------------------------------">
<Entry DisplayName="Fields">
<Entry.Match>
<And>
<Kind Is="Field" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC ENUMS -------------------------------------------------------------------------------">
<Entry DisplayName="Public Enums" Priority="100">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Enum" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="ENUMS --------------------------------------------------------------------------------------">
<Entry DisplayName="Enums" Priority="100">
<Entry.Match>
<Kind Is="Enum" />
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC DELEGATES ---------------------------------------------------------------------------">
<Entry DisplayName="Public Delegates" Priority="100">
<Entry.Match>
<And>
<Access Is="Public" />
<Or>
<Kind Is="Delegate" />
<Kind Is="Event" />
</Or>
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="DELEGATES ----------------------------------------------------------------------------------">
<Entry DisplayName="Delegates" Priority="100">
<Entry.Match>
<Or>
<Kind Is="Delegate" />
<Kind Is="Event" />
</Or>
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC PROPERTIES --------------------------------------------------------------------------">
<Entry DisplayName="Public Properties">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Property" />
</And>
</Entry.Match>
<Entry.SortBy>
<Kind>
<Kind.Order>
<DeclarationKind>Autoproperty</DeclarationKind>
</Kind.Order>
</Kind>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="PROPERTIES ---------------------------------------------------------------------------------">
<Entry DisplayName="Properties">
<Entry.Match>
<Kind Is="Property" />
</Entry.Match>
<Entry.SortBy>
<Kind>
<Kind.Order>
<DeclarationKind>Autoproperty</DeclarationKind>
</Kind.Order>
</Kind>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="INDEXERS -----------------------------------------------------------------------------------">
<Entry DisplayName="Indexers">
<Entry.Match>
<Kind Is="Indexer" />
</Entry.Match>
</Entry>
</Region>
<Region Name="OPERATORS ----------------------------------------------------------------------------------">
<Entry DisplayName="Operators">
<Entry.Match>
<Kind Is="Operator" />
</Entry.Match>
</Entry>
</Region>
<Region Name="CONSTRUCTORS -------------------------------------------------------------------------------">
<Entry DisplayName="Constructors">
<Entry.Match>
<Kind Is="Constructor" />
</Entry.Match>
<Entry.SortBy>
<Static/>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="DESTRUCTORS --------------------------------------------------------------------------------">
<Entry DisplayName="Destructors">
<Entry.Match>
<Kind Is="Destructor" />
</Entry.Match>
<Entry.SortBy>
<Static/>
</Entry.SortBy>
</Entry>
</Region>
<Region Name="INTERFACE IMPLEMENTATIONS ------------------------------------------------------------------" Priority="100">
<Region Name="${0}" Priority="100">
<Region.GroupBy>
<ImplementsInterface Immediate="True" />
</Region.GroupBy>
<Entry DisplayName="Interface Members" Priority="100">
<Entry.Match>
<And>
<Kind Is="Member" />
<ImplementsInterface />
</And>
</Entry.Match>
<Entry.SortBy>
<ImplementsInterface Immediate="true" />
</Entry.SortBy>
</Entry>
</Region>
</Region>
<Region Name="PUBLIC METHODS -----------------------------------------------------------------------------">
<Entry DisplayName="Public Methods">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Method" />
<Not>
<unity:EventFunction />
</Not>
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="MONOBEHAVIOUR MESSAGES ---------------------------------------------------------------------">
<Entry DisplayName="Core Unity MonoBehaviour Messages">
<Entry.Match>
<And>
<unity:EventFunction />
<Or>
<Name Is="Awake" />
<Name Is="Start" />
</Or>
</And>
</Entry.Match>
<Entry.SortBy>
<Name />
</Entry.SortBy>
</Entry>
<Entry DisplayName="OnEnable MonoBehaviour Message">
<Entry.Match>
<And>
<unity:EventFunction />
<Name Is="OnEnable" />
</And>
</Entry.Match>
</Entry>
<Entry DisplayName="OnDisable MonoBehaviour Message">
<Entry.Match>
<And>
<unity:EventFunction />
<Name Is="OnDisable" />
</And>
</Entry.Match>
</Entry>
<Entry DisplayName="OnDestroy MonoBehaviour Message">
<Entry.Match>
<And>
<unity:EventFunction />
<Name Is="OnDestroy" />
</And>
</Entry.Match>
</Entry>
<Entry DisplayName="Update MonoBehaviour Message">
<Entry.Match>
<And>
<unity:EventFunction />
<Name Is="Update" />
</And>
</Entry.Match>
</Entry>
<Entry DisplayName="Unity MonoBehaviour Special Update Messages">
<Entry.Match>
<And>
<unity:EventFunction />
<Or>
<Name Is="FixedUpdate" />
<Name Is="LateUpdate" />
</Or>
</And>
</Entry.Match>
<Entry.SortBy>
<Name />
</Entry.SortBy>
</Entry>
<Entry DisplayName="All Other Unity MonoBehaviour Messages">
<Entry.Match>
<unity:EventFunction />
</Entry.Match>
<Entry.SortBy>
<Name />
</Entry.SortBy>
</Entry>
</Region>
<Region Name="METHODS ------------------------------------------------------------------------------------">
<Entry DisplayName="Methods">
<Entry.Match>
<Kind Is="Method" />
</Entry.Match>
</Entry>
</Region>
<Region Name="OTHER MEMBERS ------------------------------------------------------------------------------">
<Entry DisplayName="All Other Members" />
</Region>
<Region Name="PUBLIC NESTED STRUCTS ----------------------------------------------------------------------">
<Entry DisplayName="Public Nested Structs">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Struct" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="NESTED STRUCTS -----------------------------------------------------------------------------">
<Entry DisplayName="Nested STRUCTS">
<Entry.Match>
<Kind Is="Struct" />
</Entry.Match>
</Entry>
</Region>
<Region Name="PUBLIC NESTED CLASSES ----------------------------------------------------------------------">
<Entry DisplayName="Public Nested Classes">
<Entry.Match>
<And>
<Access Is="Public" />
<Kind Is="Class" />
</And>
</Entry.Match>
</Entry>
</Region>
<Region Name="NESTED CLASSES -----------------------------------------------------------------------------">
<Entry DisplayName="Nested Classes">
<Entry.Match>
<Kind Is="Class" />
</Entry.Match>
</Entry>
</Region>
</TypePattern>
</Patterns>
@RodrigoLegendre
Copy link

Is there a directory I can drop this to have it as an option instead of replacing text from existing options?

@Jakob-PB
Copy link
Author

Is there a directory I can drop this to have it as an option instead of replacing text from existing options?

Can't think of anything like that off the top of my head, but Rider does give you the option to revert to default right above where you enter the XML so it's relatively safe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment