Merge pull request #850 from nextcloud-libraries/feat/detect-language

feat(gettext): Add `detectLanguage` method and deprecate `detectLocale`

Author: susnux

CHANGELOG.md

@@ -6,6 +6,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## 3.2.0 - UNRELEASED
+### ℹ️ Notes
+The `GettextBuilder.detectLocale` method is deprecated and will be removed in the next major version.
+It is replaced with the `detectLanguage` method to make the method naming more consistent.
+
+### Added
+- TBD
+### Fixed
+- TBD
+### Changed
+- TBD
+
 ## 3.1.0 - 2024-05-07
 
 ### Added

lib/gettext.ts

@@ -33,8 +33,21 @@ class GettextBuilder {
 		return this
 	}
 
-	/** Try to detect locale from context with `en` as fallback value */
+	/**
+	 * Try to detect locale from context with `en` as fallback value
+	 * This only works within a Nextcloud page context.
+	 *
+	 * @deprecated use `detectLanguage` instead.
+	 */
 	detectLocale(): GettextBuilder {
+		return this.detectLanguage()
+	}
+
+	/**
+	 * Try to detect locale from context with `en` as fallback value.
+	 * This only works within a Nextcloud page context.
+	 */
+	detectLanguage(): GettextBuilder {
 		return this.setLanguage(getLanguage().replace('-', '_'))
 	}