Skip to content
Credits-log

Credits-log

Project 22 of 82

Areas and technologies

  • open source
  • javascript
  • vite
  • vue

—

Freelance
Year

2022-2023 (October to January)

Context

freelance, open source

Repository

GitHub, klich3

Technologies

Vite and Vue, among others

Works with

Vite, Webpack and Rollup

An open-source module that reads a project's authors and displays its credits.

Credits-log is a module for Vite, Webpack and Rollup that reads authorship data from package.json and displays the project credits. I wrote it so the people behind a website don't end up forgotten in a drawer.

Credits-log credit message in the browser console

What it is

The module reads package.json at build time and adds a small function with a console.log that prints the credits in the frontend. It collects the project name and version, the authors and contributors, and the licence.

How it works

The message can span several lines and include an ASCII logo. A CLI lets you add, remove or edit the data being displayed, so the module can be adapted to each project's structure without editing the configuration by hand.

Floating credits window, opened with the F1 key
Credits-log logo

::

Frontend extension

With the frontEnd: true option, pressing F1 on the website opens a floating window with the project credits, in addition to the console message.

My part

I wrote it on my own as a freelance project between October 2022 and January 2023, and it is published as open source on my GitHub (klich3). I built it with Vite and Vue, among other tools.