Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

std/fs/eol.ts

The Deno Standard Library
Go to Latest
File
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
/** End-of-line character for POSIX platforms such as macOS and Linux. */export const LF = "\n" as const;
/** End-of-line character for Windows platforms. */export const CRLF = "\r\n" as const;
/** * End-of-line character evaluated for the current platform. * * @example * ```ts * import { EOL } from "https://deno.land/std@$STD_VERSION/fs/eol.ts"; * * EOL; // "\n" on POSIX platforms and "\r\n" on Windows * ``` */export const EOL: "\n" | "\r\n" = Deno?.build.os === "windows" ? CRLF : LF;
const regDetect = /(?:\r?\n)/g;
/** * Returns the detected EOL character(s) detected in the input string. If no EOL * character is detected, `null` is returned. * * @param content The input string to detect EOL characters. * @returns The detected EOL character(s) or `null` if no EOL character is detected. * * @example * ```ts * import { detect } from "https://deno.land/std@$STD_VERSION/fs/eol.ts"; * * detect("deno\r\nis not\r\nnode"); // "\r\n" * detect("deno\nis not\r\nnode"); // "\r\n" * detect("deno\nis not\nnode"); // "\n" * detect("deno is not node"); // null * ``` */export function detect(content: string): typeof EOL | null { const d = content.match(regDetect); if (!d || d.length === 0) { return null; } const hasCRLF = d.some((x: string): boolean => x === CRLF);
return hasCRLF ? CRLF : LF;}
/** * Normalize the input string to the targeted EOL. * * @param content The input string to normalize. * @param eol The EOL character(s) to normalize the input string to. * @returns The input string normalized to the targeted EOL. * * @example * ```ts * import { LF, format } from "https://deno.land/std@$STD_VERSION/fs/eol.ts"; * * const CRLFinput = "deno\r\nis not\r\nnode"; * * format(CRLFinput, LF); // "deno\nis not\nnode" * ``` */export function format(content: string, eol: typeof EOL): string { return content.replace(regDetect, eol);}