search

FdelMazo / FIUBA-Map

Mapa de materias y sus correlativas de la Facultad de Ingeniería
https://fede.dm/FIUBA-Map/
MIT License
126 stars 38 forks source link

Tipado: Documentar con JSDoc // Pasar a typescript #187

Open lazcanoluca opened 9 months ago

lazcanoluca commented 9 months ago

Así tenemos sweet sweet intelisense en todo el proyecto, teniendo bien definidos los tipos de datos. Me parece que suma muchísimo, sobre todo para familiarizarse con el código y tener bien definidos los tipos (usuario, carrera, materia, etc).

Si aceptan la propuesta, yo ya la estoy trabajando, así que me pueden asignar.

FdelMazo commented 9 months ago

Tener el proyecto documentado y tipado me parece genial.

Entre jsdoc y typescript me parece que prefiero typescript (por flexibilidad y ser mas moderno y mas usado), pero si ya tenes mucho hecho con jsdoc, barbaro, vamos con eso!

FdelMazo commented 9 months ago

Gracias por la idea!

lazcanoluca commented 9 months ago

Sí, claro que si estás abierto a ir metiéndole TS, me parece infinitamente mejor. Sugerí JSDoc como para empezar. Ya está TS como dep? O habría que instalarlo?

FdelMazo commented 9 months ago

Typescript habria que agregarlo desde cero. Pero puede ser un buen esfuerzo! Si no lo arrancas vos, intento en algun momento meter el puntapie inicial

lazcanoluca commented 9 months ago

Buenas! Sólo para comentar que empecé con esto, no sé qué tan rápido avance porque se me vienen los parciales pero bueno.

¿Abro una PR en draft para ir trackeando el progreso? No sé bien cómo se maneja eso en un proyecto colaborativo 👀.

¿Me habías mandado invite para colaborar? Se me re pasó y no la acepté a tiempo 🤦🏻‍♂️.

PD: ¿hay algún motivo particular por el cual las correlativas están almacenadas como string, y no array?

FdelMazo commented 9 months ago

Genial Luca!

Del ritmo ni te preocupes, este proyecto es un hobby, las cosas no tienen urgencia.

¿Abro una PR en draft para ir trackeando el progreso? No sé bien cómo se maneja eso en un proyecto colaborativo 👀.

Como vos prefieras. Podes armar tu branch y cuando sientas que necesitas feedback, armar un PR en draft. Yo mucho no voy a meterme a menos que me pidas review/ayuda con algo

El invite para colaborar (que te lo acabo de re-enviar) te lo mando para que lentamente haya mas gente en el fiuba map, y asegurarnos que no haya una sola persona de la que dependa todo, pero si querés podes rechazar el invite sin compromiso. Obviamente tiene su dosis de responsabilidad (no pushear cosas a master sin consenso), pero agrega la comodidad de no tener que estar forkeando todo el tiempo.

Si se te ocurre alguien para meter al proyecto que pueda dar una mano con los dos planes que faltan meter, pinguealo! Mientras mas gente, mejor

Las correlativas son un string porque cuando arranque el proyecto en vez de usar un json usaba un csv como datos, y no se me ocurrio nada mejor. Basicamente, legacy code. Un array me parece mucho mas apropiado!

salluzziluca commented 9 months ago

Buenass, todo bien? Me gustaria colabrar, por lo que entendí la idea es ir pasando toda la codebase a ts, no? Justo andaba aprendiendo y puede ser una buena forma de familiarizarme con el lenguaje. El unico que tema es que nos vamos a confundir entre Luca y Luca ajajajja

lazcanoluca commented 9 months ago

Perfecto Fede! Gracias!

Las correlativas son un string porque cuando arranque el proyecto en vez de usar un json usaba un csv como datos, y no se me ocurrio nada mejor. Basicamente, legacy code. Un array me parece mucho mas apropiado!

Jajaja está perfecto, tiene sentido.

@salluzziluca grande! Voy a abrir una draft PR, con algunos tipos que definí. De ahí los mejoramos para que modelen lo mejor posible todo. Con esa base, podemos ir adaptando el resto sin miedo, en una branch aparte. Sounds good @FdelMazo ?