Merge branch 'release/1.0.4'

nekofar · nekofar · commit f9cfd327b58a · 2023-07-28T22:57:33.000+03:30
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -4,14 +4,14 @@ daysUntilStale: 60
 daysUntilClose: 7
 # Issues with these labels will never be considered stale
 exemptLabels:
-    - pinned
-    - security
+  - pinned
+  - security
 # Label to use when marking an issue as stale
 staleLabel: wontfix
 # Comment to post when marking an issue as stale. Set to `false` to disable
 markComment: >
-    This issue has been automatically marked as stale because it has not had
-    recent activity. It will be closed if no further activity occurs. Thank you
-    for your contributions.
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
 # Comment to post when closing a stale issue. Set to `false` to disable
 closeComment: false
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -29,11 +29,11 @@ jobs:
   build: # Job named 'build'
     runs-on: ubuntu-latest # The type of machine to run the job on.
 
-    needs: [ guard ]
+    needs: [guard]
 
     strategy: # Allows you to create a matrix for job configuration.
       matrix:
-        node-version: [ 18.x, 19.x, 20.x ] # Running tests across different environments.
+        node-version: [18.x, 19.x, 20.x] # Running tests across different environments.
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps: # The sequence of tasks that make up a job.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.4] - 2023-07-28
+
+### <!-- 01 -->Features
+
+- Add Turkish language support to Lingui config
+
+### <!-- 04 -->Refactor
+
+- Update code formatting for readability
+- Update locale page to adhere to syntax standards
+- Add Turkish localization and translation
+- Simplify locale detection and broaden usability
+
+### <!-- 08 -->Miscellaneous Tasks
+
+- Add `@lingui/detect-locale` package
+
 ## [1.0.3] - 2023-07-28
 
 ### <!-- 07 -->Continuous Integrations
