Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor core to use a plugin architecture #103

Open
kefranabg opened this issue Aug 18, 2019 · 1 comment
Open

Refactor core to use a plugin architecture #103

kefranabg opened this issue Aug 18, 2019 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@kefranabg
Copy link
Owner

Split readme-md-generator into multiple packages ang manage them with yarn workspaces. Each question would be a plugin that you can easily register.

@kefranabg kefranabg added the enhancement New feature or request label Aug 18, 2019
@kefranabg kefranabg self-assigned this Aug 18, 2019
@JuroOravec
Copy link

+1. It would be great if users could select which plugins/questions to include, or could easily create their own plugins (questions), and use them.

Use cases:

  1. I'd like to add a bunch of badges to my README. I use my own template, which is just the default template including the badges. Most of the badges need just username and repo name, so those are fine as those variables are already available in to the template.

    But e.g. CodeClimate has a custom ID to fetch the correct badge. So I'd like to add a question that asks for the CodeClimate badge ID, so I could use that variable in the template.

    For badges especially, the plugin architecture would be very useful as the number of different badges and their providers can change relatively fast, so it would be better if it could be managed by the community rather than the core package.

  2. I'd also like to link to a CHANGELOG.md from README. So I'd also like to add a question that asks me about the URL to the CHANGELOG, so I could, again, sue that link in the template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants