Especifique la ruta al archivo CustomDictionary para la revisión ortográfica de StyleCop

Question

La revisión ortográfica de los comentarios se agregó a las versiones recientes de StyleCop. Parece que puedo reutilizar mi archivo CustomDictionary existente (que creé para FxCop) con StyleCop. La regla SA1650 documentation no dice que es posible. Pero en release notes para la versión 7.4.39 veo

añadir soporte para la especificación de las carpetas en el archivo de diccionario settings.StyleCop .

¿Cómo configuro StyleCop para buscar este archivo en la carpeta raíz de mi solución?

Answer 1

De acuerdo con la documentación StyleCop por regla SA1650

El archivo CustomDictionary.xml deben colocarse en la misma carpeta que el StyleCop.dll y las Reglas. Esa carpeta (y todas las subcarpetas) se verifican para los archivos del diccionario. StyleCop carga CustomDictionary.xml, CustomDictionary.en-GB.xml y luego CustomDictionary.en.xml (donde en-GB es la cultura especificada en el archivo Settings.StyleCop). StyleCop también carga custom.dic, custom.en-GB.dic y luego custom.en.dic (donde en-GB es la cultura especificada en el archivo Settings.StyleCop). Las palabras reconocidas también se pueden agregar al archivo Settings.StyleCop usando el Editor de configuraciones en la pestaña de ortografía.

Parece que tendría que poner una copia de CustomDictionary.xml en esa ubicación específica en lugar de en la raíz de la carpeta de la solución.

Answer 2

Se ha realizado una pregunta similar aquí http://stylecop.codeplex.com/workitem/7422 y hay un boleto abierto aquí http://stylecop.codeplex.com/workitem/7435 que creo que proporcionará lo que está buscando si se hace.

Answer 3

Añadir un archivo llamado Settings.StyleCop en el directorio raíz de solución con el siguiente contenido:

<StyleCopSettings Version="105"> 
    <GlobalSettings> 
    <CollectionProperty Name="DictionaryFolders"> 
     <Value>**my-dictionary-folder**</Value> 
    </CollectionProperty> 
    </GlobalSettings> 
</StyleCopSettings> 

Cuando se reemplaza my-dictionary-folder con la ruta relativa a la carpeta que contiene el archivo de CustomDictionary.xml.

Answer 4

En mi caso funcionó cuando especifiqué las entradas de diccionario personalizadas en el archivo Settings.StyleCop ubicado al lado del archivo .csproj.

<GlobalSettings> 
    <StringProperty Name="MergeSettingsFiles">NoMerge</StringProperty> 
    <CollectionProperty Name="RecognizedWords"> 
    <Value>word1</Value> 
    <Value>word2</Value> 
    ... 
    </CollectionProperty> 
</GlobalSettings> 

En realidad, la utilidad StyleCopSettingsEditor.exe creó estas configuraciones para mí. Lo abrí usando el menú contextual del proyecto en Visual Studio, usando la opción de menú "Configuración de StyleCop".