feat(config): add `site.url` as an alternative to `baseUrl` #2481

dargmuesli · 2023-10-09T01:38:19Z

🔗 Linked issue

❓ Type of change

📖 Documentation (updates to the documentation or readme)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR adds support for reading Nuxt config's site.url, provided by Nuxt SEO's site-config module, marking i18n.baseUrl as deprecated.

Draft because:

nuxt-site-config does not (yet?) support options as functions, which has to be discussed

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

nuxt-studio · 2023-10-09T01:38:22Z

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
i18n	Edit on Studio ↗︎	View Live Preview	`7931245`

dargmuesli · 2023-10-09T01:41:01Z

package.json

@@ -90,6 +90,8 @@
    "knitwork": "^1.0.0",
    "magic-string": "^0.30.4",
    "mlly": "^1.4.2",
+    "nuxt-site-config": "^1.4.0",


@harlan-zw https://nuxtseo.com/site-config/getting-started/installation specifies that nuxt-site-config has to be installed along with nuxt-site-config-kit. As I only ever made use of a nuxt-site-config-kit import in this PR and ignoring the playground's useSiteConfig usage right now, I wonder: is it really required to install nuxt-site-config as well? And if so, why?

dargmuesli · 2023-10-09T01:44:07Z

playground/pages/blog.vue

  useScope: 'local'
 })
-console.log('locales', locales, baseUrl)
+const { url } = useSiteConfig()


TODO: this should require enabling the nuxt-site-config module on the playground.

specs/seo/baseUrl.spec.ts

BobbieGoede · 2023-10-10T08:16:46Z

While I'm in favor of supporting/using the config module, if we want to add this for v8 it will have to be backwards compatible. I feel it's important that we make an effort to prevent breaking changes between release candidates as we are working to stable release.

So hopefully there is a way to implement this while keeping compatibility and otherwise we will have to delay this until after v8 stable release.

dargmuesli · 2023-10-10T15:43:53Z

This change should be backwards compatible already and only make use of site.url if available. The only thing a user should see differ is the deprecation notice, which could theoretically be removed and reintroduced before v9.
I haven't done extensive testing yet though as I first want to resolve the threads above I opened myself before doing testing.

harlan-zw · 2023-10-10T15:55:06Z

src/module.ts

@@ -72,6 +73,12 @@ export default defineNuxtModule<NuxtI18nOptions>({
      )
    }

+    if (options.baseUrl && options.baseUrl !== '') {


I think a JSDoc deprecation should be enough without this. It's not really a problem if people want to keep their i18n config together

How would I add the JSDoc as that's picked from vue-i18n-routing?

How would I add the JSDoc as that's picked from vue-i18n-routing?

Something like this is possible, I think the original JSDoc would need to be copied and extended, unless there is some way to append to existing JSDoc that I'm unaware of 😅.

+ /** + * Custom JSDoc here! + */ + baseUrl?: I18nRoutingOptions<Context>['baseUrl'] } & Pick< I18nRoutingOptions<Context>, - | 'baseUrl'

harlan-zw · 2023-10-10T15:56:05Z

src/module.ts

