End Of Line (EOL) (ES)

⚖️ MIT

An ES (JavaScript & TypeScript) CLI and module to handle end of line (EOL).

🔰 Begin

🎯 Targets

| | Remote | JSR | NPM | |:--|:--|:--|:--| | Bun >= v1.1.0 | ❌ | ❓ | ✔️ | | Cloudflare Workers | ❌ | ❓ | ✔️ | | Deno >= v1.42.0 | ✔️ | ✔️ | ✔️ | | NodeJS >= v16.13.0 | ❌ | ❓ | ✔️ |

[!NOTE]

• It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.

#️⃣ Resources Identifier

• Remote - GitHub Raw:

  https://raw.githubusercontent.com/hugoalh/eol-es/{Tag}/mod.ts

• JSR:

  [jsr:]@hugoalh/eol[@{Tag}]

• NPM:

  [npm:]@hugoalh/eol[@{Tag}]

[!NOTE]

• For usage of remote resources, it is recommended to import the entire module with the main path mod.ts, however it is also able to import part of the module with sub path if available, but do not import if:

  • it's path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
  • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
  • it's symbol has an underscore prefix (e.g.: _bar, _foo).

  These elements are not considered part of the public API, thus no stability is guaranteed for them.

• For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the file jsr.jsonc property exports for available sub entrypoints.

• It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

• File System - Read [Deno: read; NodeJS (>= v20.9.0) 🧪: fs-read]
  • Resources (Optional)
• File System - Write [Deno: write; NodeJS (>= v20.9.0) 🧪: fs-write]
  • Resources (Optional)

🧩 APIs

• const eolCRLF = "\r\n";

• const eolLF = "\n";

• const eol: typeof eolCRLF | typeof eolLF;

• function detectEOL(content: string): typeof eol | null;

• function detectFileEOL(filePath: string | URL): Promise<typeof eol | null>;

• function detectFileEOLSync(filePath: string | URL): typeof eol | null;

• function normalizeEOL(eolChar: typeof eol, content: string): string;

• function normalizeFileEOL(eolChar: typeof eol, ...filesPath: (string | URL)[]): Promise<void>;

• function normalizeFileEOLSync(eolChar: typeof eol, ...filesPath: (string | URL)[]): void;

[!NOTE]

• For the full or prettier documentation, can visit via:
  • Deno CLI deno doc
  • JSR

🧩 CLIs

Entrypoint: cli.js/cli.ts

• Detect from argument

  eol detect {Data}
  #=> crlf || lf || null

• Detect from file

  eol detect --file {FilePath}
  #=> crlf || lf || null

• Detect from stdin

  eol detect --stdin
  #=> crlf || lf || null

• Normalize files with EOL character evaluated for the current platform

  eol normalize [--file] ...{FilePath}

✍️ Examples

• detectEOL("Deno\r\nis not\r\nNode");
  //=> "\r\n"

• detectEOL("Deno\nis not\r\nNode");
  //=> "\r\n"

• detectEOL("Deno\nis not\nNode");
  //=> "\n"

• detectEOL("Deno is not Node");
  //=> null

• normalizeEOL(eol, "Deno\r\nis not\r\nNode");
  //=> "Deno\nis not\nNode" (POSIX/UNIX Platforms)
  //=> "Deno\r\nis not\r\nNode" (Windows Platforms)

• normalizeEOL(eolLF, "Deno\r\nis not\r\nNode");
  //=> "Deno\nis not\nNode" (POSIX/UNIX Platforms)
  //=> "Deno\nis not\nNode" (Windows Platforms)