# credits-log > Rollup plugin to add credits message on debug console in frontend Latest version **1.0.10** (published 2025-01-28) · MIT license · 0 weekly downloads ## Install ```sh npm install credits-log pnpm add credits-log yarn add credits-log bun add credits-log ``` Provides the command `credits-log`. ## Health **Score 35/100 (D)** — status: maintenance-mode. Positive: esm support; no vulnerabilities; has provenance. Warnings: low downloads; no types. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.10 | | Published | 2025-01-28 | | First published | 2022-10-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 3 | | Unpacked size | 38.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | Author | Anton Sychev | | Maintainers | klich3 | | Keywords | rollup, rollup-plugin, credits-log, cli, credits, contributors, humans, authors, console.log, console, console-log, sychev | ## Links - npm: https://www.npmjs.com/package/credits-log - Repository: https://github.com/klich3/credits-log - Homepage: https://github.com/klich3/credits-log#readme - Issues: https://github.com/klich3/credits-log/issues - npm.io page: https://npm.io/package/credits-log ## Dependencies (3) - [yargs](https://npm.io/package/yargs.md) ^17.7.2 - [inquirer](https://npm.io/package/inquirer.md) ^11.0.2 - [commander](https://npm.io/package/commander.md) ^12.1.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.0.10 (latest) — 2025-01-28 - 1.0.8 — 2024-09-25 - 1.0.7 — 2024-09-25 - 1.0.6 — 2024-09-25 - 1.0.5 — 2024-07-23 - 1.0.4 — 2024-06-26 - 1.0.3 — 2023-06-13 - 1.0.2 — 2022-10-10 - 1.0.1 — 2022-10-10 - 1.0.0 — 2022-10-06 ## README # credits-log [![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) ![npm](https://img.shields.io/npm/dm/credits-log?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fcredits-log) ![logotype](logotype/logo.svg?raw=true) ***Credits-Log*** is a module / plugin / addon to add in your Vite configuration file. The module queries creator and contributor data directly from `package.json`. *** Vite / Rollup plugin | so as not to leave the creators in a drawer of oblivion *** > [!NOTE] > >It also saves the Graffiti in as another parameter. > >How it works: At compile time a mini function is added with a console.log that just shows the credits in your frontend. ![Screenshot](images/sceenshot.png) > [!NOTE] >It contains a CLI application from which you can add, remove or edit data to be displayed. >The message can have several lines and/or Logo in "ASCII". ## Installation process: 1) run `npm i credits-log --save-dev` to integrate into your project 1) Test if CLI version is present if not run `npm link` 2) in your project you just have to edit the `vite.config.js` file. ```javascript //vite.config.json import creditslog from "credits-log" export default defineConfig({ ... plugins: [ ... creditslog() ... ], ... }); ``` ## Extension for Front End Now there is a new parameter to implement: `frontEnd: true`, that when placed in front end pressing the `F1` key will show a floating window with Credits of the project. ```javascript //vite.config.json import creditslog from "credits-log" export default defineConfig({ ... plugins: [ ... creditslog({ frontEnd: true }) ... ], ... }); ``` ![Screenshot modal](images/screenshot_modal.png) --- ## Parameteres in `package.json` Read attributes from your `package.json` file: * `name: ""` (Optional) * `version: "0.0.1"` * `"author": "Anton Sychev https://sychev.xyz` (single line) * `"author": ["Anton Sychev https://sychev.xyz", "...other author"],` (multiples authors) * `"contributors": [ "name (https://webpage)", ... ]` * `license: "MIT"` * Custom fields: * `projectName: "Name of your project"` * `credits`: [] "New custom parameter for save your ASCII logo / graffiti" ## Cli Just run `credits-log` in your project folder ## Links ASCII Generators In this sites you can create your custom ASCII logotypes * https://fsymbols.com/generators/carty/ * https://patorjk.com/software/taag/#p=display&f=Abraxis-Small&t=too * https://manytools.org/hacker-tools/convert-images-to-ascii-art/go/ like this: ```javascript ▀█▀ █░█░█ █▀█ █▀█ █▄░█ █▀▀ █▀█ █▄░█ █▀▀ ░█░ ▀▄▀▄▀ █▄█ █▄█ █░▀█ ██▄ █▄█ █░▀█ ██▄ ``` ```javascript -@@@: =%@@%+ @@@# =@@@@@@+ -@@@# :@@@@@@- -@@@@+. =++=. +@@@@@#+++++++=-. -*%@@@@@@@@@@@@#: -@@@@@@@@@@@@% -@@@@@@@@@%%@# -@@@@@@@@@*@@: -@@@@@@@@#%@# -@@@@@@@@*@@: -@@@@@@@@##* -@@@****@@@= -@@@: .@@@= -@@@: .@@@= -@@@: .@@@= -@@@: .@@@= -@@@: .@@@= Thank you for use [CREDITS-LOG] ⌬ 211 ``` ### DOCS ***Rollup.js:*** * https://rollupjs.org/guide/en/#exporting * https://rollupjs.org/guide/en/#a-simple-example * https://www.npmjs.com/package/chalk * https://github.com/sindresorhus/ora * https://github.com/SBoudrias/Inquirer.js/tree/v8.0-legacy --- ### Develop Run `npm link` in source folder for globaly link this repo --- ### NPM Publish NPM publish command: `npm publish --access=public ./` --- ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=klich3/credits-log&type=Date)](https://star-history.com/#klich3/credits-log&Date) --- _Source: https://npm.io/package/credits-log · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._