├── .editorconfig ├── .gitattributes ├── .github ├── funding.yml ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: sindresorhus 2 | open_collective: sindresorhus 3 | tidelift: npm/normalize-newline 4 | custom: https://sindresorhus.com/donate 5 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 14 14 | - 12 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: actions/setup-node@v1 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Normalize the newline characters in a string to `\n`. 3 | 4 | @example 5 | ``` 6 | import normalizeNewline from 'normalize-newline'; 7 | 8 | normalizeNewline('foo\r\nbar\nbaz'); 9 | //=> 'foo\nbar\nbaz' 10 | 11 | normalizeNewline(Buffer.from('foo\r\nbar\nbaz')).toString(); 12 | //=> 'foo\nbar\nbaz' 13 | ``` 14 | */ 15 | export default function normalizeNewline(input: string): string; 16 | export default function normalizeNewline(input: Buffer): Buffer; 17 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import replaceBuffer from 'replace-buffer'; 2 | 3 | const CRLF = '\r\n'; 4 | 5 | export default function normalizeNewline(input) { 6 | if (typeof input !== 'string' && !Buffer.isBuffer(input)) { 7 | throw new TypeError(`Expected a \`string\` or a \`Buffer\`, got \`${typeof input}\``); 8 | } 9 | 10 | return Buffer.isBuffer(input) ? replaceBuffer(input, CRLF, '\n') : input.replace(new RegExp(CRLF, 'g'), '\n'); 11 | } 12 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import normalizeNewline from './index.js'; 3 | 4 | expectType(normalizeNewline('foo\r\nbar\nbaz')); 5 | expectType(normalizeNewline(Buffer.from('foo\r\nbar\nbaz'))); 6 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "normalize-newline", 3 | "version": "4.1.0", 4 | "description": "Normalize the newline characters in a string to `\\n`", 5 | "license": "MIT", 6 | "repository": "sindresorhus/normalize-newline", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": ">=12" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "newline", 27 | "linebreak", 28 | "line", 29 | "lf", 30 | "crlf", 31 | "eol", 32 | "linefeed", 33 | "character", 34 | "char", 35 | "normalize", 36 | "convert", 37 | "replace" 38 | ], 39 | "dependencies": { 40 | "replace-buffer": "^1.2.1" 41 | }, 42 | "devDependencies": { 43 | "ava": "^3.15.0", 44 | "tsd": "^0.14.0", 45 | "xo": "^0.40.0" 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # normalize-newline 2 | 3 | > Normalize the [newline](https://en.wikipedia.org/wiki/Newline) characters in a string to `\n` 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install normalize-newline 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import normalizeNewline from 'normalize-newline'; 15 | 16 | normalizeNewline('foo\r\nbar\nbaz'); 17 | //=> 'foo\nbar\nbaz' 18 | 19 | normalizeNewline(Buffer.from('foo\r\nbar\nbaz')).toString(); 20 | //=> 'foo\nbar\nbaz' 21 | ``` 22 | 23 | ## API 24 | 25 | ### normalizeNewline(input) 26 | 27 | #### input 28 | 29 | Type: `string | Buffer` 30 | 31 | Input to normalize. 32 | 33 | ## Related 34 | 35 | - [normalize-newline-cli](https://github.com/sindresorhus/normalize-newline-cli) - CLI for this module 36 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import normalizeNewline from './index.js'; 3 | 4 | test('main', t => { 5 | t.is(normalizeNewline('foo\r\nbar\r\nbaz\n'), 'foo\nbar\nbaz\n'); 6 | t.is(normalizeNewline('foo\nbar\nbaz\r\n'), 'foo\nbar\nbaz\n'); 7 | t.is(normalizeNewline('foo\nbar\n'), 'foo\nbar\n'); 8 | t.is(normalizeNewline(Buffer.from('foo\r\nbar\r\nbaz\n')).toString(), 'foo\nbar\nbaz\n'); 9 | t.is(normalizeNewline(Buffer.from('foo\nbar\nbaz\r\n')).toString(), 'foo\nbar\nbaz\n'); 10 | t.is(normalizeNewline(Buffer.from('foo\nbar\n')).toString(), 'foo\nbar\n'); 11 | 12 | t.throws(() => { 13 | normalizeNewline(1); 14 | }, { 15 | message: 'Expected a `string` or a `Buffer`, got `number`' 16 | }); 17 | }); 18 | --------------------------------------------------------------------------------