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

determine API / usage for plugins #209

Closed
1 of 5 tasks
thescientist13 opened this issue Sep 24, 2019 · 2 comments · Fixed by #466
Closed
1 of 5 tasks

determine API / usage for plugins #209

thescientist13 opened this issue Sep 24, 2019 · 2 comments · Fixed by #466
Assignees
Labels
alpha.4 CLI documentation Greenwood specific docs P0 Critical issue that should get addressed ASAP Plugins Greenwood Plugins v0.10.0
Milestone

Comments

@thescientist13
Copy link
Member

thescientist13 commented Sep 24, 2019

Type of Change

  • New Feature Request
  • Documentation / Website
  • Improvement / Suggestion
  • Bug
  • Other (please clarify below)

Summary

Coming out of conversations in #17 an initial implementation for plugins was captured and documented for the website in #187.

module.exports = {
  title: 'My Project',

  ...

  plugins: [{
    type: 'hook|webpack|data|lifecycle|transform',  // @string required, no default
    provider: (compilation) => { /* do stuff here */ } // @function required (@return depends on type), no default
  }]

There was also a PR opening this up for further discussion in #179 .

Details

The goal of this ticket is to close the loop on possible APIs for this as part of the upcoming RFCs around data sources (#115 / #21 ) and so would be good to finalize what we should do for this.

  • Class based? Or just functions?
  • What access to Greenwood's API should it have access? (read only?)
  • How to get data in / out
  • etc
@thescientist13 thescientist13 added website Tasks related to the projects website / documentation documentation Greenwood specific docs Plugins Greenwood Plugins CLI labels Sep 24, 2019
@thescientist13 thescientist13 added this to the MVP milestone Nov 26, 2019
@thescientist13 thescientist13 removed this from TODO in 4 - Data Sources Feb 27, 2020
@thescientist13 thescientist13 self-assigned this Nov 7, 2020
@thescientist13
Copy link
Member Author

This is happening now as part of #185

@thescientist13 thescientist13 moved this from TODO to IN REVIEW in 5 - Architectural Digest Dec 30, 2020
@thescientist13 thescientist13 removed their assignment Dec 30, 2020
@thescientist13 thescientist13 removed the website Tasks related to the projects website / documentation label Dec 30, 2020
@thescientist13
Copy link
Member Author

Documentation established in #466

@thescientist13 thescientist13 self-assigned this Jan 21, 2021
@thescientist13 thescientist13 added the P0 Critical issue that should get addressed ASAP label Jan 21, 2021
@thescientist13 thescientist13 linked a pull request Jan 21, 2021 that will close this issue
6 tasks
@thescientist13 thescientist13 moved this from IN REVIEW to DONE in 5 - Architectural Digest Jan 23, 2021
@thescientist13 thescientist13 mentioned this issue Jan 23, 2021
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alpha.4 CLI documentation Greenwood specific docs P0 Critical issue that should get addressed ASAP Plugins Greenwood Plugins v0.10.0
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants