config.mjs

/**
 * English: Shared docs-gen paths, field contracts, extension filters, and preset definitions.
 *
 * Русский: Общие пути docs-gen, контракт полей, фильтры расширений и определения пресетов.
 */
import {dirname, join, resolve} from 'node:path';
import {fileURLToPath} from 'node:url';

export const REPO_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '../../..');
export const DOCS_GEN_DIR = join(REPO_ROOT, 'tmp/docs-gen');
export const EDITOR_PKG_DIR = join(REPO_ROOT, 'packages/editor');
export const PAGE_CONSTRUCTOR_EXTENSION_PKG_DIR = join(
    REPO_ROOT,
    'packages/page-constructor-extension',
);

export const EXTENSION_CATEGORIES = ['base', 'behavior', 'markdown', 'yfm', 'additional'];

export const EXTENSION_ENTRY_POINTS = [
    {
        id: 'editor',
        packageName: '@gravity-ui/markdown-editor',
        packageDir: EDITOR_PKG_DIR,
        kind: 'category-dirs',
        extensionsDir: 'src/extensions',
        categories: EXTENSION_CATEGORIES,
        presetsDir: 'src/presets',
    },
    {
        id: 'page-constructor-extension',
        packageName: '@gravity-ui/markdown-editor-page-constructor-extension',
        packageDir: PAGE_CONSTRUCTOR_EXTENSION_PKG_DIR,
        kind: 'single-extension',
        extensionName: 'YfmPageConstructorExtension',
        extensionDir: 'src/extension',
        category: 'external',
    },
];

export const INTERNAL_EXTENSION_BLACKLIST = [
    'BaseInputRules',
    'BaseKeymap',
    'BaseStyles',
    'ReactRenderer',
    'SharedState',
];

export const EXTENSION_BLACKLIST = [
    // Example blacklist entry for generated extension docs.
    'YfmCut',
];

export const EXTENSION_DOC_FIELD_CONFIG = {
    name: {from: 'extension directory name'},
    packageName: {from: 'configured extension entry point package name'},
    entryPoint: {from: 'configured extension entry point id'},
    sourcePath: {from: 'extension directory path relative to repository root'},
    category: {from: 'configured extension category directory'},
    nodes: {from: 'extension spec files: addNode and addNodeSpec calls'},
    marks: {from: 'extension spec files: addMark and addMarkSpec calls'},
    actions: {from: 'extension source files: addAction calls'},
    keymaps: {from: 'extension source files: addKeymap callback return values'},
    inputRules: {from: 'extension source files: input-rule factory calls'},
    plugins: {from: 'extension source files: addPlugin calls'},
    mdPlugins: {from: 'extension source files: markdown-it md.use calls'},
    serializerHints: {from: 'serializer source files: state.write and state.text calls'},
    options: {from: 'extension source files: local *Options TypeScript declarations'},
    markupExamples: {from: 'extension test files: same(...) serializer examples'},
    presets: {from: 'editor preset files: preset builder use(...) calls'},
};

export const PRESET_DEFS = [
    {name: 'ZeroPreset', file: 'zero.ts', parent: null},
    {name: 'CommonMarkPreset', file: 'commonmark.ts', parent: 'ZeroPreset'},
    {name: 'DefaultPreset', file: 'default.ts', parent: 'CommonMarkPreset'},
    {name: 'YfmPreset', file: 'yfm.ts', parent: 'DefaultPreset'},
    {name: 'FullPreset', file: 'full.ts', parent: 'YfmPreset'},
];

/**
 * Checks whether an extension should be skipped by the raw data extractor.
 */
export function isBlacklistedExtension(name) {
    return [...INTERNAL_EXTENSION_BLACKLIST, ...EXTENSION_BLACKLIST].includes(name);
}

/**
 * Creates extension entry points with optional CLI path overrides.
 */
export function createExtensionEntryPoints({editorPkg = EDITOR_PKG_DIR} = {}) {
    return EXTENSION_ENTRY_POINTS.map((entryPoint) => {
        if (entryPoint.id !== 'editor') return entryPoint;

        return {
            ...entryPoint,
            packageDir: editorPkg,
        };
    });
}