Tuesday, 21 October 2014

ReSharper Type Members Layout

Here's the custom layout I use with ReSharper to keep StyleCop (and me) happy.

Update the custom layout (ReSharper | Options | Code Editing | C# | Type Members Layout | Custom Layout) with the following and 'ReSharper | Tools | Cleanup Code...' to use it:


<?xml version="1.0" encoding="utf-8" ?>

<!--
I. Overall

I.1 Each pattern can have <Match>....</Match> element. For the given type declaration, the pattern with the match, evaluated to 'true' with the largest weight, will be used
I.2 Each pattern consists of the sequence of <Entry>...</Entry> elements. Type member declarations are distributed between entries
I.3 If pattern has RemoveAllRegions="true" attribute, then all regions will be cleared prior to reordering. Otherwise, only auto-generated regions will be cleared
I.4 The contents of each entry is sorted by given keys (First key is primary,  next key is secondary, etc). Then the declarations are grouped and en-regioned by given property

II. Available match operands

Each operand may have Weight="..." attribute. This weight will be added to the match weight if the operand is evaluated to 'true'.
The default weight is 1

II.1 Boolean functions:
II.1.1 <And>....</And>
II.1.2 <Or>....</Or>
II.1.3 <Not>....</Not>

II.2 Operands
II.2.1 <Kind Is="..."/>. Kinds are: class, struct, interface, enum, delegate, type, constructor, destructor, property, indexer, method, operator, field, constant, event, member
II.2.2 <Name Is="..." [IgnoreCase="true/false"] />. The 'Is' attribute contains regular expression
II.2.3 <HasAttribute CLRName="..." [Inherit="true/false"] />. The 'CLRName' attribute contains regular expression
II.2.4 <Access Is="..."/>. The 'Is' values are: public, protected, internal, protected-internal, private
II.2.5 <Static/>
II.2.6 <Abstract/>
II.2.7 <Virtual/>
II.2.8 <Override/>
II.2.9 <Sealed/>
II.2.10 <Readonly/>
II.2.11 <ImplementsInterface CLRName="..."/>. The 'CLRName' attribute contains regular expression
II.2.12 <HandlesEvent />
-->

<Patterns xmlns="urn:shemas-jetbrains-com:member-reordering-patterns">

  <!--Do not reorder COM interfaces and structs marked by StructLayout attribute-->
  <Pattern>
    <Match>
      <Or Weight="100">
        <And>
          <Kind Is="interface"/>
          <Or>
            <HasAttribute CLRName="System.Runtime.InteropServices.InterfaceTypeAttribute"/>
            <HasAttribute CLRName="System.Runtime.InteropServices.ComImport"/>
          </Or>
        </And>
        <HasAttribute CLRName="System.Runtime.InteropServices.StructLayoutAttribute"/>
      </Or>
    </Match>
  </Pattern>

  <!--Default pattern-->
  <Pattern RemoveAllRegions="true">

    <!-- Constant Fields -->
    <Entry>
      <Match>
        <Or>
          <Kind Is="constant" />
          <Kind Is="field" />
        </Or>
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Kind Order="constant field"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Fields -->
    <!--
    <Entry>
      <Match>
        <Kind Is="field" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>
    -->
   
    <!-- Constructors -->
    <Entry>
      <Match>
        <Kind Is="constructor" />
      </Match>
      <Sort>
        <Static />
        <Access Order="public internal protected-internal protected private"/>
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Destructors -->
    <Entry>
      <Match>
        <Kind Is="destructor" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Delegates -->
    <Entry>
      <Match>
        <Kind Is="delegate" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Events -->
    <Entry>
      <Match>
        <Kind Is="event" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Enums -->
    <Entry>
      <Match>
        <Kind Is="enum" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Interfaces -->
    <Entry>
      <Match>
        <Kind Is="interface" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Properties -->
    <Entry>
      <Match>
        <Kind Is="property" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Indexers -->
    <Entry>
      <Match>
        <Kind Is="indexer" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Operators -->
    <Entry>
      <Match>
        <Kind Is="operator" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Methods -->
    <Entry>
      <Match>
        <Kind Is="method" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Structs -->
    <Entry>
      <Match>
        <Kind Is="struct" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!-- Classes -->
    <Entry>
      <Match>
        <Kind Is="class" />
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>

    <!--all other members-->
    <Entry/>

    <!--nested types-->
    <Entry>
      <Match>
        <Kind Is="type"/>
      </Match>
      <Sort>
        <Access Order="public internal protected-internal protected private"/>
        <Static />
        <Readonly />
        <Name />
      </Sort>
    </Entry>
  </Pattern>
</Patterns>

No comments: