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

Ordenar y documentar funcionamiento de assets #36

Closed
4 of 5 tasks
benjavicente opened this issue Jul 27, 2021 · 3 comments
Closed
4 of 5 tasks

Ordenar y documentar funcionamiento de assets #36

benjavicente opened this issue Jul 27, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@benjavicente
Copy link
Member

benjavicente commented Jul 27, 2021

Como compilar los assets no está documentado y el directorio de assets está algo desordenado.

Por ejemplo:

  • Hay archivos como boostrap.min.css y multiple-select.min.css que son archivos mitificados, donde el primero parece que no se usa y ambos son dependencias de node.
  • Hay scripts que podrían simplificarse y ordenarse demasiado utilizando JavaScript moderno o utilizando más funciones, como en la creación de objetos en query_body de search.js y en la única función de 97 líneas con ~4 funciones anónimas anidadas en quota.js.
  • Al correr webpack se genera un directorio dist que no está completamente ignorado por git.
  • Ver para que es cada archivo requiere buscar como se usan en webpack.config.js y los otros scripts.

Entonces, para mejorar el orden y facilitar la resolución de #4, #15, #20, #21 y #35 creo que es necesario:

  • Documentar como generar (o como funcionan) los assets
  • Agilizar la generación de los assets
  • Crear un directorio de como helpers o utils y dejar ahí los scripts auxiliares (los que no están en entry de webpack)
  • Eliminar los archivos minificados que podrían importarse de una dependencia de node
  • Eliminar dist del repositorio e ignorarlo

Una vez visto eso, se podría además ver si:

  • Hacer un refactor de algunas partes del código para hacer más ágil los cambios a futuro
  • Dejar un linter o formatter como eslint
  • Se elimina la dependencia de jquery
  • Sobreescribir los colores principales de Boostrap en base.css
@benjavicente benjavicente added the documentation Improvements or additions to documentation label Jul 27, 2021
@nico-mac
Copy link
Member

Toda la carpeta de assets es tan desastrosa como mi entendimiento sobre webpack, js moderno y css moderno.

Un buen punto de partida podría ser trasladar algunos archivos a un directorio utils (como dices, los que no son entries), eliminar los archivos que puedan importarse como dependencias, hacer documentación e incorporar un formatter.

Preferiría mantener la carpeta dist mientras que no esté automatizada la compilación de assets, para no complejizar más el setup y deploy por mientras.

@benjavicente benjavicente added the help wanted Extra attention is needed label Jul 27, 2021
@benjavicente benjavicente self-assigned this Jul 27, 2021
This was referenced Jul 27, 2021
@nico-mac
Copy link
Member

nico-mac commented Aug 1, 2021

Creo que todo esto ya esta listo. Si efectivamente no falta nada más, puedes cerrar la issue @benjavicente.

@benjavicente
Copy link
Member Author

Faltó ver el tema de agilizar la generación de assets, idealmente se deberían generar al haber cambios cuando se corre el servidor al probarlo. Pero por lo que he visto, django no tiene una buena integración con webpack, entonces se podría dejar como algo bueno a tener en el futuro y no necesario.

Como se cumplió la meta de la issue, la cierro nomás.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants