erudit 3.0.0-dev.2 → 3.0.0-dev.21

package/languages/ru.ts

@@ -1,99 +1,112 @@
-const russian: EruditPhrases = {
-    _language_title: 'Русский',
-    _language_code: 'ru',
-
-    site_info_title: 'Erudit',
-    site_info_slogan: 'Современный учебник',
-    seo_index_title: 'Erudit - CMS для образовательных сайтов',
-    seo_index_description:
-        'Erudit — CMS для создания и управления идеальными образовательными сайтами, которые поддерживаются сообществом.',
-    seo_article_description: (contentTitle) =>
-        `Понятное и интересное объяснение темы «${contentTitle}». Показательные примеры, важные свойства, интересные факты, применение в жизни, понятные доказательства. Здесь вы точно разберетесь!`,
-    seo_summary_description: (contentTitle) =>
-        `Конспект темы «${contentTitle}»: ключевые определения, теоремы, свойства и примеры их использвания. Все самое важное и в кратком виде!`,
-    seo_practice_description: (contentTitle) =>
-        `Разнообразные задачи с подсказками и ответами по теме «${contentTitle}». Интересные условия, подсказки и подробные решения. Превратите знания в навык!`,
-    index: 'Оглавление',
-    pages: 'Страницы',
-    search: 'Поиск',
-    language: 'Язык',
-    other: 'Другое',
-    ads_replacer:
-        'Помогите нам улучшать проект.<br><strong>Включите показ рекламы!</strong>',
-    theme: 'Тема',
-    theme_system: 'Системная',
-    theme_light: 'Светлая',
-    theme_dark: 'Темная',
-    content: 'Контент',
-    generator: 'Генератор',
-    main_page: 'Главная страница',
-    members: 'Участники',
-    add_translation: 'Добавить перевод',
-    empty_nav: 'Пустая навигация',
-    flag_dev: 'Разработка',
-    flag_dev_description:
-        'Этот материал в разработке! Он может измениться в будущем и даже содержать ошибки!',
-    flag_advanced: 'Профиль',
-    flag_advanced_description:
-        'Этот материал предназначен для учеников с высоким уровнем понимания предмета. Информация здесь не предназначена для новичокв!',
-    flag_secondary: 'Дополнение',
-    flag_secondary_description:
-        'Это дополнительный материал для тех, кто хочет глубже погрузиться предмет и получить дополнительные знания и контекст.',
-    popover_dependencies: 'Зависимости',
-    popover_dependencies_description:
-        'Царского пути в эту тему нет! Вы сможете разобраться только если знаете следующие темы:',
-    to_index: 'К оглавлению',
-    about_book: 'Об учебнике',
-    close: 'Закрыть',
-    back: 'Назад',
-    goto: 'Перейти',
-    error: 'Ошибка!',
-    external_link: 'Внешняя ссылка',
-    external_link_warn: 'Вы собираетесь перейти на внешний ресурс!',
-    internal_link: 'Внутренняя ссылка',
-    internal_link_warn: 'Вы собираетесь перейти на внутреннюю страницу сайта!',
-    book: 'Книга',
-    group: 'Группа',
-    topic: 'Тема',
-    article: 'Статья',
-    summary: 'Конспект',
-    practice: 'Задачи',
-    contributor: 'Автор',
-    element_id: 'ID элемента',
-    preview_missing_title: 'Элемент не найден!',
-    preview_missing_explain:
-        'Не удалось найти на этой странице элемент с указанным ID!<br>Возможно, ID элемента указан неправильно или элемент был изменен/удален.',
-    preview_missing_explain_mismatch: `Не удалось найти на этой странице элемент с указанным ID!<br>Версия страницы, на которую вела ссылка, отличается от текущей версии страницы!<br>Скорее всего, именно это и является причиной ошибки.`,
-    preview_hash_mismatch_title: 'Несовпадение версий страницы!',
-    preview_hash_mismatch_explain:
-        'Версия страницы, которую вы видите сейчас отличается от версии страницы, на которую вела исходная ссылка!<br>Содержимое может отличаться от того, что вы ожидали увидеть.',
-    current_page_hash: 'Текущий хеш',
-    expected_page_hash: 'Ожидаемый хеш',
-    empty_toc: 'Пустая таблица содержимого...',
-    contributors: 'Авторы',
-    no_contributors: 'Авторов нет...',
-    make_contribution: 'Внести свой вклад',
-    material_improvement: 'Улучшение материала',
-    how_to_improve: 'Как улучшить?',
-    edit_page: 'Редактировать страницу',
-    report_problem: 'Сообщить о проблеме',
-    references: 'Источники',
-    reference_source_featured: 'Избранный источник',
-    references_description:
-        'Список внешних источников, которые использовались при написании этого материала. Для более глубокого погружения в материал рекомендуются ознакомиться с ними подробнее, особенно с избранными источниками, которые отмечены звездочкой:',
-};
-
-export default russian;
-
-export function m(
-    number: number,
-    one: string,
-    two: string,
-    five: string,
-    includeNumber = true,
-) {
-    const text = [five, one, two, two, two, five][
-        number % 100 > 10 && number % 100 < 20 ? 0 : Math.min(number % 10, 5)
-    ];
-    return includeNumber ? `${number} ${text}` : text;
-}
+const russian: EruditPhrases = {
+    _language_title: 'Русский',
+    _language_code: 'ru',
+
+    site_info_title: 'Erudit',
+    site_info_slogan: 'Современный учебник',
+    seo_index_title: 'Erudit - CMS для образовательных сайтов',
+    seo_index_description:
+        'Erudit — CMS для создания и управления идеальными образовательными сайтами, которые поддерживаются сообществом.',
+    seo_article_description: (contentTitle) =>
+        `Понятное и интересное объяснение темы «${contentTitle}». Показательные примеры, важные свойства, интересные факты, применение в жизни, понятные доказательства. Здесь вы точно разберетесь!`,
+    seo_summary_description: (contentTitle) =>
+        `Конспект темы «${contentTitle}»: ключевые определения, теоремы, свойства и примеры их использвания. Все самое важное и в кратком виде!`,
+    seo_practice_description: (contentTitle) =>
+        `Разнообразные задачи с подсказками и ответами по теме «${contentTitle}». Интересные условия, подсказки и подробные решения. Превратите знания в навык!`,
+    index: 'Оглавление',
+    pages: 'Страницы',
+    search: 'Поиск',
+    language: 'Язык',
+    other: 'Другое',
+    ads_replacer:
+        'Помогите улучшать проект.<br><strong>Включите показ рекламы!</strong>',
+    theme: 'Тема',
+    theme_system: 'Системная',
+    theme_light: 'Светлая',
+    theme_dark: 'Темная',
+    content: 'Контент',
+    main_page: 'Главная страница',
+    contributors: 'Авторы',
+    contributors_page_description:
+        'Список людей, которые внесли вклад в материалы проекта: предложили ценные идеи, вносили корректировки в существующий материал или же написали собственный!',
+    contributors_page_invite:
+        'Вы тоже можете помочь проекту, внести свой вклад и попасть на эту страницу!',
+    become_contributor: 'Стать автором',
+    contributor: 'Автор',
+    contribution: 'Вклад',
+    contributions_explain: (count) =>
+        `Вклад в ${m(count, 'материал', 'материала', 'материалов')}`,
+    contributor_description: (name) =>
+        `Страница с информацией о авторе "${name}" и его вкладе в проект.`,
+    editor: 'Редактор',
+    add_translation: 'Добавить перевод',
+    empty_nav: 'Пустая навигация',
+    flag_dev: 'Разработка',
+    flag_dev_description:
+        'Этот материал в разработке! Он может измениться в будущем и даже содержать ошибки!',
+    flag_advanced: 'Профиль',
+    flag_advanced_description:
+        'Этот материал предназначен для учеников с высоким уровнем понимания предмета. Информация здесь не предназначена для новичокв!',
+    flag_secondary: 'Дополнение',
+    flag_secondary_description:
+        'Это дополнительный материал для тех, кто хочет глубже погрузиться предмет и получить дополнительные знания и контекст.',
+    popover_dependencies: 'Зависимости',
+    popover_dependencies_description:
+        'Царского пути в эту тему нет! Вы сможете разобраться только если знаете следующие темы:',
+    to_index: 'К оглавлению',
+    about_book: 'Об учебнике',
+    close: 'Закрыть',
+    back: 'Назад',
+    goto: 'Перейти',
+    error: 'Ошибка!',
+    external_link: 'Внешняя ссылка',
+    external_link_warn: 'Вы собираетесь перейти на внешний ресурс!',
+    internal_link: 'Внутренняя ссылка',
+    internal_link_warn: 'Вы собираетесь перейти на внутреннюю страницу сайта!',
+    book: 'Книга',
+    group: 'Группа',
+    topic: 'Тема',
+    article: 'Статья',
+    summary: 'Конспект',
+    practice: 'Задачи',
+    element_id: 'ID элемента',
+    preview_missing_title: 'Элемент не найден!',
+    preview_missing_explain:
+        'Не удалось найти на этой странице элемент с указанным ID!<br>Возможно, ID элемента указан неправильно или элемент был изменен/удален.',
+    preview_missing_explain_mismatch: `Не удалось найти на этой странице элемент с указанным ID!<br>Версия страницы, на которую вела ссылка, отличается от текущей версии страницы!<br>Скорее всего, именно это и является причиной ошибки.`,
+    preview_hash_mismatch_title: 'Несовпадение версий страницы!',
+    preview_hash_mismatch_explain:
+        'Версия страницы, которую вы видите сейчас отличается от версии страницы, на которую вела исходная ссылка!<br>Содержимое может отличаться от того, что вы ожидали увидеть.',
+    current_page_hash: 'Текущий хеш',
+    expected_page_hash: 'Ожидаемый хеш',
+    empty_toc: 'Пустая таблица содержимого...',
+    no_contributors: 'Авторов нет...',
+    make_contribution: 'Внести свой вклад',
+    material_improvement: 'Улучшение материала',
+    how_to_improve: 'Как улучшить?',
+    edit_page: 'Редактировать страницу',
+    report_problem: 'Сообщить о проблеме',
+    references: 'Источники',
+    reference_source_featured: 'Избранный источник',
+    references_description:
+        'Список внешних источников, которые использовались при написании этого материала. Если рядом с названием стоит звездочка, то это избранный источник и с ним стоит ознакомиться, если вы хотите глубже погрузиться в материал.',
+    sponsors: 'Спонсоры',
+    sponsors_description:
+        'Список людей и организаций, которые поддерживают проект финансово. Благодаря им проект может существовать и развиваться. Если вы хотите помочь проекту, то тоже можете стать спонсором и попасть на эту страницу!',
+    become_sponsor: 'Стать спонсором',
+};
+
+export default russian;
+
+export function m(
+    number: number,
+    one: string,
+    two: string,
+    five: string,
+    includeNumber = true,
+) {
+    const text = [five, one, two, two, two, five][
+        number % 100 > 10 && number % 100 < 20 ? 0 : Math.min(number % 10, 5)
+    ];
+    return includeNumber ? `${number} ${text}` : text;
+}

