Saltar al contenido
Todos los proyectos
Credits-log

Credits-log

Proyecto 22 de 82

Áreas y tecnologías

  • open source
  • javascript
  • vite
  • vue

—

Freelance
Año

2022-2023 (octubre a enero)

Contexto

freelance, código abierto

Repositorio

GitHub, klich3

Tecnologías

Vite y Vue, entre otras

Uso

Vite, Webpack y Rollup

Módulo de código abierto que lee los autores de un proyecto y muestra sus créditos.

Credits-log es un módulo para Vite, Webpack y Rollup que lee los datos de autoría del package.json y muestra los créditos del proyecto. Lo escribí para que las personas que trabajan en una web no se queden en un cajón de olvido.

Mensaje de créditos de credits-log en la consola del navegador

Qué es

El módulo consulta el package.json en tiempo de compilación y añade una pequeña función con un console.log que imprime los créditos en el frontend. Recoge el nombre y la versión del proyecto, los autores y colaboradores y la licencia.

Cómo funciona

El mensaje admite varias líneas y un logotipo en ASCII. Una CLI permite añadir, quitar o editar los datos que se muestran, de modo que el módulo se puede adaptar a la estructura de cada proyecto sin tocar la configuración a mano.

Ventana flotante con los créditos, activada con la tecla F1
Logotipo de credits-log

::

Extensión para el frontend

Con la opción frontEnd: true, al pulsar la tecla F1 en la web se abre una ventana flotante con los créditos del proyecto, además del mensaje de consola.

Mi parte

Lo escribí por mi cuenta, como proyecto freelance, entre octubre de 2022 y enero de 2023, y está publicado como código abierto en mi GitHub (klich3). Lo desarrollé con Vite y Vue, entre otras herramientas.

Todos los proyectos