+    const siteConfig = useSiteConfig()
+
+    if (siteConfig.url) {
+      options.baseUrl = siteConfig.url


Is this needed? We want to use set the baseUrl in a runtime environment so that it can be easily switched

Ah fair. Yeah, currently I only set it right here at build time, that should change.

In ea4a900 I made that change. There could be a better place of course as @BobbieGoede pointed out, but I don't feel knowledgeable enough to decide on that.

harlan-zw · 2023-10-10T15:57:54Z

docs/content/2.guide/16.migrating.md

+Use `site.url` instead of `i18n.baseUrl`.
+
+::alert{type="info"}
+The `site` configuration option stems from [Nuxt SEO's `site-config` module](https://nuxtseo.com/site-config), which `nuxt-i18n` makes use of now.


I think there will need to be some documentation on all the ways that site config can be set and hosted on this page. The docs aren't that friendly at the moment, something on my to-do list.

harlan-zw · 2023-10-10T15:58:34Z

docs/content/2.guide/16.migrating.md

@@ -83,6 +83,38 @@ Deprecated for the same reason as the `localeLocation()` Option API.

 Use `localeHead()` instead for the Options API style.

+### Deprecated `baseUrl` component option


We don't actually need to deprecate it, both would be valid and we can just push people to use site config instead. If they really want to use baseUrl then they should be free to.

I removed the deprecations.

harlan-zw · 2023-10-10T16:04:01Z

@BobbieGoede would you mind sharing what your understanding of the baseUrl does? I want to make sure we're covering the test cases and actually implementing the module makes sense.

From my understanding, it's just used for i18n head tags?

A couple of minor notes until I can do a proper review:

end user shouldn't have to migrate baseUrl to site.url, both should be valid - for now (we nudge towards site url for easier consolidation of config)
worth consolidating the trailingSlash config which nuxt-site-config also supports

BobbieGoede · 2023-10-10T18:11:24Z

@dargmuesli

This change should be backwards compatible already and only make use of site.url if available. The only thing a user should see differ is the deprecation notice, which could theoretically be removed and reintroduced before v9.

Ah right, my bad. I mistook the deprecation notices as having the original baseURL handling removed for some reason 😅.

It's good to support setting the value using nuxt-site-config, but deprecating baseUrl will be something to decide later/separately. For simplicity (for users) I think it is important to keep the ability to configure the module in a single place (the i18n key or module array).

I haven't done extensive testing yet though as I first want to resolve the threads above I opened myself before doing testing.

One thing to consider is layer support, especially when supporting multiple ways of setting options. In the current implementation a layer will override a project's baseUrl if the layer uses this new approach.

@harlan-zw

From my understanding, it's just used for i18n head tags?

As I understand it, this is correct. Most of this happens in vue-i18n-routing, which uses the config to set up the head tags*.

It is possible to override baseUrl by setting domain on locales, or by using a function to set it based on the Nuxt Context as seen here. When setting domain on locales, it is possible to override these using runtime config as well. These options exist to allow projects to support different languages using different domains, I'm not sure how this would interact with nuxt-site-config or when other modules rely on it as well.

*On a separate note, I've been wanting to look into implementing/replacing the head tag handling in vue-i18n-routing with unhead. Unfortunately right now I'm not yet familiar enough with either of these packages to do this, if you have time to give it a look and/or point me in the right direction, that would be greatly appreciated! 😅

kazupon · 2023-11-13T16:26:30Z

Sorry, I was preparing for vue fes japan, so I could not track of what was going on with this issue. 😅
How is going this PR?

dargmuesli · 2023-11-14T07:00:47Z

It's on my TODO list, but as it should be a backwards compatible feature addition I had other tasks with higher priority. I think I can continue to work on it this week.

harlan-zw · 2023-11-15T04:39:45Z

I also need to re-review this properly when I have some time

dargmuesli

I've removed the deprecations, added separate site.url tests besides the baseUrl tests and moved the site config to the runtime. That should form the groundwork I intended to lay. For further changes I'd need assistance from you people ❤️

Be invited to give examples on what needs to change or to submit PRs against this PR's base branch in my fork to get site config integrated into nuxt-i18n! 💪 🥳

dargmuesli requested review from harlan-zw and BobbieGoede October 9, 2023 01:38

dargmuesli commented Oct 9, 2023

View reviewed changes

harlan-zw reviewed Oct 10, 2023

View reviewed changes

dargmuesli self-assigned this Oct 19, 2023

feat(config): deprecate baseUrl in favor of site.url

c8cb6d8

dargmuesli force-pushed the feat/site-config branch from 7931245 to c8cb6d8 Compare November 15, 2023 23:11

dargmuesli added 3 commits November 16, 2023 00:40

chore(base-url): remove deprecation notice

130fa1c

test(site-url): use hook for url configuration

8bfafd5

feat(base-url): move site config sourcing to runtime

ea4a900

dargmuesli commented Nov 15, 2023

View reviewed changes

docs(types): add extended jsdoc

c83a50b

dargmuesli changed the title ~~feat(config): deprecate baseUrl in favor of site.url~~ feat(config): add site.url as an alternative to baseUrl Nov 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(config): add `site.url` as an alternative to `baseUrl` #2481

feat(config): add `site.url` as an alternative to `baseUrl` #2481

dargmuesli commented Oct 9, 2023

nuxt-studio bot commented Oct 9, 2023

dargmuesli Oct 9, 2023

dargmuesli Oct 9, 2023

BobbieGoede commented Oct 10, 2023

dargmuesli commented Oct 10, 2023

harlan-zw Oct 10, 2023

dargmuesli Nov 15, 2023

BobbieGoede Nov 15, 2023

dargmuesli Nov 15, 2023

harlan-zw Oct 10, 2023

dargmuesli Oct 10, 2023

dargmuesli Nov 15, 2023

harlan-zw Oct 10, 2023

harlan-zw Oct 10, 2023

dargmuesli Nov 15, 2023

harlan-zw commented Oct 10, 2023 •

edited

Loading

BobbieGoede commented Oct 10, 2023

kazupon commented Nov 13, 2023

dargmuesli commented Nov 14, 2023

harlan-zw commented Nov 15, 2023

dargmuesli left a comment

		@@ -83,6 +83,38 @@ Deprecated for the same reason as the `localeLocation()` Option API.

		Use `localeHead()` instead for the Options API style.

		### Deprecated `baseUrl` component option

feat(config): add site.url as an alternative to baseUrl #2481

Are you sure you want to change the base?

feat(config): add site.url as an alternative to baseUrl #2481

Conversation

dargmuesli commented Oct 9, 2023

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

nuxt-studio bot commented Oct 9, 2023

✅ Live Preview ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BobbieGoede commented Oct 10, 2023

dargmuesli commented Oct 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

harlan-zw commented Oct 10, 2023 • edited Loading

BobbieGoede commented Oct 10, 2023

kazupon commented Nov 13, 2023

dargmuesli commented Nov 14, 2023

harlan-zw commented Nov 15, 2023

dargmuesli left a comment

Choose a reason for hiding this comment

feat(config): add `site.url` as an alternative to `baseUrl` #2481

feat(config): add `site.url` as an alternative to `baseUrl` #2481

harlan-zw commented Oct 10, 2023 •

edited

Loading