diff --git a/lingui.config.js b/lingui.config.js
@@ -1,6 +1,6 @@
 /** @type {import('@lingui/conf').LinguiConfig} */
 module.exports = {
-  locales: ['ar', 'en', 'fa'],
+  locales: ['ar', 'en', 'fa', 'tr'],
   sourceLocale: 'en',
   catalogs: [
     {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nextjs-lingui-template",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -17,6 +17,7 @@
     "@headlessui/react": "1.7.16",
     "@heroicons/react": "2.0.18",
     "@lingui/core": "4.3.0",
+    "@lingui/detect-locale": "4.2.1",
     "@lingui/react": "4.3.0",
     "clsx": "2.0.0",
     "langs": "2.0.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/components/locale-switcher.tsx b/src/components/locale-switcher.tsx
@@ -1,10 +1,10 @@
-import {useLocaleSwitcher} from '@/hooks/use-locale-switcher'
-import {availableLocales, getLocaleName} from '@/utils/locales'
-import {Menu, Transition} from '@headlessui/react'
-import {LanguageIcon} from '@heroicons/react/24/outline'
-import {Trans} from '@lingui/macro'
+import { useLocaleSwitcher } from '@/hooks/use-locale-switcher'
+import { availableLocales, getLocaleName } from '@/utils/locales'
+import { Menu, Transition } from '@headlessui/react'
+import { LanguageIcon } from '@heroicons/react/24/outline'
+import { Trans } from '@lingui/macro'
 import clsx from 'clsx'
-import {Fragment} from 'react'
+import { Fragment } from 'react'
 
 export function LocaleSwitcher() {
   const { changeLocale } = useLocaleSwitcher()
diff --git a/src/hooks/use-language-and-direction.ts b/src/hooks/use-language-and-direction.ts
@@ -1,6 +1,6 @@
-import {useLocale} from '@/hooks/use-locale'
-import {getLocaleDirection} from '@/utils/locales'
-import {useEffect} from 'react'
+import { useLocale } from '@/hooks/use-locale'
+import { getLocaleDirection } from '@/utils/locales'
+import { useEffect } from 'react'
 
 const updateDocumentAttributes = (language: string, direction: string) => {
   document.documentElement.lang = language
diff --git a/src/hooks/use-lingui-init.ts b/src/hooks/use-lingui-init.ts
@@ -1,6 +1,6 @@
-import {useLocale} from '@/hooks/use-locale'
-import {i18n, Messages} from '@lingui/core'
-import {useEffect} from 'react'
+import { useLocale } from '@/hooks/use-locale'
+import { i18n, Messages } from '@lingui/core'
+import { useEffect } from 'react'
 
 export function useLinguiInit(messages: Messages) {
   const locale = useLocale()
diff --git a/src/hooks/use-locale-switcher.ts b/src/hooks/use-locale-switcher.ts
@@ -1,7 +1,7 @@
-import {useLocale} from '@/hooks/use-locale'
-import {Locale} from '@/utils/locales'
-import {useRouter} from 'next/router'
-import {useCallback} from 'react'
+import { useLocale } from '@/hooks/use-locale'
+import { Locale } from '@/utils/locales'
+import { useRouter } from 'next/router'
+import { useCallback } from 'react'
 
 export function useLocaleSwitcher() {
   const router = useRouter()
@@ -22,8 +22,6 @@ export function useLocaleSwitcher() {
         pathName = pathName.replace(`[${k}]`, <string>router.query[k])
       })
 
-      // languageDetector.cache?.(nextLocale, ['cookie', 'localStorage'])
-
       await router.replace(pathName)
     },
     [locale, router],
diff --git a/src/hooks/use-locale.ts b/src/hooks/use-locale.ts
@@ -1,7 +1,7 @@
-import {defaultLocale, Locale} from '@/utils/locales'
-import {useRouter} from 'next/router'
+import { getLocale,Locale } from '@/utils/locales'
+import { useRouter } from 'next/router'
 
 export function useLocale(): Locale {
   const router = useRouter()
-  return (router.query.locale as Locale) || defaultLocale
+  return getLocale(router.query)
 }
diff --git a/src/locales/tr/messages.po b/src/locales/tr/messages.po
@@ -0,0 +1,30 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-07-28 22:38+0330\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: tr\n"
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"Plural-Forms: \n"
+
+#: src/pages/[locale]/index.tsx:28
+msgid "Building a Multi-Lingual Website"
+msgstr "Çok Dilli Bir Web Sitesi Oluşturma"
+
+#: src/pages/[locale]/index.tsx:18
+msgid "Next.js & Lingui: Building a Multi-Lingual Website"
+msgstr "Next.js & Lingui: Çok Dilli Bir Web Sitesi Oluşturma"
+
+#: src/components/locale-switcher.tsx:20
+msgid "Open options"
+msgstr "Seçenekleri aç"
+
+#: src/pages/[locale]/index.tsx:31
+msgid "Welcome to our Next.js and Lingui demo site! Discover the power of combining Next.js, a powerful React framework for building server-side rendered applications, with Lingui, the ultimate solution for multi-lingual support in your web projects."
+msgstr "Next.js ve Lingui demo sitemize hoş geldiniz! Sunucu tarafı render edilen uygulamalar oluşturmak için güçlü bir React çerçevesi olan Next.js ile, web projelerinizde çok dilli desteği için nihai çözüm olan Lingui'nin birleştirilme gücünü keşfedin."
diff --git a/src/pages/[locale]/index.tsx b/src/pages/[locale]/index.tsx
@@ -1,10 +1,10 @@
-import {LocaleSwitcher} from '@/components/locale-switcher'
-import {availableLocales, loadCatalog} from '@/utils/locales'
-import {GetStaticPropsContext} from 'next'
-import {Vazirmatn} from 'next/font/google'
+import { LocaleSwitcher } from '@/components/locale-switcher'
+import { availableLocales, loadCatalog } from '@/utils/locales'
+import { Trans, t } from '@lingui/macro'
+import { useLingui } from '@lingui/react'
+import { GetStaticPropsContext } from 'next'
+import { Vazirmatn } from 'next/font/google'
 import Head from 'next/head'
-import {t, Trans} from "@lingui/macro";
-import {useLingui} from "@lingui/react";
 
 const vazirmatn = Vazirmatn({ subsets: ['latin', 'arabic'] })
 
diff --git a/src/pages/_app.tsx b/src/pages/_app.tsx
@@ -1,9 +1,9 @@
-import {useLanguageAndDirection} from '@/hooks/use-language-and-direction'
-import {useLinguiInit} from '@/hooks/use-lingui-init'
+import { useLanguageAndDirection } from '@/hooks/use-language-and-direction'
+import { useLinguiInit } from '@/hooks/use-lingui-init'
 import '@/styles/globals.css'
-import {i18n} from '@lingui/core'
-import {I18nProvider} from '@lingui/react'
-import type {AppProps} from 'next/app'
+import { i18n } from '@lingui/core'
+import { I18nProvider } from '@lingui/react'
+import type { AppProps } from 'next/app'
 
 export default function App({ Component, pageProps }: AppProps) {
   useLinguiInit(pageProps.translation)
diff --git a/src/pages/_document.tsx b/src/pages/_document.tsx
@@ -1,12 +1,13 @@
-import {defaultLocale, getLocaleDirection, Locale} from '@/utils/locales'
-import {Head, Html, Main, NextScript} from 'next/document'
-import {DocumentProps} from 'postcss'
+import { getLocale, getLocaleDirection, Locale } from '@/utils/locales'
+import { Head, Html, Main, NextScript } from 'next/document'
+import { DocumentProps } from 'postcss'
+import { ParsedUrlQuery } from 'querystring'
 
-type Props = DocumentProps & { __NEXT_DATA__: { query: { locale: string } } }
+type Props = DocumentProps & { __NEXT_DATA__: { query: ParsedUrlQuery } }
 
 export default function Document(props: Props) {
   const { __NEXT_DATA__: nextData } = props
-  const locale = nextData?.query?.locale || defaultLocale
+  const locale = getLocale(nextData.query)
 
   const language = locale as Locale
   const direction = getLocaleDirection(language)
diff --git a/src/pages/index.ts b/src/pages/index.ts
@@ -1,19 +1,20 @@
-import {defaultLocale, loadCatalog} from '@/utils/locales'
-import {useRouter} from 'next/router'
-import {useEffect} from 'react'
+import {defaultLocale, getLocale, loadCatalog} from '@/utils/locales'
+import { GetStaticPropsContext } from 'next'
+import { useRouter } from 'next/router'
+import { useEffect } from 'react'
 
 export default function Home() {
   const router = useRouter()
 
   useEffect(() => {
-    router.replace(`/${defaultLocale}`)
+    router.replace(`/${getLocale()}`)
   }, [router])
 
   return null
 }
 
 export const getStaticProps = async () => {
   return {
-    props: { translation: await loadCatalog(defaultLocale) },
+    props: { translation: await loadCatalog(getLocale()) },
   }
 }
diff --git a/src/utils/locales.ts b/src/utils/locales.ts
@@ -1,5 +1,7 @@
 import linguiConfig from '@/../lingui.config'
+import { detect, fromPath } from '@lingui/detect-locale'
 import langs from 'langs'
+import { ParsedUrlQuery } from 'querystring'
 
 export type Locale = (typeof linguiConfig.locales)[number]
 
@@ -19,10 +21,19 @@ export async function loadCatalog(locale: Locale): Promise<object> {
   }
 }
 
-export function getLocaleDirection(locale: Locale) {
-  return ['ar', 'he', 'fa'].includes(locale) ? 'rtl' : 'ltr'
+export function getLocale(query?: ParsedUrlQuery): Locale {
+  const localFromPath = typeof window !== 'undefined' ? fromPath(0) : undefined
+  const localeFromQuery = query?.locale
+
+  const detectedLocale = detect(localFromPath, localeFromQuery)
+
+  return detectedLocale || defaultLocale
 }
 
 export function getLocaleName(locale: Locale) {
   return langs.where(1, locale)!.local
 }
+
+export function getLocaleDirection(locale: Locale) {
+  return ['ar', 'he', 'fa'].includes(locale) ? 'rtl' : 'ltr'
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/** @type {import('@lingui/conf').LinguiConfig} */`
`2`	`2`	`module.exports = {`
`3`		`- locales: ['ar', 'en', 'fa'],`
	`3`	`+ locales: ['ar', 'en', 'fa', 'tr'],`
`4`	`4`	`sourceLocale: 'en',`
`5`	`5`	`catalogs: [`
`6`	`6`	`{`