myst-cli/dist/build/utils/defaultNames.js

Command line tools for MyST

import path from 'node:path';
import { ExportFormats } from 'myst-frontmatter';
import { selectPageSlug } from '../../store/selectors.js';
import { createSlug } from '../../utils/fileInfo.js';
import { parseFilePath } from '../../utils/resolveExtension.js';
/**
 * Get default filename for saving export.
 *
 * This uses the project slug if available, or creates a new slug from the filename otherwise.
 */
export function getDefaultExportFilename(session, file, projectPath) {
    const { name } = parseFilePath(file);
    const slugFromProject = projectPath
        ? selectPageSlug(session.store.getState(), projectPath, file)
        : undefined;
    const slug = slugFromProject || createSlug(name);
    return slug;
}
/**
 * Get default folder for saving export. Folder will be created on export.
 *
 * The default folder is:
 * <root>/_build/exports/
 *
 * If the file is part of a project, the root is the project folder;
 * if not, the root is the file folder.
 */
export function getDefaultExportFolder(session, file, format, projectPath) {
    const subpaths = [projectPath || path.parse(file).dir, '_build', 'exports'];
    // Extra folder for tex/typst export content
    if (format === ExportFormats.tex) {
        subpaths.push(`${getDefaultExportFilename(session, file, projectPath)}_tex`);
    }
    if (format === ExportFormats.typst) {
        subpaths.push(`${getDefaultExportFilename(session, file, projectPath)}_typst`);
    }
    return path.join(...subpaths);
}