eslint-doc-generator/dist/lib/string.js

Automatic documentation generator for ESLint plugins and rules.

import { EOL } from 'node:os';
import editorconfig from 'editorconfig';
const endOfLine = getEndOfLine();
export function toSentenceCase(str) {
    return str.replace(/^\w/u, function (txt) {
        return txt.charAt(0).toUpperCase() + txt.slice(1).toLowerCase();
    });
}
export function removeTrailingPeriod(str) {
    return str.replace(/\.$/u, '');
}
export function addTrailingPeriod(str) {
    return str.replace(/\.?$/u, '.');
}
/**
 * Example: FOO => Foo, foo => Foo
 */
export function capitalizeOnlyFirstLetter(str) {
    return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
}
function sanitizeMarkdownTableCell(text) {
    return text
        .replaceAll('|', String.raw `\|`)
        .replaceAll(new RegExp(endOfLine, 'gu'), '<br/>');
}
export function sanitizeMarkdownTable(text) {
    return text.map((row) => row.map((col) => sanitizeMarkdownTableCell(col)));
}
// Gets the end of line string while respecting the
// `.editorconfig` and falling back to `EOL` from `node:os`.
export function getEndOfLine() {
    // The passed `markdown.md` argument is used as an example
    // of a markdown file in the plugin root folder in order to
    // check for any specific markdown configurations.
    const config = editorconfig.parseSync('markdown.md');
    let endOfLine = EOL;
    if (config.end_of_line === 'lf') {
        endOfLine = '\n';
    }
    else if (config.end_of_line === 'crlf') {
        endOfLine = '\r\n';
    }
    return endOfLine;
}