dart format

Para actualizar tu código y seguir las pautas de formato de Dart, usa el comando dart format. Este formateo coincide con el que obtienes al usar un IDE o editor con soporte para Dart.

Para reformatear uno o más archivos de Dart, proporciona una lista de rutas a los archivos o directorios deseados.

Proporciona la ruta a un archivo o directorio. Si pasas la ruta de un directorio, dart format también recorre recursivamente sus subdirectorios.

Ejemplo: Para formatear todos los archivos de Dart en el directorio actual o debajo de él:

$ dart format .

Para especificar múltiples archivos o directorios, usa una lista delimitada por espacios.

Ejemplo: Para formatear todos los archivos de Dart bajo el directorio lib, más un archivo de Dart bajo el directorio bin:

$ dart format lib bin/updater.dart

Por defecto, dart format sobrescribe los archivos de Dart.

• Para no sobrescribir los archivos, agrega la bandera --output o -o.
• Para obtener el contenido de los archivos formateados, agrega -o show o -o json.
• Para ver únicamente qué archivos cambiarían, agrega -o none.

$ dart format -o show bin/my_app.dart

Para hacer que dart format devuelva un código de salida (exit code) cuando ocurran cambios de formato, agrega la bandera --set-exit-if-changed.

• Si ocurren cambios, el comando dart format devuelve un código de salida de 1.
• Si no ocurren cambios, el comando dart format devuelve un código de salida de 0.

Usa los códigos de salida con sistemas de integración continua (CI) para que puedan activar otra acción en respuesta al código de salida.

$ dart format -o none --set-exit-if-changed bin/my_app.dart

Muchos editores con soporte de Dart pueden formatear automáticamente tu código al guardar un archivo.

Para habilitar el formateo al guardar en VS Code, agrega la siguiente entrada a tu archivo settings.json:

{
  "[dart]": {
    "editor.formatOnSave": true
  }
}

Para habilitar el formateo al guardar en los IDEs de JetBrains, incluyendo IntelliJ IDEA y Android Studio, sigue sus instrucciones sobre cómo Reformatear automáticamente el código al guardar.

dart format realiza los siguientes cambios de formato:

• Elimina los espacios en blanco.
• Ajusta cada línea a 80 caracteres de longitud o menos.
• Agrega comas finales (trailing commas) a cualquier lista de argumentos o parámetros que se divida en múltiples líneas, y las elimina de las que no.
• Podría mover comentarios antes o después de una coma.

Para obtener más información sobre las mejores prácticas para escribir y dar estilo al código Dart, consulta la guía de estilo de Dart.

Cuando ejecutas dart format, el formateador tiene por defecto una longitud de línea de 80 caracteres o menos. Configura el comportamiento del formateador agregando una sección formatter de nivel superior al archivo analysis_options.yaml.

Configura la longitud de línea para tu proyecto:

formatter:
  page_width: 123

Con el archivo de opciones de análisis típicamente en la raíz, la longitud de línea configurada se aplicará a todo el paquete.

Por defecto, dart format agrega o elimina comas finales basándose en si el constructor se divide en múltiples líneas. Para obligar a dividir un constructor incluso cuando quepa en una sola línea, configura el formateador para preservar las comas finales:

formatter:
  trailing_commas: preserve

Cuando está habilitado, agregar una coma final a una lista de argumentos, lista de parámetros u otros constructores obliga al formateador a dividirlo en múltiples líneas, incluso si cabe en una sola línea. Esto te brinda control manual sobre los saltos de línea para constructores específicos.

Configura la longitud de línea de un archivo individual, sobrescribiendo las opciones de análisis, agregando un comentario marcador en la parte superior del archivo, antes de cualquier otro código:

// dart format width=123

Para obtener información sobre opciones de línea de comandos adicionales, usa el comando dart help o consulta la documentación del paquete dart_style.

$ dart help format

Consulta las preguntas frecuentes (FAQ) del formateador para obtener más contexto sobre las decisiones de formateo.