package/module/bitran.ts

@@ -1,34 +1,66 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-
-import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
-import type { EruditBitranConfig } from '@erudit/globals/bitran';
-import { logger } from '@erudit/module/logger';
-
-export async function setupBitranConfig(_nuxt: Nuxt) {
-    let config: Partial<EruditBitranConfig>;
-
-    try {
-        const projectConfig = (await import(projectPath('bitran'))).default;
-        if (!projectConfig) throw new Error('Falsy Bitran config!');
-        config = projectConfig;
-    } catch (error) {
-        logger.warn(`Failed to load Bitran config!\n\n${error}`);
-    }
-
-    const templateFilename = '#erudit/client/bitran.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            ${config ? `import bitranConfig from '${projectPath('bitran')}';` : ''}
-            export default ${config ? 'bitranConfig' : 'undefined'};
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/client/bitran'] = eruditEndNuxtPath(
-        `.nuxt/${templateFilename}`,
-    );
-}
+import { globSync } from 'glob';
+import { addTemplate } from 'nuxt/kit';
+import type { Nuxt } from 'nuxt/schema';
+
+import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
+import { logger } from '@erudit/module/logger';
+
+export async function setupBitranTemplates(_nuxt: Nuxt) {
+    const serverConfigPath = projectPath('bitran.server');
+    const appConfigPath = projectPath('bitran.app');
+
+    const hasServerConfig = globSync(serverConfigPath + '.*').length > 0;
+    const hasAppConfig = globSync(appConfigPath + '.*').length > 0;
+    const hasIncompleteBitranConfig = hasServerConfig !== hasAppConfig;
+
+    if (hasIncompleteBitranConfig) {
+        logger.warn(
+            `Failed to load Bitran. Make sure you have "bitran.server" and "bitran.app" files in your project root!`,
+        );
+    }
+
+    const serverTemplateName = '#erudit/bitran/server.ts';
+    const appTemplateName = '#erudit/bitran/app.ts';
+
+    addTemplate({
+        filename: serverTemplateName,
+        write: true,
+        getContents: () => `
+            import type { ElementTranspilers } from '@bitran-js/transpiler';
+            import { eruditTranspilers } from '@erudit-js/bitran-elements/defaultServer';
+            ${hasServerConfig ? `import getProjectTranspilers from '${serverConfigPath}';` : ''}
+
+            export default async function() {
+                const projectTranspilers = ${hasServerConfig ? 'await getProjectTranspilers()' : '{}'};
+                return {
+                    ...eruditTranspilers,
+                    ...projectTranspilers,
+                } as ElementTranspilers;
+            }
+        `,
+    });
+
+    addTemplate({
+        filename: appTemplateName,
+        write: true,
+        getContents: () => `
+            import type { EruditBitranElements } from '@erudit-js/cog/schema';
+            import { eruditElements } from '@erudit-js/bitran-elements/defaultApp';
+            ${hasAppConfig ? `import getProjectElements from '${appConfigPath}';` : ''}
+
+            export default async function() {
+                const projectElements = ${hasAppConfig ? 'await getProjectElements()' : '{}'};
+                return {
+                    ...eruditElements,
+                    ...projectElements,
+                } as EruditBitranElements;
+            }
+        `,
+    });
+
+    const alias = (_nuxt.options.alias ||= {});
+    alias['#erudit/bitran/server'] = eruditEndNuxtPath(
+        `.nuxt/${serverTemplateName}`,
+    );
+    alias['#erudit/bitran/app'] = eruditEndNuxtPath(`.nuxt/${appTemplateName}`);
+}

