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

Automatic documentation generator for ESLint plugins and rules.

import { EOL } from 'node:os';
import editorconfig from 'editorconfig';
export async function getEndOfLine() {
    return ((await getEndOfLineFromEditorConfig()) ??
        (await getEndOfLineFromPrettierConfig()) ??
        getNodeEOL());
}
async function getEndOfLineFromEditorConfig() {
    // 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 editorConfigProps = await editorconfig.parse('markdown.md');
    if (editorConfigProps.end_of_line === 'lf') {
        return '\n';
    }
    if (editorConfigProps.end_of_line === 'crlf') {
        return '\r\n';
    }
    return undefined;
}
async function getEndOfLineFromPrettierConfig() {
    // eslint-disable-next-line @typescript-eslint/consistent-type-imports -- prettier is an optional peer dependency, must be dynamically imported
    let prettier;
    try {
        prettier = await import('prettier');
    }
    catch {
        /* istanbul ignore next */
        return undefined;
    }
    // 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 prettierOptions = await prettier.resolveConfig('markdown.md');
    if (prettierOptions === null) {
        return undefined;
    }
    if (prettierOptions.endOfLine === 'lf') {
        return '\n';
    }
    if (prettierOptions.endOfLine === 'crlf') {
        return '\r\n';
    }
    // Prettier defaults to "lf" if it is not explicitly specified in the config file:
    // https://prettier.io/docs/options#end-of-line
    return '\n';
}
/* istanbul ignore next */
/** `EOL` is typed as `string`, so we perform run-time validation to be safe. */
function getNodeEOL() {
    if (EOL === '\n' || EOL === '\r\n') {
        return EOL;
    }
    throw new Error(`Failed to detect the end-of-line constant from the JavaScript runtime: ${EOL}`);
}