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
feat: defineIntegration #8056
base: main
Are you sure you want to change the base?
feat: defineIntegration #8056
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
@@ -611,6 +622,129 @@ A list of all generated pages. It is an object with one property. | |||
|
|||
- `pathname` - the finalized path of the page. | |||
|
|||
## Helpers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just getting ahead of this a bit, not full review:
This says "helpers" (plural), but then only seems to define defineIntegration()
. Also, since this is an API reference page, thinking about what's scannable in the TOC, I think it might make more sense to have the actual code options visible vs descriptive headings. (People may often be using these pages to look things up, and seeing the various helpers/arguments etc. in the TOC makes that very easy to do.)
Would a structure like this make sense?
## `defineIntegration()`
<p><Since v="4.8.0" /></p>
### `optionsSchema`
<p><Since v="4.8.0" /></p>
### `setup`
<p><Since v="4.8.0" /></p>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have been thinking about this and my thinking was that, since we have a new entrypoint (astro/integration
), more things could be exported in the future. So I decided to create a section for all the things that may end up in there. Let me know what you think! But I don't think it's worth reviewing just yet because we need to go through all the rfc stages
Description (required)
AstroIntegration
bydefineIntegration
defineIntegration
z.custom<MyType>()
Related issues & labels (optional)
add new content
,minor release
For Astro version:
4.8
. See astro PR #10892.