package/module/config.ts

@@ -1,34 +1,35 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-import type { EruditConfig } from 'erudit-cog/schema';
-
-import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-
-export async function setupEruditConfig(_nuxt: Nuxt) {
-    let config: Partial<EruditConfig> = {};
-
-    try {
-        const projectConfig = (await import(projectPath('erudit'))).default;
-        if (!projectConfig) throw new Error('Falsy Erudit config!');
-        config = projectConfig;
-    } catch (error) {
-        logger.warn(`Failed to load Erudit config!\n\n${error}`);
-    }
-
-    const templateFilename = '#erudit/config.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            import type { EruditConfig } from 'erudit-cog/schema';
-            export default ${JSON.stringify(config, null, '    ')} as Partial<EruditConfig>;
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/config'] = eruditEndNuxtPath(`.nuxt/${templateFilename}`);
-
-    return config;
-}
+import { addTemplate } from 'nuxt/kit';
+import type { Nuxt } from 'nuxt/schema';
+import type { EruditConfig } from '@erudit-js/cog/schema';
+
+import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
+import { logger } from '@erudit/module/logger';
+
+export async function setupEruditConfig(_nuxt: Nuxt) {
+    let config: Partial<EruditConfig> = {};
+    const configPath = projectPath('erudit.config');
+
+    try {
+        const projectConfig = (await import(configPath)).default;
+        if (!projectConfig) throw new Error('Falsy Erudit config!');
+        config = projectConfig;
+    } catch (error) {
+        logger.warn(`Failed to load Erudit config!\n\n${error}`);
+    }
+
+    const templateFilename = '#erudit/config.ts';
+
+    addTemplate({
+        filename: templateFilename,
+        write: true,
+        getContents: () => `
+            import type { EruditConfig } from '@erudit-js/cog/schema';
+            export default ${JSON.stringify(config, null, '    ')} as Partial<EruditConfig>;
+        `,
+    });
+
+    const alias = (_nuxt.options.alias ||= {});
+    alias['#erudit/config'] = eruditEndNuxtPath(`.nuxt/${templateFilename}`);
+
+    return config;
+}

