Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More β†’
Socket
Sign inDemoInstall
Socket

all-contributors-cli

Package Overview
Dependencies
Maintainers
2
Versions
121
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

all-contributors-cli

Tool to easily add recognition for new contributors

  • 4.11.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
45K
increased by19.08%
Maintainers
2
Weekly downloads
Β 
Created
Source

all-contributors-cli πŸ€–

Automate acknowledging contributors to your open source projects


Build Status Code Coverage version downloads MIT License

All Contributors PRs Welcome Code of Conduct Watch on GitHub Star on GitHub Tweet

The problem

You want to implement the All Contributors spec, but don't want to maintain the table by hand

This solution

This is a tool to help automate adding contributor acknowledgements according to the all-contributors specification for your GitHub or GitLab repository.

Table of Contents

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev all-contributors-cli

Then init the project using init and answer a few questions:

# Use npx for npm@^5.2.0
npx all-contributors init
# Or directly execute the bin
./node_modules/.bin/all-contributors init

Then you can add these scripts to your package.json:

{
  "scripts": {
    "contributors:add": "all-contributors add",
    "contributors:generate": "all-contributors generate"
  }
}

and use them via npm run:

npm run contributors:add -- jfmengels doc
npm run contributors:generate

Usage

Generating the contributors list

Use generate to generate the contributors list and inject it into your contributors file. Contributors will be read from your configuration file.

all-contributors generate

Add/update contributors

Use add to add new contributors to your project, or add new ways in which they have contributed. They will be added to your configuration file, and the contributors file will be updated just as if you used the generate command.

# Add new contributor <username>, who made a contribution of type <contribution>
all-contributors add <username> <contribution>
# Example:
all-contributors add jfmengels code,doc

Where username is the user's GitHub or Gitlab username, and contribution is a ,-separated list of ways to contribute, from the following list (see the specs):

Check for missing contributors

Use check to compare contributors from GitHub with the ones credited in your .all-contributorsrc file, in order to make sure that credit is given where it's due.

all-contributors check

Due to GitHub API restrictions, this command only works for projects with less than 500 contributors.

Configuration

You can configure the project by updating the .all-contributorsrc JSON file. The data used to generate the contributors list will be stored in there, and you can configure how you want all-contributors-cli to generate the list.

These are the keys you can specify:

  • files: Array of files to update. Default: ['README.md']
  • projectOwner: Name of the user the project is hosted by. Example: jfmengels/all-contributors-cli --> jfmengels. Mandatory.
  • projectName: Name of the project. Example: jfmengels/all-contributors-cli --> all-contributors-cli. Mandatory.
  • repoType: Type of repository. Must be either github or gitlab. Default: github.
  • repoHost: Points to the repository hostname. Change it if you use a self hosted repository. Default: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab.
  • types: Specify custom symbols or link templates for contribution types. Can override the documented types.
  • imageSize: Size (in px) of the user's avatar. Default: 100.
  • contributorsPerLine: Maximum number of columns for the contributors table. Default: 7.
  • contributorTemplate: Define your own template to generate the contributor list.
  • badgeTemplate: Define your own template to generate the badge.

Contributors

Thanks goes to these wonderful people (emoji key):


Jeroen Engels

πŸ’» πŸ“– ⚠️

Kent C. Dodds

πŸ“– πŸ’»

JoΓ£o GuimarΓ£es

πŸ’»

Ben Briggs

πŸ’»

Itai Steinherz

πŸ“– πŸ’»

Alex Jover

πŸ’» πŸ“–

Jerod Santo

πŸ’»

Kevin Jalbert

πŸ’»

tunnckoCore

πŸ”§

Mehdi Achour

πŸ’»

Roy Revelt

πŸ›

Chris Vickery

πŸ’»

Bryce Reynolds

πŸ’»

James, please

πŸ€” πŸ’»

Spyros Ioakeimidis

πŸ’»

Fernando Costa

πŸ’»

snipe

πŸ“–

Gant Laborde

πŸ’»

Md Zubair Ahmed

πŸ“– πŸ›

Divjot Singh

πŸ“–

JoΓ£o Marques

πŸ’» πŸ“– πŸ€”

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT

Keywords

FAQs

Package last updated on 23 Feb 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚑️ by Socket Inc