Feature: Custom locales (#9157)

README.md

@@ -96,8 +96,9 @@ psql postgres -c "create database calckey with encoding = 'UTF8';"
 
 ## 💅 Customize
 
-- To add custom CSS for all users, edit `./custom/instance.css`.
+- To add custom CSS for all users, edit `./custom/assets/instance.css`.
-- To add static assets (such as images for the splash screen), place them in the `./custom/` directory. They'll then be avaliable on `https://yourinstance.tld/static-assets/filename.ext`.
+- To add static assets (such as images for the splash screen), place them in the `./custom/assets/` directory. They'll then be avaliable on `https://yourinstance.tld/static-assets/filename.ext`.
+- To add custom locales, place them in the `./custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: `en-FOO.yml`)
 - To update custom assets without rebuilding, just run `yarn run gulp`.
 
 ## 🧑‍🔬 Configuring a new instance

gulpfile.js

@@ -16,7 +16,7 @@ gulp.task('copy:backend:views', () =>
 );
 
 gulp.task('copy:backend:custom', () =>
-	gulp.src('./custom/*').pipe(gulp.dest('./packages/backend/assets/'))
+	gulp.src('./custom/assets/*').pipe(gulp.dest('./packages/backend/assets/'))
 );
 
 gulp.task('copy:client:fonts', () =>

locales/index.js

@@ -4,6 +4,8 @@
 
 const fs = require('fs');
 const yaml = require('js-yaml');
+let languages = []
+let languages_custom = []
 
 const merge = (...args) => args.reduce((a, c) => ({
 	...a,
@@ -13,33 +15,20 @@ const merge = (...args) => args.reduce((a, c) => ({
 		.reduce((a, [k, v]) => (a[k] = merge(v, c[k]), a), {})
 }), {});
 
-const languages = [
+
-	'ar-SA',
+fs.readdirSync(__dirname).forEach((file) => {
-	'cs-CZ',
+	if (file.includes('.yml')){
-	'da-DK',
+		file = file.slice(0, file.indexOf('.'))
-	'de-DE',
+		languages.push(file);
-	'en-US',
+	}
-	'es-ES',
+})
-	'fr-FR',
+
-	'id-ID',
+fs.readdirSync(__dirname + '/../custom/locales').forEach((file) => {
-	'it-IT',
+	if (file.includes('.yml')){
-	'ja-JP',
+		file = file.slice(0, file.indexOf('.'))
-	'ja-KS',
+		languages_custom.push(file);
-	'kab-KAB',
+	}
-	'kn-IN',
+})
-	'ko-KR',
-	'nl-NL',
-	'no-NO',
-	'pl-PL',
-	'pt-PT',
-	'ru-RU',
-	'sk-SK',
-	'ug-CN',
-	'uk-UA',
-	'vi-VN',
-	'zh-CN',
-	'zh-TW',
-];
 
 const primaries = {
 	'en': 'US',
@@ -51,6 +40,8 @@ const primaries = {
 const clean = (text) => text.replace(new RegExp(String.fromCodePoint(0x08), 'g'), '');
 
 const locales = languages.reduce((a, c) => (a[c] = yaml.load(clean(fs.readFileSync(`${__dirname}/${c}.yml`, 'utf-8'))) || {}, a), {});
+const locales_custom = languages_custom.reduce((a, c) => (a[c] = yaml.load(clean(fs.readFileSync(`${__dirname}/../custom/locales/${c}.yml`, 'utf-8'))) || {}, a), {});
+Object.assign(locales, locales_custom)
 
 module.exports = Object.entries(locales)
 	.reduce((a, [k ,v]) => (a[k] = (() => {