myst-cli/dist/utils/fileInfo.js

Command line tools for MyST

import path from 'node:path';
import { parseFilePath } from './resolveExtension.js';
function input2name(input, allowed, join) {
    let name = `¶${input}`
        .toLowerCase()
        .split('')
        .map((char) => (allowed.test(char) ? char : '¶'))
        .join('')
        .split('')
        .reduce((p, n) => (p.charAt(p.length - 1) === '¶' && n === '¶' ? p : p + n))
        .slice(1)
        .replace(/¶/g, join);
    if (join) {
        name = name.replace(new RegExp(`${join}+`, 'g'), join);
    }
    if (name.charAt(0) === join)
        name = name.slice(1);
    if (name.charAt(name.length - 1) === join)
        name = name.slice(0, name.length - 1);
    return name;
}
const title2name = (title) => input2name(title.replace(/&/g, '¶and¶'), /^[a-z0-9-]/, '-').slice(0, 50);
function removeLeadingEnumeration(s) {
    if (s.match(/^([12][0-9]{3})([^0-9])?/)) {
        // Starts with what looks like a year
        return s;
    }
    if (s.match(/^([0-9]{5})/)) {
        // More than five numbers
        return s;
    }
    const removed = s.replace(/^([0-9_.-]+)/, '');
    if (!removed)
        return s; // Never return an empty slug!
    return removed;
}
export function createSlug(s) {
    return title2name(removeLeadingEnumeration(s));
}
export function createTitle(s) {
    return (removeLeadingEnumeration(s)
        // https://stackoverflow.com/questions/18379254/regex-to-split-camel-case
        .split(/([A-Z][a-z0-9]+)|_|-/)
        .filter((e) => e)
        .join(' ')
        .trim()
        // Now make it into title case (simple, but good enough)
        .replace(/\w\S*/g, (w) => w.replace(/^\w/, (c) => c.toUpperCase())));
}
export function fileTitle(file) {
    const { name } = parseFilePath(file);
    return createTitle(name);
}
/**
 * Create a unique slug for a file
 *
 * If opts.urlFolders is true and opts.projectPath is provided, slug will include folders
 */
export function fileInfo(file, pageSlugs, opts) {
    var _a;
    const { name, dir } = parseFilePath(file);
    let slug = createSlug(name);
    if ((opts === null || opts === void 0 ? void 0 : opts.urlFolders) && (opts === null || opts === void 0 ? void 0 : opts.projectPath)) {
        const slugFolders = path
            .relative(opts.projectPath, dir)
            .split(path.sep)
            .filter((folder) => folder !== '');
        if (slugFolders.includes('..')) {
            (_a = opts.session) === null || _a === void 0 ? void 0 : _a.log.warn(`URL path will not match folder structure for file outside project: ${file}`);
        }
        else {
            slug = [...slugFolders.map((folder) => createSlug(folder)), slug].join('.');
        }
    }
    const folderIndexSlug = slug.endsWith('.index');
    const slugKey = folderIndexSlug ? slug.slice(0, -6) : slug;
    if (pageSlugs[slugKey]) {
        pageSlugs[slugKey] += 1;
        slug = `${slugKey}-${pageSlugs[slugKey] - 1}${folderIndexSlug ? '.index' : ''}`;
    }
    else {
        pageSlugs[slugKey] = 1;
    }
    const title = fileTitle(file);
    return { slug, title };
}