All Contributors CLI Inferred

Wraps all-contributors-cli by creating the .all-contributorsrc file from inferred settings. 💓

Usage

npx all-contributors-cli-inferred

all-contributors-cli-inferred supports all the same options as all-contributors-cli. The only difference is that instead of requiring an .all-contributorsrc file, one will be inferred for you by reading from your README.md and package.json.

For example, to add a contribution your README.md table:

npx all-contributors-cli-inferred add ghost test

You can use this CLI as a drop-in replacement for all-contributors-cli. If you already had an .all-contributorsrc file, it won't be deleted.

How?

This CLI works by:

1. Reading configuration from any existing .all-contributorsrc, package.json, and README.md files
2. Writing a new .all-contributorsrc file with that configuration
3. Forwarding all process arguments to all-contributors-cli
4. If an .all-contributorsrc file didn't already exist, the newly created one is deleted

Why?

All Contributors is one of many great pieces of tooling available for repositories. Repositories that use many tools often end up with a dauntingly large number of configuration files -- over a dozen in many cases.

Many users find it exhausting and overwhelming to open a new repository with many config files. Reducing the number of config files in repositories can help make developing them more approachable.

💡 Wish this was built into All Contributors? Lend a 👍 to all-contributors/all-contributors#808 Make the .all-contributorsrc file optional (infer contributors from README.md)!

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md. Thanks! 💖

Contributors

💝 This package was templated with create-typescript-app using the create engine.