From e5babb6054aa7a5376278b6980f613d8ab2daf98 Mon Sep 17 00:00:00 2001 From: kazuya kawaguchi Date: Fri, 22 Sep 2023 09:59:19 +0900 Subject: [PATCH] BREAKING CHANGE: rename `getLocale` (#6) * BREAKING CHANGE: rename `getLocale` * fix --- README.md | 2 +- playground/browser/src/main.ts | 1 + src/h3.test.ts | 12 ++++++------ src/h3.ts | 6 ++++-- src/node.test.ts | 12 ++++++------ src/node.ts | 6 ++++-- src/web.test.ts | 12 ++++++------ src/web.ts | 6 ++++-- 8 files changed, 32 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 7bb78d6..9d2dda0 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ You can do `import { ... } from '@intlify/utils'` the above utilities - `getAcceptLanguages` - `getAcceptLanguage` -- `getLocale` +- `getAcceptLocale` - `getCookieLocale` - `setCookieLocale` diff --git a/playground/browser/src/main.ts b/playground/browser/src/main.ts index cf09e2f..ffd5c60 100644 --- a/playground/browser/src/main.ts +++ b/playground/browser/src/main.ts @@ -1,6 +1,7 @@ import './style.css' import intlifyLogo from '/intlify.svg' import { setupCounter } from './counter.ts' +// @ts-expect-error: The URL format of import identifier is not allowd in TS as default. import { isLocale } from 'https://esm.sh/@intlify/utils' document.querySelector('#app')!.innerHTML = ` diff --git a/src/h3.test.ts b/src/h3.test.ts index 222ace6..72411d4 100644 --- a/src/h3.test.ts +++ b/src/h3.test.ts @@ -4,8 +4,8 @@ import supertest from 'supertest' import { getAcceptLanguage, getAcceptLanguages, + getAcceptLocale, getCookieLocale, - getLocale, setCookieLocale, } from './h3.ts' import { DEFAULT_COOKIE_NAME, DEFAULT_LANG_TAG } from './constants.ts' @@ -97,7 +97,7 @@ describe('getAcceptLanguage', () => { }) }) -describe('getLocale', () => { +describe('getAcceptLocale', () => { test('basic', () => { const mockEvent = { node: { @@ -109,7 +109,7 @@ describe('getLocale', () => { }, }, } as H3Event - const locale = getLocale(mockEvent) + const locale = getAcceptLocale(mockEvent) expect(locale.baseName).toEqual('en-US') expect(locale.language).toEqual('en') @@ -127,7 +127,7 @@ describe('getLocale', () => { }, }, } as H3Event - const locale = getLocale(mockEvent) + const locale = getAcceptLocale(mockEvent) expect(locale.baseName).toEqual(DEFAULT_LANG_TAG) }) @@ -143,7 +143,7 @@ describe('getLocale', () => { }, }, } as H3Event - const locale = getLocale(mockEvent, 'ja-JP') + const locale = getAcceptLocale(mockEvent, 'ja-JP') expect(locale.baseName).toEqual('ja-JP') }) @@ -160,7 +160,7 @@ describe('getLocale', () => { }, } as H3Event - expect(() => getLocale(mockEvent, 'ja-JP')).toThrowError(RangeError) + expect(() => getAcceptLocale(mockEvent, 'ja-JP')).toThrowError(RangeError) }) }) diff --git a/src/h3.ts b/src/h3.ts index 4f6e01d..62b8131 100644 --- a/src/h3.ts +++ b/src/h3.ts @@ -70,7 +70,9 @@ export function getAcceptLanguage(event: H3Event): string { } /** - * get locale + * get {@link Intl.Locale | locale} from `accept-language` header + * + * @description wrap with {@link Intl.Locale | locale} * * @example * example for h3: @@ -93,7 +95,7 @@ export function getAcceptLanguage(event: H3Event): string { * * @returns {Intl.Locale} The first locale that resolved from `accept-language` header string, first language tag is used. if `*` (any language) or empty string is detected, return `en-US`. */ -export function getLocale( +export function getAcceptLocale( event: H3Event, lang = DEFAULT_LANG_TAG, ): Intl.Locale { diff --git a/src/node.test.ts b/src/node.test.ts index bfabe6a..38143f5 100644 --- a/src/node.test.ts +++ b/src/node.test.ts @@ -3,8 +3,8 @@ import supertest from 'supertest' import { getAcceptLanguage, getAcceptLanguages, + getAcceptLocale, getCookieLocale, - getLocale, setCookieLocale, } from './node.ts' import { createServer, IncomingMessage, OutgoingMessage } from 'node:http' @@ -64,14 +64,14 @@ describe('getAcceptLanguage', () => { }) }) -describe('getLocale', () => { +describe('getAcceptLocale', () => { test('basic', () => { const mockRequest = { headers: { 'accept-language': 'en-US,en;q=0.9,ja;q=0.8', }, } as IncomingMessage - const locale = getLocale(mockRequest) + const locale = getAcceptLocale(mockRequest) expect(locale.baseName).toEqual('en-US') expect(locale.language).toEqual('en') @@ -84,7 +84,7 @@ describe('getLocale', () => { 'accept-language': '*', }, } as IncomingMessage - const locale = getLocale(mockRequest) + const locale = getAcceptLocale(mockRequest) expect(locale.baseName).toEqual(DEFAULT_LANG_TAG) }) @@ -95,7 +95,7 @@ describe('getLocale', () => { 'accept-language': '*', }, } as IncomingMessage - const locale = getLocale(mockRequest, 'ja-JP') + const locale = getAcceptLocale(mockRequest, 'ja-JP') expect(locale.baseName).toEqual('ja-JP') }) @@ -106,7 +106,7 @@ describe('getLocale', () => { 'accept-language': 's', }, } as IncomingMessage - expect(() => getLocale(mockRequest, 'ja-JP')).toThrowError(RangeError) + expect(() => getAcceptLocale(mockRequest, 'ja-JP')).toThrowError(RangeError) }) }) diff --git a/src/node.ts b/src/node.ts index 6d06996..aec7191 100644 --- a/src/node.ts +++ b/src/node.ts @@ -68,7 +68,9 @@ export function getAcceptLanguage(request: IncomingMessage): string { } /** - * get locale + * get {@link Intl.Locale | locale} from `accept-language` header + * + * @description wrap with {@link Intl.Locale | locale} * * @example * example for Node.js request: @@ -91,7 +93,7 @@ export function getAcceptLanguage(request: IncomingMessage): string { * * @returns {Intl.Locale} The first locale that resolved from `accept-language` header string, first language tag is used. if `*` (any language) or empty string is detected, return `en-US`. */ -export function getLocale( +export function getAcceptLocale( request: IncomingMessage, lang = DEFAULT_LANG_TAG, ): Intl.Locale { diff --git a/src/web.test.ts b/src/web.test.ts index 077d860..55bbd37 100644 --- a/src/web.test.ts +++ b/src/web.test.ts @@ -2,8 +2,8 @@ import { describe, expect, test } from 'vitest' import { getAcceptLanguage, getAcceptLanguages, + getAcceptLocale, getCookieLocale, - getLocale, setCookieLocale, } from './web.ts' import { DEFAULT_COOKIE_NAME, DEFAULT_LANG_TAG } from './constants.ts' @@ -46,11 +46,11 @@ describe('getAcceptLanguage', () => { }) }) -describe('getLocale', () => { +describe('getAcceptLocale', () => { test('basic', () => { const mockRequest = new Request('https://example.com') mockRequest.headers.set('accept-language', 'en-US,en;q=0.9,ja;q=0.8') - const locale = getLocale(mockRequest) + const locale = getAcceptLocale(mockRequest) expect(locale.baseName).toEqual('en-US') expect(locale.language).toEqual('en') @@ -60,7 +60,7 @@ describe('getLocale', () => { test('accept-language is any language', () => { const mockRequest = new Request('https://example.com') mockRequest.headers.set('accept-language', '*') - const locale = getLocale(mockRequest) + const locale = getAcceptLocale(mockRequest) expect(locale.baseName).toEqual(DEFAULT_LANG_TAG) }) @@ -68,7 +68,7 @@ describe('getLocale', () => { test('specify default language', () => { const mockRequest = new Request('https://example.com') mockRequest.headers.set('accept-language', '*') - const locale = getLocale(mockRequest, 'ja-JP') + const locale = getAcceptLocale(mockRequest, 'ja-JP') expect(locale.baseName).toEqual('ja-JP') }) @@ -76,7 +76,7 @@ describe('getLocale', () => { test('RangeError', () => { const mockRequest = new Request('https://example.com') mockRequest.headers.set('accept-language', 's') - expect(() => getLocale(mockRequest, 'ja-JP')).toThrowError(RangeError) + expect(() => getAcceptLocale(mockRequest, 'ja-JP')).toThrowError(RangeError) }) }) diff --git a/src/web.ts b/src/web.ts index 7333ee0..5baf386 100644 --- a/src/web.ts +++ b/src/web.ts @@ -67,7 +67,9 @@ export function getAcceptLanguage(request: Request): string { } /** - * get locale + * get {@link Intl.Locale | locale} from `accept-language` header + * + * @description wrap with {@link Intl.Locale | locale} * * @example * example for Web API request on Bun: @@ -90,7 +92,7 @@ export function getAcceptLanguage(request: Request): string { * * @returns {Intl.Locale} The first locale that resolved from `accept-language` header string, first language tag is used. if `*` (any language) or empty string is detected, return `en-US`. */ -export function getLocale( +export function getAcceptLocale( request: Request, lang = DEFAULT_LANG_TAG, ): Intl.Locale {