refactor!: nuxt 3 only support #186

kylegl · 2023-09-24T07:43:17Z

In this PR, I have rewritten the Nuxt 3 component using the Composition API. To ensure type safety, I had to remove the Nuxt 2 module. I propose that we handle this similarly to Nuxt Image by maintaining two separate branches: v0 for Nuxt 2 and main for Nuxt 3.

There are few notable changes:

The module name in the Nuxt config has been changed from google-adsense to googleAdsense. This adjustment was made to resolve type errors caused by the hyphen.
The module config now accepts a new option called hideUnfilled. This option will hide any unfilled ads, as recommended in the Google AdSense documentation.
The adFormat component prop no longer defaults to auto. I encountered scenarios while using the module where I needed adFormat to be undefined, and this caused issues. A default global adFormat can be set in the module config options and overridden with component props if needed.
The component now exposes the showAd and updateAd methods, as well as an isUnfilled computed ref for user customization if needed.

This PR fixes issue #174 #173

chore: remove nuxt2 compatibility docs: update readme

chore: cleanup fix: ad client chore: cleanup fix: module client id check refactor: adsense computed properties style: layout feat: update ad on query change feat: option to hide unfilled ads chore: expose composable methods from component fix: hideUnfilled global chore: remove default ad format

kylegl · 2023-09-25T04:54:24Z

@manniL

manniL · 2023-09-25T07:05:53Z

@kylegl Thanks for the PR! Good work 👏

This means that the module is not Nuxt 2 compatible anymore, right? Hence we'd need a new major version (as mentioned in the updated README).

manniL · 2023-09-25T07:13:05Z

README.md

@@ -130,14 +152,24 @@ to handle updating ads on progressive web applications:

 Each time a new advertisement is requested, the AdSense parameter `data-ad-region` is
 updated to a random value. For this reason, you cannot set the `data-ad-region` attribute
-on the `<adsbygoogle />` component.
-
-For test mode, the following blog was used as a reference:


This is still applied in the component, right?

Yes it is still applied. I just capitalized the component name and removed the link to the blog that 404s here.

manniL · 2023-09-25T07:13:32Z

package.json

@@ -1,12 +1,13 @@
 {
  "name": "@nuxtjs/google-adsense",
-  "version": "2.1.0",
+  "version": "1.0.0",


Probably has to go to 3.x then

Suggested change

"version": "1.0.0",

"version": "3.0.0",

kylegl · 2023-09-25T10:39:57Z

@kylegl Thanks for the PR! Good work 👏

This means that the module is not Nuxt 2 compatible anymore, right? Hence we'd need a new major version (as mentioned in the updated README).

Thanks!

Correct, this pr removes Nuxt 2 compatibility. I wanted to get your thoughts on how to handle this.

Did you happen to see how the Nuxt Image module handled dropping Nuxt 2? They made a branch for Nuxt 2 and branch for Nuxt 3. Then to install Nuxt 2 module is pnpm install @nuxt/image and to install Nuxt 3 is @nuxt/ image@rc.

I think having separate branches might be better because the docs & config are different, but I'm not sure the best way to handle it.
@manniL I'd be happy to set this up. lmk if I can help in anyway.

manniL · 2023-10-02T08:12:44Z

Correct, this pr removes Nuxt 2 compatibility. I wanted to get your thoughts on how to handle this.

I think having separate branches might be better because the docs & config are different, but I'm not sure the best way to handle it. @manniL I'd be happy to set this up. lmk if I can help in anyway.

I think the easiest is mentioning that the Nuxt 2 version can be found under branch XYZ and the package only supports Nuxt 3 from major version ABC on.

That shouldn't be an issue at all 👍

CHANGELOG.md

README.md

manniL · 2023-10-02T09:02:54Z

@kylegl created a legacy-v2 branch and annotated some more things! Please tag for a re-review, then I think it is good to merge 👍

Co-authored-by: Alexander Lichter <github@lichter.io>

kylegl · 2023-10-02T09:16:47Z

Excellent, everything looks good to go!

package.json

kylegl added 6 commits September 24, 2023 00:39

refactor: nuxt 3 component composition api

70c78f8

chore: remove nuxt2 compatibility docs: update readme

chore: update nuxt module builder packages

a635a93

docs: update readme

61e5e4f

style: playground

460ca89

chore(release): v0.0.1

e60edec

manniL self-requested a review September 25, 2023 07:05

manniL reviewed Sep 25, 2023

View reviewed changes

kylegl and others added 2 commits October 1, 2023 18:29

fix: vueuse dependency

049a081

Merge pull request #7 from kylegl/fix/vueuse-dependency

cedaa8f

manniL reviewed Oct 2, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

kylegl and others added 6 commits October 2, 2023 02:12

Update CHANGELOG.md

5f0b887

Co-authored-by: Alexander Lichter <github@lichter.io>

Update README.md

c154ccb

Co-authored-by: Alexander Lichter <github@lichter.io>

Update README.md

4d29bf8

Co-authored-by: Alexander Lichter <github@lichter.io>

Update README.md

78bfef6

Co-authored-by: Alexander Lichter <github@lichter.io>

Update README.md

9409014

Co-authored-by: Alexander Lichter <github@lichter.io>

Update README.md

75e1222

Co-authored-by: Alexander Lichter <github@lichter.io>

kylegl requested a review from manniL October 2, 2023 09:18

manniL reviewed Oct 2, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

manniL reviewed Oct 2, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

manniL added 3 commits October 2, 2023 11:54

Update package.json

6c1c756

Update package.json

4a08033

Update package.json

8f6eb23

manniL changed the title ~~refactor: nuxt 3 component composition api~~ refactor: nuxt 3 only support Oct 2, 2023

manniL changed the title ~~refactor: nuxt 3 only support~~ refactor!: nuxt 3 only support Oct 2, 2023

manniL merged commit 4be3f96 into nuxt-modules:master Oct 2, 2023

This was referenced Oct 2, 2023

Update README.md #182

Closed

Update README.md #161

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: nuxt 3 only support #186

refactor!: nuxt 3 only support #186

kylegl commented Sep 24, 2023

kylegl commented Sep 25, 2023

manniL commented Sep 25, 2023 •

edited

manniL Sep 25, 2023

kylegl Sep 25, 2023 •

edited

manniL Sep 25, 2023 •

edited

kylegl commented Sep 25, 2023 •

edited

manniL commented Oct 2, 2023

manniL commented Oct 2, 2023

kylegl commented Oct 2, 2023

refactor!: nuxt 3 only support #186

refactor!: nuxt 3 only support #186

Conversation

kylegl commented Sep 24, 2023

kylegl commented Sep 25, 2023

manniL commented Sep 25, 2023 • edited

manniL Sep 25, 2023

Choose a reason for hiding this comment

kylegl Sep 25, 2023 • edited

Choose a reason for hiding this comment

manniL Sep 25, 2023 • edited

Choose a reason for hiding this comment

kylegl commented Sep 25, 2023 • edited

manniL commented Oct 2, 2023

manniL commented Oct 2, 2023

kylegl commented Oct 2, 2023

manniL commented Sep 25, 2023 •

edited

kylegl Sep 25, 2023 •

edited

manniL Sep 25, 2023 •

edited

kylegl commented Sep 25, 2023 •

edited