Revisión de prosa con Vale
Vale es un corrector de prosa en línea de comandos que verifica su documentación según reglas de estilo configurables. Se integra bien con archivos Markdown y MDX, lo que lo convierte en una opción natural para los proyectos de docStatic.
Instalar Vale
Consulte la guía de instalación de Vale para obtener instrucciones para su plataforma. Vale está disponible a través de Homebrew, apt, Chocolatey y descarga directa de binarios.
- macOS
- Linux
- Windows
brew install vale
# Debian / Ubuntu
sudo apt install vale
choco install vale
Configuración del proyecto
Los proyectos de docStatic incluyen un archivo .vale.ini en la raíz del repositorio. Los parámetros clave son:
| Parámetro | Valor | Propósito |
|---|---|---|
StylesPath | .vale/styles | Directorio para paquetes de estilos descargados y personalizados |
MinAlertLevel | suggestion | Mostrar todos los hallazgos (sugerencia, advertencia, error) |
[formats] | mdx = md | Tratar los archivos .mdx como Markdown |
Sincronizar estilos
Después de clonar el repositorio, ejecute vale sync una vez para descargar los paquetes de estilo enumerados en .vale.ini:
vale sync
Esto completa .vale/styles/ con los paquetes configurados. Agregue .vale/styles/ a .gitignore para que los paquetes descargados no se confirmen.
Verificar sus documentos
Ejecute Vale en el directorio docs/:
vale docs/
O verifique un solo archivo:
vale docs/guides/my-page.mdx
Vale muestra los hallazgos agrupados por archivo, con el número de línea, el nivel de alerta y la regla que los desencadenó.
Agregar paquetes de estilos
Vale tiene una biblioteca de paquetes de estilos de la comunidad (Google, Microsoft, write-good y más). Para agregar uno, refiéralo en .vale.ini bajo BasedOnStyles:
[*.{md,mdx}]
BasedOnStyles = Vale, Google
Luego ejecute vale sync de nuevo para descargarlo.
Puede agregar reglas específicas del proyecto como archivos YAML dentro de .vale/styles/. Consulte la documentación de Vale para conocer el formato de las reglas.
Integración con el editor
Vale tiene extensiones para VS Code (Vale VSCode) y otros editores que muestran los hallazgos en línea mientras escribe.