Add a "pre-ready" init hook for plugins to execute functions before the build begins

[Swader]

Feature request

Add a "pre-ready" init hook for plugins which exectues before everything else in the build step.

What problem does this feature solve?

This one. In short, it lets the user execute as many tasks as necessary before the body of the build begins, thereby no longer needing to run build twice because right now the build task speeds past the MD generation process.

What does the proposed API look like?

module.exports = {
    init () {
        console.log("Initializing MD pre-processing");

//...

How should this be implemented in your opinion?

Same way as ready.

Are you willing to work on this yourself?

This is being bountied on Gitcoin.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 100.0 DAI (100.0 USD @ $1.0/DAI) attached to it as part of the Swader fund.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $144,096.81 more funded OSS Work available on the Gitcoin Issue Explorer

[Swader]

@ulivz @yyx990803 I have taken the liberty of bountying this feature request for 100 USD. If you could spread the word a little that'd be great.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Workers have applied to start work.

These users each claimed they can complete the work by 12 months from now.
Please review their action plans below:

1) bommie20 has applied to start work (Funders only: approve worker | reject worker).

module.exports = {
init () {
console.log("Initializing MD pre-processing");

//...

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Workers have applied to start work.

These users each claimed they can complete the work by 12 months from now.
Please review their action plans below:

1) bommie20 has applied to start work (Funders only: approve worker | reject worker).

module.exports = {
init () {
console.log("Initializing MD pre-processing");

//...

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

These users each claimed they can complete the work by 11 months, 3 weeks from now.
Please review their action plans below:

1) shad-k has been approved to start work.

Dont have much experience with Vue but have thorough knowledge of JS. Would be fun to work on this.

Learn more on the Gitcoin Issue Details page.

[gitcoinbot]

@shad-k Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work for 100.0 DAI (100.0 USD @ $1.0/DAI) has been submitted by:

1. @shad-k

@Swader please take a look at the submitted work:

• PR by @shad-k

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $134,293.74 more funded OSS Work available on the Gitcoin Issue Explorer

[kefranabg]

@Swader what you want to do is modify generated markdown files right?

Could you provide a real example of what you're trying to achieve?

[Swader]

Look into https://github.com/status-im/nimbus-docs-suite - what I do is define a list of repos for which to generate docs. The docs are generated by:

• grabbing the readme, cleaning it, and preparing an MD for an Overview doc
• grabbing the lib's source, running the language's API reference extractor (in this case Nim) and generating MD from those.
• grabbing cookbook recipes and tutorials (in progress) and generating cleaned MD files from those
• building all this to produce: https://nimbus-libs.status.im

The killer feature here is CI - this will let me easily plug this into CI so that changes to the master branch on any of the configured repos will trigger a rebuild, thus keeping the docs automatically up to date as the lib developers make changes, without needing further manual intervention from me. We can then focus on making the code and its native docs perfect, and it will be reflected in the docs suite.

Hope that clears it up

[Swader]

Ignored in favor of extracting plugin functionality into prepare.js and then making a command like:

"make": "node prepare && vuepress build"

Bounty can be considered completed, PR can be closed.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

The funding of 100.0 DAI (100.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @shad-k.

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $129,930.98 more funded OSS Work available on the Gitcoin Issue Explorer