Formateo de Contratos Move

movefmt es una herramienta de formateo que hace que el código Move sea mucho más fácil de escribir, leer y mantener — mejorando enormemente la experiencia de desarrollo en Aptos.

Instalación

movefmt está integrado en el CLI de Aptos. Para comenzar a usarlo, primero instálalo usando el comando de actualización del CLI.

# Instalar movefmt para el primer uso
aptos update movefmt

Para instalar una versión específica de movefmt:

# Instalar movefmt con la <VERSION> objetivo
aptos update movefmt --target-version <VERSION>

La versión más reciente de movefmt se puede encontrar aquí.

Formatear tu código

Similar a la compilación y las pruebas, puedes usar el siguiente comando para formatear el paquete Move:

# Formatear el paquete Move
aptos move fmt

Se soportan diferentes formas de emitir el resultado del formateo:

# Formatear y sobrescribir todos los archivos move objetivo en el paquete.
# Este es el comportamiento predeterminado si `--emit-mode` no se especifica explícitamente
aptos move fmt --emit-mode=overwrite

# Imprimir el resultado del formateo en la terminal
aptos move fmt --emit-mode=std-out

# Imprimir el resultado del formateo en nuevos archivos con el sufijo `.fmt.out` en el mismo directorio
aptos move fmt --emit-mode=new-file

# Imprimir la diferencia entre antes y después del formateo
aptos move fmt --emit-mode=diff

movefmt también proporciona diferentes opciones para configurar cómo se formateará el código. Aquí está la configuración predeterminada:

max_width = 90 # cada línea puede tener como máximo 90 caracteres
indent_size = 4 # la indentación es de 4 espacios
tab_spaces = 4 # cada tabulación es idéntica a 4 espacios
hard_tabs = false # cuando se inserta una tabulación, será reemplazada automáticamente por 4 espacios

Para anular la opción predeterminada, los usuarios pueden especificar un archivo de configuración movefmt.toml y colocarlo en el directorio del paquete Move o especificarlo manualmente en la línea de comandos:

# Al formatear el código, establecer `max_width` a 80 e `indent_size` a 2
aptos move fmt --config max_width=80,indent_size=2

Comentarios

Aptos Labs sigue comprometido con mejorar la experiencia del desarrollador para los constructores que usan Move en Aptos. Si estás interesado en dar forma a las pautas de estilo para Move, nos encantaría escuchar tus comentarios y retroalimentación aquí.