Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(deps): Adds EsLint and Prettier #1561

Open
wants to merge 7 commits into
base: next
Choose a base branch
from

Conversation

mfdebian
Copy link
Collaborator

@mfdebian mfdebian commented Sep 7, 2023

Añade ESLint y Prettier al proyecto ignorando el directorio topics/ o cualquier archivo .md

Este PR no sólo añade esas dos dependencias, sino que además se agregan en la sección de scripts del package.json una serie de tareas que ejecutan ESLint y Prettier sobre el proyecto:

    "lint": "eslint . --ext .js,.jsx",
    "format": "prettier --check .",
    "format:fix": "prettier --write .",

Para este PR ya he ejecutado además el comando format:fix que escribe el código utilizando las reglas de Prettier y por ende se modifican también una serie de archivos, que sólo modifica su estilo, pero nada debería haberse roto, probé la app en mi local y además pasa todos los tests

No se incluye en este PR, pero además recomiendo que las personas mantenedoras del proyecto (a quienes me tomaré la libertad de agregar como reviewers 😊 ) agreguen un archivo .vscode/settings.json con el siguiente contenido:

{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true // ESLint auto format on save
  },
  "editor.formatOnSave": true, // Prettier auto format on save
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.quickSuggestions": {
    "strings": true
  }
}

Esto hará que se ejecuten ESLint y Prettier sin pisarse el uno al otro cada vez que se guarde un archivo.

¡Cualquier feedback es bienvenido!

@mfdebian mfdebian added enhancement New feature or request idea Ideas, sugerencias, comentarios generales y feedback chore Tareas pertinentes al equipo de mantenimiento dependencies Pull requests that update a dependency file labels Sep 7, 2023
@mfdebian mfdebian added this to the TBD milestone Sep 7, 2023
@mfdebian mfdebian self-assigned this Sep 7, 2023
@unjust
Copy link
Member

unjust commented Sep 7, 2023

@mfdebian necesito un tiempo para revisar y probarlo localmente, y también involucrar pruebas de la demas. En el pasado tuve que desactivar prettier en mi vscode porque por algun razon las reglas choca con eslint o otras herramientas, y por eso necesito mas que revisar por ojo pero reviso usando esta rama.

Me gustaria tambien conversar en el equipo devs si seria bueno adoptar eso en otros repos como bootcamp.

@unjust
Copy link
Member

unjust commented Sep 11, 2023

Aún tengo que probar perdón! Pero algo que recuerdo es en una conversación hace mucho tiempo hablamos que podemos usar prettier para formatear markdown. Creo sería bueno porque ya usuarios de Windows tienen problemas con mdlint.

https://prettier.io/blog/2017/11/07/1.8.0.html

Sería bueno si podemos aprovechar y agregar el config para markdown en esta rama.

@unjust unjust modified the milestones: TBD, 7.2, next release Sep 25, 2023
Copy link
Member

@unjust unjust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mfdebian probe eso localmente (resolve los conflictos) y necesito ayuda para convencerme adoptar.

Estoy nerviosa de conflictos entre eslint y prettier, podemos asegurar que siempre juegan bien juntos?
Me gustaria saber cual son las problemas antes de arreglar con prettier, por ejemplo como aparece los eslint errores detalladas en VSCode en la pastaña de "Problemas". Cuando corre los scripts de prettier solo tengo "warn" como output y nombre de archivo pero no puedo ver las quejas antes de arreglar
Querria adoptar eso para markdown y dejar uso de mdlint (muchas herramientas), pero cuando hice "fix" con prettier y despues "mdlint" para ver si hacen el mismo checks, los fixes de prettier causaron errores en mdlint. QUiza eso no es importante si los fixes de prettier sn valido con Github

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Tareas pertinentes al equipo de mantenimiento dependencies Pull requests that update a dependency file enhancement New feature or request idea Ideas, sugerencias, comentarios generales y feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants