fix: fixes after code review

nuxt-modules · May 12, 2022 · 3297711 · 3297711
1 parent 744d009
commit 3297711
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 65 deletions.
diff --git a/docs/content/en/api.md b/docs/content/en/api.md
@@ -28,18 +28,12 @@ All [Vue I18n properties and methods](http://kazupon.github.io/vue-i18n/api/#vue
 
  - **Arguments**:
  - locale: (type: `string`)
- - forcePrefix: (type: `boolean`)
  - **Returns**: `string`
 
  Returns path of the current route for specified `locale`. 
 
- If `forcePrefix` is set to `true`, it returns the path with the prefix. Useful for `prefix_and_default` strategy. 
- You can also set global behavior through option prefixAndDefaultRules.
-
  See also [Basic usage - nuxt-link](../basic-usage#nuxt-link).
 
- See more details about [prefixAndDefaultRules](../options-reference#prefixanddefaultrules).
-
  See type definition for [Location](https://github.com/vuejs/vue-router/blob/f40139c27a9736efcbda69ec136cb00d8e00fa97/types/router.d.ts#L125).
 
 ### getRouteBaseName()

diff --git a/docs/content/en/options-reference.md b/docs/content/en/options-reference.md
@@ -186,18 +186,16 @@ Set this to `true` when using different domains for each locale. If enabled, no
 
 Whether [custom paths](/routing#custom-paths) are extracted from page files using babel parser.
 
-## `prefixAndDefaultRules`
+## `prefixAndDefaultRule`
 
 - type: `object`
-- default: `{ routing: 'default', switchLocale: 'default' }`
+- default: `'default'`
 
 Modification of the standard behavior of the `prefix_and_default` strategy.
 
-By setting the value `routing = 'prefix'` we are no longer being redirected from prefixed path.
+By setting the value `prefixAndDefaultRule = 'prefix'` we are no longer being redirected from prefixed path.
 If there is no prefix then the other routers will also have no prefix.
 
-By setting the value `switchLocale = 'prefix'` the `switchLocalePath()` method adds a prefix to the current route.
-
 ## `pages`
 
 - type: `object`

diff --git a/docs/content/en/strategies.md b/docs/content/en/strategies.md
@@ -29,7 +29,7 @@ With this strategy, all routes will have a locale prefix.
 
 This strategy combines both previous strategies behaviours, meaning that you will get URLs with prefixes for every language, but URLs for the default language will also have a non-prefixed version (though the prefixed version will be preferred when `detectBrowserLanguage` is enabled.)
 
-The behavior of the strategy can be modified, more - [prefixAndDefaultRules](../options-reference#prefixanddefaultrules)
+The behavior of the strategy can be modified, more - [prefixAndDefaultRule](../options-reference#prefixanddefaultrule)
 
 ### Configuration
 

diff --git a/package.json b/package.json
@@ -23,6 +23,7 @@
  },
  "scripts": {
  "dev:basic": "nuxt -c ./test/fixture/basic/nuxt.config.js",
+ "dev:redirect": "nuxt -c ./test/fixture/disable-redirect/nuxt.config.js",
  "dev:basic:generate": "nuxt generate -c ./test/fixture/basic/nuxt.config.js",
  "dev:basic:start": "nuxt start -c ./test/fixture/basic/nuxt.config.js",
  "start:dist": "jiti ./test/utils/http-server-internal.js --port 8080 -v dist",

diff --git a/src/helpers/constants.js b/src/helpers/constants.js
@@ -38,7 +38,6 @@ export const DEFAULT_OPTIONS = {
  routesNameSeparator: '___',
  defaultLocaleRouteNameSuffix: 'default',
  prefixAndDefaultRules: {
- switchLocale: 'default',
  routing: 'default'
  },
  sortRoutes: true,

diff --git a/src/templates/plugin.main.js b/src/templates/plugin.main.js
@@ -15,7 +15,7 @@ import {
  loadLanguageAsync,
  resolveBaseUrl,
  registerStore,
- mergeAdditionalMessages
+ mergeAdditionalMessages, getHelpers
 } from './plugin.utils'
 // @ts-ignore
 import { joinURL } from '~i18n-ufo'
@@ -154,8 +154,7 @@ export default async (context) => {
 
  const isStaticGenerate = process.static && process.server
  const isDifferentLocale = getLocaleFromRoute(route) !== newLocale
- const isPrefixAndDefaultStrategy = options.strategy === Constants.STRATEGIES.PREFIX_AND_DEFAULT
- const isDefaultLocale = newLocale === options.defaultLocale
+ const { isPrefixAndDefault, isDefaultLocale } = getHelpers(newLocale)
 
  // Decide whether we should redirect to a different route.
  if (
@@ -164,11 +163,12 @@ export default async (context) => {
  options.strategy !== Constants.STRATEGIES.NO_PREFIX &&
  // Skip if already on the new locale unless the strategy is "prefix_and_default" and this is the default
  // locale, in which case we might still redirect as we prefer unprefixed route in this case, but let user a
- // possibility to disable this behavior by switching disableDefaultRedirect option to true.
- (isDifferentLocale || (isPrefixAndDefaultStrategy && isDefaultLocale))
+ // possibility to disable this behavior by switching prefixAndDefaultRules.routing option to prefix.
+ (isDifferentLocale || (isPrefixAndDefault && isDefaultLocale && options.prefixAndDefaultRules.routing === 'default'))
  ) {
- const routePath = app.localePath(route.fullPath, newLocale)
-
+ // The current route could be 404 in which case attempt to find matching route using the full path since
+ // "switchLocalePath" can only find routes if the current route exists.
+ const routePath = app.switchLocalePath(newLocale) || app.localePath(route.fullPath, newLocale)
  if (routePath && routePath !== route.fullPath && !routePath.startsWith('//')) {
  redirectPath = routePath
  }

diff --git a/src/templates/plugin.routing.js b/src/templates/plugin.routing.js
@@ -1,7 +1,7 @@
 import './middleware'
 import Vue from 'vue'
 import { Constants, nuxtOptions, options } from './options'
-import { getDomainFromLocale } from './plugin.utils'
+import { getDomainFromLocale, getHelpers } from './plugin.utils'
 import { removeLocaleFromPath } from './utils-common'
 // @ts-ignore
 import { withoutTrailingSlash, withTrailingSlash } from '~i18n-ufo'
@@ -79,11 +79,11 @@ function resolveRoute (route, locale) {
  hash: resolvedRoute.hash
  }
  } else {
- const { isDefaultLocale, isPrefixAndDefault } = getHelpers(locale)
+ const { isDefaultLocale, isPrefixAndDefault, isPrefixExceptDefault } = getHelpers(locale)
  // if route has a path defined but no name, resolve full route using the path
  const isPrefixed =
  // don't prefix default locale, if not forced
- !(isDefaultLocale && isPrefixAndDefault && forceDefaultRoute) &&
+ !(isDefaultLocale && (isPrefixExceptDefault || (isPrefixAndDefault && forceDefaultRoute))) &&
  // no prefix for any language
  !(options.strategy === Constants.STRATEGIES.NO_PREFIX) &&
  // no prefix for different domains
@@ -120,7 +120,7 @@ function resolveRoute (route, locale) {
  * @this {import('../../types/internal').PluginProxy}
  * @type {Vue['switchLocalePath']}
  */
-function switchLocalePath (locale, forcePrefix = false) {
+function switchLocalePath (locale) {
  const name = this.getRouteBaseName()
  if (!name) {
  return ''
@@ -143,11 +143,11 @@ function switchLocalePath (locale, forcePrefix = false) {
  })
  let path = this.localePath(baseRoute, locale)
 
- const { prefixAndDefaultRules: { switchLocale } } = options
+ const { prefixAndDefaultRules } = options
  const { isPrefixAndDefault, isDefaultLocale } = getHelpers(locale)
- const shouldSwitchToPrefix = switchLocale === 'prefix'
+ const shouldSwitchToPrefix = prefixAndDefaultRules.routing === 'prefix'
 
- if (isPrefixAndDefault && isDefaultLocale && (shouldSwitchToPrefix || forcePrefix)) {
+ if (isPrefixAndDefault && isDefaultLocale && shouldSwitchToPrefix) {
  const cleanPath = removeLocaleFromPath(path, [locale])
  const localizedPath = `/${locale}${cleanPath}`
  path = nuxtOptions.trailingSlash ? withTrailingSlash(localizedPath) : withoutTrailingSlash(localizedPath)
@@ -180,19 +180,6 @@ function getRouteBaseName (givenRoute) {
  return route.name.split(options.routesNameSeparator)[0]
 }
 
-/**
- * @param {string} locale
- */
-function getHelpers (locale = '') {
- const isDefaultLocale = locale === options.defaultLocale
- const isPrefixAndDefault = options.strategy === Constants.STRATEGIES.PREFIX_AND_DEFAULT
-
- return {
- isDefaultLocale,
- isPrefixAndDefault
- }
-}
-
 /**
  * @param {string | undefined} routeName
  * @param {string} locale
@@ -215,10 +202,10 @@ function getLocaleRouteName (routeName, locale, forceDefaultName = true) {
  */
 function shouldForceDefaultRoute (currentPath) {
  const { isPrefixAndDefault } = getHelpers()
- const { defaultLocale, prefixAndDefaultRules: { routing } } = options
+ const { defaultLocale, prefixAndDefaultRules } = options
  const isPrefixedPath = new RegExp(`^/${defaultLocale}(/|$)`).test(currentPath)
 
- if (!isPrefixAndDefault || routing === 'default') {
+ if (!isPrefixAndDefault || prefixAndDefaultRules.routing === 'default') {
  return true
  }
 

diff --git a/src/templates/plugin.utils.js b/src/templates/plugin.utils.js
@@ -1,5 +1,5 @@
 import isHTTPS from 'is-https'
-import { localeMessages, options } from './options'
+import { Constants, localeMessages, options } from './options'
 import { formatMessage } from './utils-common'
 // @ts-ignore
 import { hasProtocol } from '~i18n-ufo'
@@ -216,6 +216,21 @@ export function mergeAdditionalMessages (i18n, additionalMessages, localeCodes,
  }
 }
 
+/**
+ * @param {string} locale
+ */
+export function getHelpers (locale = '') {
+ const isDefaultLocale = locale === options.defaultLocale
+ const isPrefixAndDefault = options.strategy === Constants.STRATEGIES.PREFIX_AND_DEFAULT
+ const isPrefixExceptDefault = options.strategy === Constants.STRATEGIES.PREFIX_EXCEPT_DEFAULT
+
+ return {
+ isDefaultLocale,
+ isPrefixAndDefault,
+ isPrefixExceptDefault
+ }
+}
+
 /**
  * @param {any} value
  * @return {boolean}

diff --git a/test/fixture/disable-redirect/components/LangSwitcher.vue b/test/fixture/disable-redirect/components/LangSwitcher.vue
@@ -1,24 +1,13 @@
 <template>
  <ul class="lang-switcher">
  <li v-for="locale in $i18n.locales" :key="locale.code">
- <nuxt-link :to="switchLocalePath(locale.code, forcePrefix)">
+ <nuxt-link :to="switchLocalePath(locale.code)">
  {{ locale.code.toUpperCase() }}
  </nuxt-link>
  </li>
  </ul>
 </template>
 
-<script>
-export default {
- props: {
- forcePrefix: {
- type: Boolean,
- default: false
- }
- }
-}
-</script>
-
 <style scoped>
 .lang-switcher {
  margin: 20px;

diff --git a/test/fixture/disable-redirect/layouts/default.vue b/test/fixture/disable-redirect/layouts/default.vue
@@ -8,8 +8,6 @@
 
  <hr>
 
- <LangSwitcher force-prefix />
-
  <Nuxt />
  </div>
 </template>

diff --git a/test/fixture/disable-redirect/nuxt.config.js b/test/fixture/disable-redirect/nuxt.config.js
@@ -4,11 +4,11 @@ import BaseConfig from '../base.config'
 /** @type {import('@nuxt/types').NuxtConfig} */
 const config = {
  ...BaseConfig,
+ router: {
+ trailingSlash: true
+ },
  i18n: {
- prefixAndDefaultRules: {
- switchLocale: 'default',
- routing: 'prefix'
- },
+ prefixAndDefaultRule: 'default',
  strategy: 'prefix_and_default',
  locales: [
  {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -6,7 +6,7 @@ export { Locale }
 export type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default'
 export type Directions = 'ltr' | 'rtl' | 'auto'
 export type RedirectOnOptions = 'all' | 'root' | 'no prefix'
-export type PrefixAndDefaultRule = 'default' | 'prefix'
+export type RoutingRule = 'default' | 'prefix'
 
 export interface LocaleObject extends Record<string, any> {
  code: Locale
@@ -54,8 +54,7 @@ export interface BaseOptions {
 }
 
 export interface PrefixAndDefaultRules {
- switchLocale: PrefixAndDefaultRule
- routing: PrefixAndDefaultRule
+ routing: RoutingRule
 }
 
 export interface Options extends BaseOptions {

diff --git a/types/vue.d.ts b/types/vue.d.ts
@@ -41,7 +41,7 @@ interface NuxtI18nApi {
  localePath(route: RawLocation, locale?: string): string
  localeRoute(route: RawLocation, locale?: string): Route | undefined
  localeLocation(route: RawLocation, locale?: string): Location | undefined
- switchLocalePath(locale: string, forcePrefix?: boolean): string
+ switchLocalePath(locale: string): string
 }
 
 declare module 'vue-i18n' {