credits-log

Autogenerative Message showing authors and contributors in web console, by retrieving the data from the packages.json file of your project made in vite / webpack / rollup.

https://github.com/klich3/credits-log

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.1%) to scientific vocabulary

Keywords

authors cli console console-log contributors credits credits-log f12 front-end frontend humans rollup rollup-plugin vite vite-plugin vitejs webconsole website

Keywords from Contributors

interactive mesh interpretability profiles distribution sequences generic projection standardization optim

Last synced: 4 months ago · JSON representation ·

Repository

Autogenerative Message showing authors and contributors in web console, by retrieving the data from the packages.json file of your project made in vite / webpack / rollup.

Basic Info

Host: GitHub
Owner: klich3
License: mit
Language: JavaScript
Default Branch: master
Homepage:
Size: 1.2 MB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 8

Topics

authors cli console console-log contributors credits credits-log f12 front-end frontend humans rollup rollup-plugin vite vite-plugin vitejs webconsole website

Created about 3 years ago · Last pushed 8 months ago

Metadata Files

Readme Funding License Citation

credits-log

npm

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

[!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

Parameteres in `package.json`

Read attributes from your package.json file:

name: "" (Optional)
version: "0.0.1"
"author": "Anton Sychev <anton at sychev dot xyz> https://sychev.xyz (single line)
"author": ["Anton Sychev <anton at sychev dot xyz> https://sychev.xyz", "...other author"], (multiples authors)
"contributors": [ "name <email> (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

Owner

Name: Anton Sychev
Login: klich3
Kind: user
Location: Barcelona
Company: @Sychev

Website: https://sychev.xyz
Twitter: too_klich3
Repositories: 35
Profile: https://github.com/klich3

FullStack developer passionate about decentralized web tech, AI, Web 2.0, FrontEnd/BackEnd, databases, and system optimization. Focused on R&D.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Credits Log
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - email: anton@sychev.xyz
    given-names: Anton
    family-names: Sychev
    affiliation: too
repository-code: "https://github.com/klich3/credits-log"
abstract: Rollup plugin to add credits message on user browser debug console.
keywords:
  - npm
  - rollup
  - authors
  - rollup-plugin
  - cli
  - contributors
  - humans
  - credits
  - log
  - console
  - vite
  - frontend
license: MIT
version: 1.0.8

GitHub Events

Total

Release event: 2
Delete event: 18
Push event: 22
Pull request review event: 1
Pull request event: 29
Create event: 22

Last Year

Release event: 2
Delete event: 18
Push event: 22
Pull request review event: 1
Pull request event: 29
Create event: 22

Committers

Last synced: 6 months ago

All Time

Total Commits: 62
Total Committers: 2
Avg Commits per committer: 31.0
Development Distribution Score (DDS): 0.419

Past Year

Commits: 38
Committers: 2
Avg Commits per committer: 19.0
Development Distribution Score (DDS): 0.368

Top Committers

Name	Email	Commits
Anton Sychev	a**n@s**z	36
dependabot[bot]	4****]	26

Committer Domains (Top 20 + Academic)

sychev.xyz: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 45
Average time to close issues: N/A
Average time to close pull requests: 11 days
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.04
Merged pull requests: 43
Bot issues: 0
Bot pull requests: 42

Past Year

Issues: 0
Pull requests: 30
Average time to close issues: N/A
Average time to close pull requests: about 24 hours
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 30
Bot issues: 0
Bot pull requests: 28

View more stats

Top Authors

Issue Authors

Pull Request Authors

dependabot[bot] (46)
klich3 (3)

Top Labels

Issue Labels

Pull Request Labels

dependencies (46) javascript (23)

Packages

Total packages: 1
Total downloads:
- npm 17 last-month

Total dependent packages: 1
Total dependent repositories: 0
Total versions: 10
Total maintainers: 1

npmjs.org: credits-log

Rollup plugin to add credits message on debug console in frontend

Homepage: https://github.com/klich3/credits-log#readme
License: MIT
Latest release: 1.0.10
published 11 months ago

Versions: 10
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 17 Last month

Rankings

Dependent packages count: 16.2%

Forks count: 20.5%

Average: 24.5%

Dependent repos count: 25.3%

Stargazers count: 27.1%

Downloads: 33.1%

Maintainers (1)

klich3

Last synced: 5 months ago

Dependencies

_test_project/package-lock.json npm

274 dependencies

_test_project/package.json npm

@originjs/vite-plugin-require-context ^1.0.9 development
@vitejs/plugin-vue ^3.1.0 development
@vue/compiler-sfc ^3.2.31 development
@vue/eslint-config-prettier ^7.0.0 development
@vue/test-utils ^2.0.0-rc.17 development
eslint ^8.14.0 development
eslint-config-airbnb-base ^15.0.0 development
eslint-config-prettier ^8.5.0 development
eslint-plugin-import ^2.25.4 development
eslint-plugin-jest ^27.0.1 development
eslint-plugin-prettier ^4.0.0 development
eslint-plugin-vue ^9.4.0 development
prettier ^2.5.1 development
sass ^1.49.9 development
vite ^3.1.0 development

package-lock.json npm

644 dependencies

package.json npm

@babel/core ^7.2.2 development
@babel/preset-env ^7.3.1 development
babel-jest ^24.0.0 development
jest ^24.0.0 development
rollup ^1.27.10 development
@babel/code-frame ^7.0.0
fs-extra ^10.1.0
inquirer ^9.1.2
interactive-cli ^1.1.6
jest-worker ^24.0.0
yargs 17.5.1

credits-log

Science Score: 44.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

credits-log

Installation process:

Extension for Front End

Parameteres in package.json

Cli

Links ASCII Generators

DOCS

Develop

NPM Publish

Star History

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: credits-log

Rankings

Maintainers (1)

Dependencies

Parameteres in `package.json`