package/module/imports.ts

@@ -1,46 +1,74 @@
-import { addImports, addServerImports } from 'nuxt/kit';
-
-import { eruditPath } from '@erudit/globalPath';
-
-export function setupGlobalImports() {
-    addImports([
-        {
-            name: 'defineEruditConfig',
-            from: eruditPath('globals/erudit'),
-        },
-        {
-            name: 'defineContributor',
-            from: eruditPath('globals/contributor'),
-        },
-        {
-            name: 'defineBitranConfig',
-            from: eruditPath('globals/bitran'),
-        },
-        // Content
-        ...(() => {
-            const imports = [
-                'defineBook',
-                'defineGroup',
-                'defineTopic',
-                'defineContentReferences',
-            ];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`globals/content`),
-            }));
-        })(),
-        // Helper Asset Path Functions
-        ...(() => {
-            const imports = [
-                'eruditAsset',
-                'contributorAsset',
-                'contentAsset',
-                'publicAsset',
-            ];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`shared/asset`),
-            }));
-        })(),
-    ]);
-}
+import { addImports, addServerImports } from 'nuxt/kit';
+
+import { eruditPath } from '@erudit/globalPath';
+
+export function setupGlobalImports() {
+    addImports([
+        {
+            name: 'defineEruditConfig',
+            from: eruditPath('globals/erudit'),
+        },
+        {
+            name: 'defineContributor',
+            from: eruditPath('globals/contributor'),
+        },
+        {
+            name: 'defineCameo',
+            from: eruditPath('globals/cameo'),
+        },
+        {
+            name: 'defineTier1Sponsor',
+            from: eruditPath('globals/sponsor'),
+        },
+        {
+            name: 'defineTier2Sponsor',
+            from: eruditPath('globals/sponsor'),
+        },
+        // Bitran
+        ...(() => {
+            const imports = ['defineAppBitran'];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/bitran`),
+            }));
+        })(),
+        // Content
+        ...(() => {
+            const imports = [
+                'defineBook',
+                'defineGroup',
+                'defineTopic',
+                'defineContentReferences',
+                'defineContentSource',
+            ];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/content`),
+            }));
+        })(),
+        // Problems Generation
+        {
+            name: 'defineProblemGenerator',
+            from: '@erudit-js/bitran-elements/problem/generator',
+        },
+        // Helper Asset Path Functions
+        ...(() => {
+            const imports = ['eruditAsset', 'contentAsset', 'publicAsset'];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`shared/asset`),
+            }));
+        })(),
+    ]);
+
+    addServerImports([
+        // Bitran
+        ...(() => {
+            const imports = ['defineServerBitran'];
+            return imports.map((name) => ({
+                name,
+                from: eruditPath(`globals/bitran`),
+            }));
+        })(),
+    ]);
+}

