feat: add addDevToolbarPlugin and addIntegration utilities #64

jdtjenkins · 2024-02-18T23:36:20Z

Hey all!

The long awaited Dev Toolbar Framework App PR is here 🎉 !

So this PR adds two utilities:

addDevToolbarFrameworkApp and addIntegration.

Starting with addIntegration - this is a small util that simply adds an integration from an integration. Very useful for `addDevToolbarFrameworkApp. It's useful to add the Astro framework integrations from your integration meaning you're not relying on your user then also having to install and add it. But it will check if it's already installed, and if it is it won't add it again.

addDevToolbarFrameworkApp, as I'm sure can all guess, adds a dev toolbar plugin. But it allows you to define a framework and a path to a framework component so you can load framework components into a dev toolbar plugin.

The addDevToolbarFrameworkApp API also has an added benefit of being close(r) to what the Astro teams wants the addDevToolbarApp API to be in the future. So when we go to core.... This may be good? I dunno, but it's cool though!

All examples of the plugins are available in the playground!

Cheers all!

Closes #13

netlify · 2024-02-18T23:36:39Z

✅ Deploy Preview for astro-integration-kit ready!

Name	Link
🔨 Latest commit	`71e0512`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-integration-kit/deploys/65e0a2f97cf38f00083f5543
😎 Deploy Preview	https://deploy-preview-64--astro-integration-kit.netlify.app/utilities/add-devtoolbar-framework-app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

package/package.json

florian-lefebvre

can't review more just yet but a few comments! also i'm not sold on the utility name, plugin could be confusing with aik plugins. i get that you can't just use addDevToolbarApp but may be worth tinkering a little bit

docs/src/content/docs/utilities/add-devtoolbar-plugin.mdx

florian-lefebvre

my comments on the preact stub applies to all of them
may be worth documenting how to load the icon from a file, or even provide an helper. that's a bit nicer dx imo

docs/src/content/docs/utilities/add-devtoolbar-plugin.mdx

docs/src/content/docs/utilities/add-integration.mdx

package/src/utilities/add-devtoolbar-plugin.ts

package/src/utilities/add-integration.ts

package/src/utilities/addDevToolbarPluginStubs/preact.ts

Co-authored-by: Florian Lefebvre <[email protected]>

package/src/utilities/add-devtoolbar-framework-app.ts

package/src/utilities/add-integration.ts

package/src/utilities/addDevToolbarFrameWorkAppStubs/preact.ts

package/src/utilities/addDevToolbarFrameWorkAppStubs/react.ts

Co-authored-by: Florian Lefebvre <[email protected]>

…gration-kit into issue-13-2

package/package.json

package/src/core/types.ts

package/src/stubs/add-devtoolbar-framework-app/preact.ts

package/src/utilities/add-devtoolbar-framework-app.ts

package/src/plugins/add-integration.ts

package/src/utilities/add-devtoolbar-framework-app.ts

florian-lefebvre

We're getting real close this time! Btw, what is test-vue-app?

docs/astro.config.ts

docs/src/content/docs/utilities/add-devtoolbar-framework-app.mdx

package/package.json

package/src/utilities/add-devtoolbar-framework-app.ts

package/src/plugins/add-integration.ts

jdtjenkins · 2024-02-28T17:44:37Z

@florian-lefebvre test-vue-app was just a test to be more like an actual package with it's own deps. I can remove it... but it probably is good to test things work from a separate app too. Especially when when doing deps stuff. Like for example then I could remove the "vue" dep from playground but have it as a dep of test-vue-app

florian-lefebvre · 2024-02-29T07:06:53Z

Sounds good! Could that be nested inside a new top level folder? Like playground-packages or whatever

florian-lefebvre

LGTM! 🎉

…gration-kit into issue-13-2

Fryuni

So we won't check dependencies ourselves for now. It is great to reduce the scope.

Docs and comments LGTM, I have zero expertise with UI frameworks so it's all sorcery in my eyes. The sorcery is looking pretty though.

jdtjenkins added 9 commits February 14, 2024 15:29

add addDevToolbarPlugin and addIntegration plugins

71b1759

fix link

9289547

adds svelte, solid, styles and callback

17a0e2d

add jsdoc to adddevtoolbarplugin

7d13e70

lint fixes and peer deps

97400b7

adds addIntegration docs

9a62f8e

adds addDevToolbarPlugin docs

270dc19

Merge branch 'main' into issue-13-2

eb60e76

lint

d60a68d

Fryuni requested changes Feb 19, 2024

View reviewed changes

package/package.json Outdated Show resolved Hide resolved

florian-lefebvre requested changes Feb 19, 2024

View reviewed changes

florian-lefebvre requested changes Feb 20, 2024

View reviewed changes

jdtjenkins and others added 7 commits February 21, 2024 16:35

Update docs/src/content/docs/utilities/add-devtoolbar-plugin.mdx

8b35a38

Co-authored-by: Florian Lefebvre <[email protected]>

Update docs/src/content/docs/utilities/add-devtoolbar-plugin.mdx

0456d39

Co-authored-by: Florian Lefebvre <[email protected]>

adds addIntegration options, and addresses florian's comments

731fc42

Makes all peerDependencies peerDependenciesMeta

9bd1601

add optional spead thingy

07d1e47

Check for option peer dependency

3589fc1

renamed addDevToolbarPlugin -> addDevToolbarFrameworkApp

f673f61

jdtjenkins requested review from Fryuni and florian-lefebvre February 22, 2024 00:22

escapes backticks in icon

0d8b01e

florian-lefebvre requested changes Feb 22, 2024

View reviewed changes

jdtjenkins and others added 4 commits February 22, 2024 21:11

Update package/src/utilities/add-integration.ts

bbcef7a

Co-authored-by: Florian Lefebvre <[email protected]>

pr changes

584a082

Merge branch 'issue-13-2' of https://github.com/jdtjenkins/astro-inte…

e179538

…gration-kit into issue-13-2

Updates types in new utils and plugins

fd2c4c2

florian-lefebvre requested changes Feb 23, 2024

View reviewed changes

Adds options back to addIntegration and a bunch of other stuff

008c654

jdtjenkins added 3 commits February 24, 2024 18:30

update deps a bit

146e163

adds vue to playground

8147515

adds checks for node modules dealys

78d3624

Fryuni reviewed Feb 28, 2024

View reviewed changes

package/src/utilities/add-devtoolbar-framework-app.ts Outdated Show resolved Hide resolved

adds docs about peer deps and updates starlight

a8688c5

florian-lefebvre requested changes Feb 28, 2024

View reviewed changes

jdtjenkins added 2 commits February 28, 2024 17:25

Merge branch 'main' into issue-13-2

82256b0

pr comments

e1320e3

jdtjenkins added 2 commits February 28, 2024 17:51

remove devDep on astro

6bc9495

Update pnpm-lock.yaml

717d95d

jdtjenkins and others added 4 commits February 29, 2024 10:45

Moves test-vue-app to playground-packages

ad3f343

lints and changeset

aed9882

Update olive-students-change.md

dce5a88

Update add-devtoolbar-framework-app.mdx

34fc8d3

florian-lefebvre approved these changes Feb 29, 2024

View reviewed changes

florian-lefebvre requested a review from Fryuni February 29, 2024 15:04

jdtjenkins added 2 commits February 29, 2024 15:29

add test-vue-app to ignore changeset

65d3b56

Merge branch 'issue-13-2' of https://github.com/jdtjenkins/astro-inte…

71e0512

…gration-kit into issue-13-2

florian-lefebvre approved these changes Feb 29, 2024

View reviewed changes

Fryuni approved these changes Feb 29, 2024

View reviewed changes

florian-lefebvre changed the title ~~Issue 13 - Adds addDevToolbarPlugin and addIntegration utilities~~ feat: add addDevToolbarPlugin and addIntegration utilities Feb 29, 2024

florian-lefebvre merged commit 2863031 into florian-lefebvre:main Feb 29, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add addDevToolbarPlugin and addIntegration utilities #64

feat: add addDevToolbarPlugin and addIntegration utilities #64

jdtjenkins commented Feb 18, 2024 •

edited

Loading

netlify bot commented Feb 18, 2024 •

edited

Loading

florian-lefebvre left a comment

florian-lefebvre left a comment

florian-lefebvre left a comment

jdtjenkins commented Feb 28, 2024

florian-lefebvre commented Feb 29, 2024

florian-lefebvre left a comment

Fryuni left a comment

feat: add addDevToolbarPlugin and addIntegration utilities #64

feat: add addDevToolbarPlugin and addIntegration utilities #64

Conversation

jdtjenkins commented Feb 18, 2024 • edited Loading

netlify bot commented Feb 18, 2024 • edited Loading

✅ Deploy Preview for astro-integration-kit ready!

florian-lefebvre left a comment

Choose a reason for hiding this comment

florian-lefebvre left a comment

Choose a reason for hiding this comment

florian-lefebvre left a comment

Choose a reason for hiding this comment

jdtjenkins commented Feb 28, 2024

florian-lefebvre commented Feb 29, 2024

florian-lefebvre left a comment

Choose a reason for hiding this comment

Fryuni left a comment

Choose a reason for hiding this comment

jdtjenkins commented Feb 18, 2024 •

edited

Loading

netlify bot commented Feb 18, 2024 •

edited

Loading