mirror of
https://github.com/go-task/task.git
synced 2024-12-12 10:45:49 +02:00
fix: crowdin progress
This commit is contained in:
Pete Davison
parent
d01b3c8979
commit
d96187ab89
@ -1,4 +1,4 @@
|
|||||||
import type {Config} from '@docusaurus/types';
|
import type { Config } from '@docusaurus/types';
|
||||||
import type * as Preset from '@docusaurus/preset-classic';
|
import type * as Preset from '@docusaurus/preset-classic';
|
||||||
import { EnumChangefreq } from 'sitemap';
|
import { EnumChangefreq } from 'sitemap';
|
||||||
|
|
||||||
@ -13,265 +13,241 @@ import { TWITTER_URL } from './constants';
|
|||||||
import lightCodeTheme from './src/themes/prismLight';
|
import lightCodeTheme from './src/themes/prismLight';
|
||||||
import darkCodeTheme from './src/themes/prismDark';
|
import darkCodeTheme from './src/themes/prismDark';
|
||||||
|
|
||||||
import { getTranslationProgress } from './src/api/crowdin.js';
|
import { getTranslationProgress, LanguageProgress } from './src/api/crowdin';
|
||||||
const translationProgress = getTranslationProgress();
|
|
||||||
|
|
||||||
const config: Config = {
|
function localeConfig(name: string, locale: string, translationProgress: Map<string, LanguageProgress>) {
|
||||||
title: 'Task',
|
let languageProgress = translationProgress.get(locale);
|
||||||
tagline: 'A task runner / simpler Make alternative written in Go ',
|
return {
|
||||||
url: 'https://taskfile.dev',
|
label: `${name} (${languageProgress.approvalProgress || 0}%)`,
|
||||||
baseUrl: '/',
|
direction: languageProgress.language.textDirection,
|
||||||
onBrokenLinks: 'warn',
|
htmlLang: languageProgress.language.locale,
|
||||||
onBrokenMarkdownLinks: 'warn',
|
}
|
||||||
favicon: 'img/favicon.ico',
|
}
|
||||||
|
|
||||||
organizationName: 'go-task',
|
export default async function createConfigAsync(): Promise<Config> {
|
||||||
projectName: 'task',
|
var translationProgress = await getTranslationProgress();
|
||||||
deploymentBranch: 'gh-pages',
|
return {
|
||||||
|
title: 'Task',
|
||||||
|
tagline: 'A task runner / simpler Make alternative written in Go ',
|
||||||
|
url: 'https://taskfile.dev',
|
||||||
|
baseUrl: '/',
|
||||||
|
onBrokenLinks: 'warn',
|
||||||
|
onBrokenMarkdownLinks: 'warn',
|
||||||
|
favicon: 'img/favicon.ico',
|
||||||
|
|
||||||
i18n: {
|
organizationName: 'go-task',
|
||||||
defaultLocale: 'en',
|
projectName: 'task',
|
||||||
locales: [
|
deploymentBranch: 'gh-pages',
|
||||||
'en',
|
|
||||||
'es-ES',
|
i18n: {
|
||||||
'fr-FR',
|
defaultLocale: 'en',
|
||||||
'ja-JP',
|
locales: [
|
||||||
'pt-BR',
|
'en',
|
||||||
'ru-RU',
|
'es-ES',
|
||||||
'tr-TR',
|
'fr',
|
||||||
'zh-Hans'
|
'ja',
|
||||||
],
|
'pt-BR',
|
||||||
localeConfigs: {
|
'ru',
|
||||||
en: {
|
'tr',
|
||||||
label: 'English',
|
'zh-Hans'
|
||||||
direction: 'ltr',
|
],
|
||||||
htmlLang: 'en-US'
|
localeConfigs: {
|
||||||
},
|
'es-ES': localeConfig('Español', 'es-ES', translationProgress),
|
||||||
'es-ES': {
|
'fr': localeConfig('Français', 'fr', translationProgress),
|
||||||
label: `Español (${translationProgress['es-ES'] || 0}%)`,
|
'ja': localeConfig('日本語', 'ja', translationProgress),
|
||||||
direction: 'ltr',
|
'pt-BR': localeConfig('Português', 'pt-BR', translationProgress),
|
||||||
htmlLang: 'es-ES'
|
'ru': localeConfig('Pусский', 'ru', translationProgress),
|
||||||
},
|
'tr': localeConfig('Türkçe', 'tr', translationProgress),
|
||||||
'fr-FR': {
|
'zh-Hans': localeConfig('简体中文', 'zh-CN', translationProgress),
|
||||||
label: `Français (${translationProgress['fr'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'fr-FR'
|
|
||||||
},
|
|
||||||
'ja-JP': {
|
|
||||||
label: `日本語 (${translationProgress['ja'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'ja-JP'
|
|
||||||
},
|
|
||||||
'pt-BR': {
|
|
||||||
label: `Português (${translationProgress['pt-BR'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'pt-BR'
|
|
||||||
},
|
|
||||||
'ru-RU': {
|
|
||||||
label: `Pусский (${translationProgress['ru'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'ru-RU'
|
|
||||||
},
|
|
||||||
'tr-TR': {
|
|
||||||
label: `Türkçe (${translationProgress['tr'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'tr-TR'
|
|
||||||
},
|
|
||||||
'zh-Hans': {
|
|
||||||
label: `简体中文 (${translationProgress['zh-CN'] || 0}%)`,
|
|
||||||
direction: 'ltr',
|
|
||||||
htmlLang: 'zh-Hans'
|
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
},
|
|
||||||
|
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
'classic',
|
'classic',
|
||||||
{
|
{
|
||||||
docs: {
|
docs: {
|
||||||
routeBasePath: '/',
|
routeBasePath: '/',
|
||||||
sidebarPath: './sidebars.ts',
|
sidebarPath: './sidebars.ts',
|
||||||
remarkPlugins: [remarkGithub, remarkGfm],
|
remarkPlugins: [remarkGithub, remarkGfm],
|
||||||
includeCurrentVersion: true,
|
includeCurrentVersion: true,
|
||||||
versions: {
|
versions: {
|
||||||
current: {
|
current: {
|
||||||
label: `Next 🚧`,
|
label: `Next 🚧`,
|
||||||
path: 'next',
|
path: 'next',
|
||||||
badge: false
|
badge: false
|
||||||
},
|
},
|
||||||
latest: {
|
latest: {
|
||||||
label: 'Latest',
|
label: 'Latest',
|
||||||
badge: false
|
badge: false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
blog: {},
|
||||||
|
theme: {
|
||||||
|
customCss: [
|
||||||
|
'./src/css/custom.css',
|
||||||
|
'./src/css/carbon.css',
|
||||||
|
]
|
||||||
|
},
|
||||||
|
gtag: {
|
||||||
|
trackingID: 'G-4RT25NXQ7N',
|
||||||
|
anonymizeIP: true
|
||||||
|
},
|
||||||
|
sitemap: {
|
||||||
|
changefreq: EnumChangefreq.WEEKLY,
|
||||||
|
priority: 0.5,
|
||||||
|
ignorePatterns: ['/tags/**']
|
||||||
}
|
}
|
||||||
},
|
} satisfies Preset.Options,
|
||||||
blog: {},
|
]
|
||||||
theme: {
|
],
|
||||||
customCss: [
|
|
||||||
'./src/css/custom.css',
|
|
||||||
'./src/css/carbon.css',
|
|
||||||
]
|
|
||||||
},
|
|
||||||
gtag: {
|
|
||||||
trackingID: 'G-4RT25NXQ7N',
|
|
||||||
anonymizeIP: true
|
|
||||||
},
|
|
||||||
sitemap: {
|
|
||||||
changefreq: EnumChangefreq.WEEKLY,
|
|
||||||
priority: 0.5,
|
|
||||||
ignorePatterns: ['/tags/**']
|
|
||||||
}
|
|
||||||
} satisfies Preset.Options,
|
|
||||||
]
|
|
||||||
],
|
|
||||||
|
|
||||||
scripts: [
|
scripts: [
|
||||||
{
|
|
||||||
src: '/js/carbon.js',
|
|
||||||
async: true
|
|
||||||
}
|
|
||||||
],
|
|
||||||
|
|
||||||
themeConfig:{
|
|
||||||
metadata: [
|
|
||||||
{
|
{
|
||||||
name: 'og:image',
|
src: '/js/carbon.js',
|
||||||
content: 'https://taskfile.dev/img/og-image.png'
|
async: true
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
navbar: {
|
|
||||||
title: 'Task',
|
|
||||||
logo: {
|
|
||||||
alt: 'Task Logo',
|
|
||||||
src: 'img/logo.svg'
|
|
||||||
},
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
type: 'doc',
|
|
||||||
docId: 'intro',
|
|
||||||
position: 'left',
|
|
||||||
label: 'Docs'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
to: 'blog',
|
|
||||||
label: 'Blog',
|
|
||||||
position: 'left'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
to: '/donate',
|
|
||||||
position: 'left',
|
|
||||||
label: 'Donate'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: 'docsVersionDropdown',
|
|
||||||
position: 'right',
|
|
||||||
dropdownActiveClassDisabled: true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
type: 'localeDropdown',
|
|
||||||
position: 'right',
|
|
||||||
dropdownItemsAfter: [
|
|
||||||
{
|
|
||||||
to: '/translate/',
|
|
||||||
label: 'Help Us Translate'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: GITHUB_URL,
|
|
||||||
position: 'right',
|
|
||||||
className: "header-icon-link icon-github",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: DISCORD_URL,
|
|
||||||
position: 'right',
|
|
||||||
className: "header-icon-link icon-discord",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: TWITTER_URL,
|
|
||||||
position: 'right',
|
|
||||||
className: "header-icon-link icon-twitter",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: MASTODON_URL,
|
|
||||||
rel: 'me',
|
|
||||||
position: 'right',
|
|
||||||
className: "header-icon-link icon-mastodon",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
footer: {
|
|
||||||
style: 'dark',
|
|
||||||
links: [
|
|
||||||
{
|
|
||||||
title: 'Pages',
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
label: 'Installation',
|
|
||||||
to: '/installation/'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Usage',
|
|
||||||
to: '/usage/'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Donate',
|
|
||||||
to: '/donate/'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: 'Community',
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
label: 'GitHub',
|
|
||||||
href: GITHUB_URL
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Twitter',
|
|
||||||
href: TWITTER_URL
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Mastodon',
|
|
||||||
href: MASTODON_URL,
|
|
||||||
rel: 'me'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'Discord',
|
|
||||||
href: DISCORD_URL
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: 'OpenCollective',
|
|
||||||
href: 'https://opencollective.com/task'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
html: '<a target="_blank" href="https://www.netlify.com"><img src="https://www.netlify.com/v3/img/components/netlify-color-accent.svg" alt="Deploys by Netlify" /></a>'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
prism: {
|
|
||||||
theme: lightCodeTheme,
|
|
||||||
darkTheme: darkCodeTheme,
|
|
||||||
additionalLanguages: [
|
|
||||||
"bash", // aka. shell
|
|
||||||
"json",
|
|
||||||
"powershell"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
// NOTE(@andreynering): Don't worry, these keys are meant to be public =)
|
|
||||||
algolia: {
|
|
||||||
appId: '7IZIJ13AI7',
|
|
||||||
apiKey: '34b64ae4fc8d9da43d9a13d9710aaddc',
|
|
||||||
indexName: 'taskfile'
|
|
||||||
}
|
|
||||||
} satisfies Preset.ThemeConfig,
|
|
||||||
};
|
|
||||||
|
|
||||||
export default config;
|
themeConfig:{
|
||||||
|
metadata: [
|
||||||
|
{
|
||||||
|
name: 'og:image',
|
||||||
|
content: 'https://taskfile.dev/img/og-image.png'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
navbar: {
|
||||||
|
title: 'Task',
|
||||||
|
logo: {
|
||||||
|
alt: 'Task Logo',
|
||||||
|
src: 'img/logo.svg'
|
||||||
|
},
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
type: 'doc',
|
||||||
|
docId: 'intro',
|
||||||
|
position: 'left',
|
||||||
|
label: 'Docs'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
to: 'blog',
|
||||||
|
label: 'Blog',
|
||||||
|
position: 'left'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
to: '/donate',
|
||||||
|
position: 'left',
|
||||||
|
label: 'Donate'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'docsVersionDropdown',
|
||||||
|
position: 'right',
|
||||||
|
dropdownActiveClassDisabled: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'localeDropdown',
|
||||||
|
position: 'right',
|
||||||
|
dropdownItemsAfter: [
|
||||||
|
{
|
||||||
|
to: '/translate/',
|
||||||
|
label: 'Help Us Translate'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: GITHUB_URL,
|
||||||
|
position: 'right',
|
||||||
|
className: "header-icon-link icon-github",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: DISCORD_URL,
|
||||||
|
position: 'right',
|
||||||
|
className: "header-icon-link icon-discord",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: TWITTER_URL,
|
||||||
|
position: 'right',
|
||||||
|
className: "header-icon-link icon-twitter",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: MASTODON_URL,
|
||||||
|
rel: 'me',
|
||||||
|
position: 'right',
|
||||||
|
className: "header-icon-link icon-mastodon",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
style: 'dark',
|
||||||
|
links: [
|
||||||
|
{
|
||||||
|
title: 'Pages',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Installation',
|
||||||
|
to: '/installation/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Usage',
|
||||||
|
to: '/usage/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Donate',
|
||||||
|
to: '/donate/'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Community',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'GitHub',
|
||||||
|
href: GITHUB_URL
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Twitter',
|
||||||
|
href: TWITTER_URL
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Mastodon',
|
||||||
|
href: MASTODON_URL,
|
||||||
|
rel: 'me'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Discord',
|
||||||
|
href: DISCORD_URL
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'OpenCollective',
|
||||||
|
href: 'https://opencollective.com/task'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
html: '<a target="_blank" href="https://www.netlify.com"><img src="https://www.netlify.com/v3/img/components/netlify-color-accent.svg" alt="Deploys by Netlify" /></a>'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
prism: {
|
||||||
|
theme: lightCodeTheme,
|
||||||
|
darkTheme: darkCodeTheme,
|
||||||
|
additionalLanguages: [
|
||||||
|
"bash", // aka. shell
|
||||||
|
"json",
|
||||||
|
"powershell"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
// NOTE(@andreynering): Don't worry, these keys are meant to be public =)
|
||||||
|
algolia: {
|
||||||
|
appId: '7IZIJ13AI7',
|
||||||
|
apiKey: '34b64ae4fc8d9da43d9a13d9710aaddc',
|
||||||
|
indexName: 'taskfile'
|
||||||
|
}
|
||||||
|
} satisfies Preset.ThemeConfig,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|||||||
@ -1,46 +0,0 @@
|
|||||||
const crowdin = require('@crowdin/crowdin-api-client');
|
|
||||||
const personalToken = process.env.CROWDIN_PERSONAL_TOKEN;
|
|
||||||
const projectId = '574591';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initialization of crowdin client
|
|
||||||
* @return {object} crowdin client
|
|
||||||
*/
|
|
||||||
const initClient = () => {
|
|
||||||
if (!personalToken) {
|
|
||||||
console.warn(
|
|
||||||
'No crowdin personal token, some features might not work as expected'
|
|
||||||
);
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return new crowdin.default({
|
|
||||||
token: personalToken
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get translation progress
|
|
||||||
* @return {object} translation progress
|
|
||||||
*/
|
|
||||||
export async function getTranslationProgress() {
|
|
||||||
let translationProgress = {};
|
|
||||||
const { translationStatusApi } = initClient() || {};
|
|
||||||
|
|
||||||
if (!translationStatusApi) {
|
|
||||||
return translationProgress;
|
|
||||||
}
|
|
||||||
|
|
||||||
await translationStatusApi
|
|
||||||
.getProjectProgress(projectId)
|
|
||||||
.then((res) => {
|
|
||||||
res.data.forEach((item) => {
|
|
||||||
translationProgress[item.data.languageId] = item.data.approvalProgress;
|
|
||||||
});
|
|
||||||
})
|
|
||||||
.catch((err) => {
|
|
||||||
console.error(err);
|
|
||||||
});
|
|
||||||
|
|
||||||
return translationProgress;
|
|
||||||
}
|
|
||||||
36
website/src/api/crowdin.ts
Normal file
36
website/src/api/crowdin.ts
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
import crowdin, { Credentials, TranslationStatusModel, ResponseObject, LanguagesModel, Languages } from '@crowdin/crowdin-api-client';
|
||||||
|
|
||||||
|
const projectId = 574591;
|
||||||
|
const credentials: Credentials = {
|
||||||
|
token: process.env.CROWDIN_PERSONAL_TOKEN,
|
||||||
|
};
|
||||||
|
|
||||||
|
// This adds the language field to LanguageProgress which is missing in the original model
|
||||||
|
export interface LanguageProgress extends TranslationStatusModel.LanguageProgress {
|
||||||
|
language: LanguagesModel.Language;
|
||||||
|
}
|
||||||
|
|
||||||
|
const initClient = () => {
|
||||||
|
if (credentials.token === '') {
|
||||||
|
console.warn(
|
||||||
|
'No crowdin personal token, some features might not work as expected'
|
||||||
|
);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return new crowdin(credentials);
|
||||||
|
};
|
||||||
|
|
||||||
|
export async function getTranslationProgress(): Promise<Map<string, LanguageProgress>> {
|
||||||
|
var progress = new Map<string, LanguageProgress>();
|
||||||
|
await initClient().translationStatusApi
|
||||||
|
.getProjectProgress(projectId)
|
||||||
|
.then((res) => {
|
||||||
|
res.data.forEach((item: ResponseObject<LanguageProgress>) => {
|
||||||
|
progress.set(item.data.language.id, item.data);
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.error(err);
|
||||||
|
});
|
||||||
|
return progress;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user