package/module/index.ts

@@ -1,47 +1,47 @@
-import { defineNuxtModule, updateTemplates } from 'nuxt/kit';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { setupRestartWatcher } from '@erudit/module/restart';
-import { setupEruditConfig } from '@erudit/module/config';
-import { logger } from '@erudit/module/logger';
-import { setupGlobalImports } from '@erudit/module/imports';
-import { setupBitranConfig } from './bitran';
-import { setupGlobalPaths } from './paths';
-
-export default defineNuxtModule({
-    meta: { name: 'Erudit', configKey: 'erudit' },
-    async setup(_options, _nuxt) {
-        if (_nuxt.options.dev) setupRestartWatcher(_nuxt);
-
-        setupGlobalImports();
-        registerGlobals();
-
-        const eruditConfig = await setupEruditConfig(_nuxt);
-        await setupBitranConfig(_nuxt);
-        setupGlobalPaths(_nuxt);
-
-        if (eruditConfig.site?.baseUrl) {
-            const newBaseUrl = eruditConfig.site.baseUrl;
-            _nuxt.options.app.baseURL = newBaseUrl;
-            _nuxt.options.nitro.runtimeConfig!.app!.baseURL = newBaseUrl;
-            await updateTemplates();
-        }
-
-        {
-            // Handle sub dependencies
-            const subDeps = eruditConfig.subDeps || [];
-
-            const transpile = (_nuxt.options.build.transpile ||= []);
-            const optimizeDeps = _nuxt.options.vite.optimizeDeps || {};
-            const optimizeDepsInclude = (optimizeDeps.include ||= []);
-
-            transpile.push(...subDeps);
-            optimizeDepsInclude.push(...subDeps);
-        }
-
-        // TODO: Watch for contributors folder and create/update template with their IDs
-        // TODO: Create such helpers for other features!
-
-        logger.success('Erudit module setup complete!');
-    },
-});
+import { defineNuxtModule, updateTemplates } from 'nuxt/kit';
+
+import { registerGlobals } from '@erudit/globals/register';
+import { setupRestartWatcher } from '@erudit/module/restart';
+import { setupEruditConfig } from '@erudit/module/config';
+import { logger } from '@erudit/module/logger';
+import { setupGlobalImports } from '@erudit/module/imports';
+import { setupBitranTemplates } from './bitran';
+import { setupGlobalPaths } from './paths';
+
+export default defineNuxtModule({
+    meta: { name: 'Erudit', configKey: 'erudit' },
+    async setup(_options, _nuxt) {
+        if (_nuxt.options.dev) setupRestartWatcher(_nuxt);
+
+        setupGlobalImports();
+        registerGlobals();
+
+        const eruditConfig = await setupEruditConfig(_nuxt);
+        await setupBitranTemplates(_nuxt);
+        setupGlobalPaths(_nuxt);
+
+        if (eruditConfig.site?.baseUrl) {
+            const newBaseUrl = eruditConfig.site.baseUrl;
+            _nuxt.options.app.baseURL = newBaseUrl;
+            _nuxt.options.nitro.runtimeConfig!.app!.baseURL = newBaseUrl;
+            await updateTemplates();
+        }
+
+        {
+            const transpile = (_nuxt.options.build.transpile ||= []);
+            const optimizeDeps = _nuxt.options.vite.optimizeDeps || {};
+            const optimizeDepsInclude = (optimizeDeps.include ||= []);
+
+            const deps = eruditConfig.dependencies || {};
+            for (const [dep, options] of Object.entries(deps)) {
+                if (options?.transpile) transpile.push(dep);
+                if (options?.optimize) optimizeDepsInclude.push(dep);
+            }
+        }
+
+        // TODO: Watch for contributors folder and create/update template with their IDs
+        // TODO: Create such helpers for other features!
+
+        logger.success('Erudit module setup complete!');
+    },
+});

package/module/logger.ts

@@ -1,10 +1,10 @@
-import { createConsola } from 'consola';
-import { brandColorTitle } from 'erudit-cog/utils/brand';
-
-const tag = brandColorTitle + ' Module';
-
-export const logger = createConsola({
-    defaults: {
-        tag,
-    },
-});
+import { createConsola } from 'consola';
+import { brandColorTitle } from '@erudit-js/cog/utils/brandNode';
+
+const tag = brandColorTitle + ' Module';
+
+export const logger = createConsola({
+    defaults: {
+        tag,
+    },
+});