dotnet format
Este artículo se aplica a: ✔️ SDK de .NET 6.x y versiones posteriores
dotnet format
: Da formato al código para que coincida con el valor editorconfig
.
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format -h|--help
dotnet format
es un formateador de código que aplica preferencias de estilo y recomendaciones de análisis estático a un proyecto o solución. Las preferencias se leerán de un archivo .editorconfig, si están presentes; de lo contrario, se usará un conjunto predeterminado de preferencias. Para más información, consulte la documentación de EditorConfig.
PROJECT | SOLUTION
El proyecto o solución de MSBuild donde se ejecutará el formato de código. Si no se especifica un archivo de proyecto o solución, MSBuild busca en el directorio de trabajo actual un archivo que tenga una extensión de archivo que termine en proj o sln y lo usa.
Ninguna de las opciones siguientes es necesaria para que el comando dotnet format
se ejecute correctamente, pero se pueden usar para personalizar aún más lo que se formatea y con qué reglas.
--diagnostics <DIAGNOSTICS>
Lista separada por espacios de identificadores de diagnóstico que se usarán como filtro al corregir problemas de estilo de código o de terceros. El valor predeterminado es cualquier identificador que aparezca en el archivo .editorconfig. Para ver una lista de los identificadores de reglas de analizador integrados que puede especificar, consulte la lista de identificadores de las reglas de estilo de análisis del código.
--severity
Gravedad mínima de los diagnósticos que se corregirán. Los valores permitidos son
info
,warn
yerror
. El valor predeterminado eswarn
.--no-restore
No ejecuta una restauración implícita antes del formato. El valor predeterminado es realizar una restauración implícita.
--verify-no-changes
Comprueba que no se realizarían cambios de formato. Finaliza con un código de salida distinto de cero si se hubiera dado formato a algún archivo.
--include <INCLUDE>
Lista separada por espacios de rutas de acceso relativas a archivos o carpetas que se incluirán en el formato. El valor predeterminado son todos los archivos de la solución o el proyecto.
--exclude <EXCLUDE>
Lista separada por espacios de rutas de acceso relativas a archivos o carpetas que se excluirán del formato. El valor predeterminado es none.
--include-generated
Da formato a los archivos generados por el SDK.
-v|--verbosity <LEVEL>
Establece el nivel de detalle. Los valores permitidos son
q[uiet]
,m[inimal]
,n[ormal]
,d[etailed]
ydiag[nostic]
. El valor predeterminado esm[inimal]
.--binarylog <BINARY-LOG-PATH>
Registra toda la información de carga del proyecto o solución en un archivo de registro binario.
--report <REPORT-PATH>
Genera un informe JSON en el directorio especificado por
<REPORT_PATH>
.-h|--help
Muestra información de ayuda y uso
dotnet format whitespace
: Da formato al código para que coincida con el valor editorconfig
para el espacio en blanco.
El dotnet format whitespace
subcomando solo ejecuta reglas de formato asociadas al formato de espacio en blanco. Para ver una lista completa de las posibles opciones de formato que puede especificar en el archivo .editorconfig, consulte las opciones de formato de C#.
--folder
Trate el argumento
<PROJECT | SOLUTION>
como una ruta a una carpeta simple de archivos de código.
dotnet format style
: Da formato al código para que coincida con el valor EditorConfig para el estilo de código.
El dotnet format style
subcomando solo ejecuta reglas de formato asociadas al formato de estilo de código. Para ver una lista completa de las posibles opciones de formato que puede especificar en el archivo editorconfig
, consulte Reglas de estilo de código.
--diagnostics <DIAGNOSTICS>
Lista separada por espacios de identificadores de diagnóstico que se usarán como filtro al corregir problemas de estilo de código. El valor predeterminado es cualquier identificador que aparezca en el archivo .editorconfig. Para obtener una lista de identificadores de regla de analizador de estilo de código integrados que puede especificar, consulte la lista de identificadores para reglas de estilo de análisis de código.
--severity
Gravedad mínima de los diagnósticos que se corregirán. Los valores permitidos son
info
,warn
yerror
. El valor predeterminado eswarn
dotnet format analyzers
: da formato al código para que coincida editorconfig
con la configuración de los analizadores (excepto las reglas de estilo de código).
El dotnet format analyzers
subcomando solo ejecuta reglas de formato asociadas a los analizadores. Para obtener una lista de reglas de analizador que puede especificar en el editorconfig
archivo, consulte Reglas de calidad.
--diagnostics <DIAGNOSTICS>
Lista separada por espacios de identificadores de diagnóstico que se usarán como filtro al corregir problemas de estilo que no son de código. El valor predeterminado es cualquier identificador que aparezca en el archivo .editorconfig. Para obtener una lista de identificadores de regla de analizador integrados que puede especificar, consulte la lista de identificadores para las reglas de calidad. Para los analizadores de terceros, consulte su documentación.
--severity
Gravedad mínima de los diagnósticos que se corregirán. Los valores permitidos son
info
,warn
yerror
. El valor predeterminado eswarn
.
Dar formato a todo el código de la solución:
CLI de .NETdotnet format ./solution.sln
Limpiar todo el código del proyecto de aplicación:
CLI de .NETdotnet format ./src/application.csproj
Comprobar que todo el código tiene el formato correcto:
CLI de .NETdotnet format --verify-no-changes
Limpiar todo el código del directorio src y tests, pero no en src/submodule-a:
CLI de .NETdotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
Corrija un problema de estilo de código específico:
CLI de .NETdotnet format style --diagnostics IDE0005 --severity info
Corrija todos los problemas de estilo de código que tienen gravedad
info
owarning
error
:CLI de .NETdotnet format style --severity info
Corrija un problema específico del analizador (sin estilo de código):
CLI de .NETdotnet format analyzers --diagnostics CA1831 --severity warn
Corrija todos los problemas de estilo que no son de código que tengan gravedad
info
owarning
error
:CLI de .NETdotnet format analyzers --severity info
Comentarios de .NET
.NET es un proyecto de código abierto. Seleccione un vínculo para proporcionar comentarios: