├── .editorconfig ├── .gitattributes ├── .github ├── 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/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@v2 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 | export interface Options { 2 | /** 3 | Preserve the line separator at the end of every line, except the last line, which will never contain one. 4 | 5 | @default false 6 | */ 7 | readonly preserveNewlines?: boolean; 8 | } 9 | 10 | /** 11 | Split lines into an array of lines. 12 | 13 | @param string - String to split. 14 | 15 | @example 16 | ``` 17 | import splitLines from 'split-lines'; 18 | 19 | splitLines('foo\r\nbar\r\nbaz\nrainbow'); 20 | //=> ['foo', 'bar', 'baz', 'rainbow'] 21 | 22 | splitLines('foo\r\nbar\r\nbaz\nrainbow', {preserveNewlines: true}); 23 | //=> ['foo\r\n', 'bar\r\n', 'baz\n', 'rainbow'] 24 | ``` 25 | */ 26 | export default function splitLines(string: string, options?: Options): string[]; 27 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | export default function splitLines(string, options = {}) { 2 | const {preserveNewlines = false} = options; 3 | 4 | if (typeof string !== 'string') { 5 | throw new TypeError(`Expected input to be of type \`string\`, got \`${typeof string}\``); 6 | } 7 | 8 | if (!preserveNewlines) { 9 | return string.split(/\r?\n/); 10 | } 11 | 12 | const parts = string.split(/(\r?\n)/); 13 | const lines = []; 14 | 15 | for (let index = 0; index < parts.length; index += 2) { 16 | lines.push(parts[index] + (parts[index + 1] || '')); 17 | } 18 | 19 | return lines; 20 | } 21 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import splitLines from './index.js'; 3 | 4 | expectType(splitLines('foo\r\nbar\r\nbaz\nrainbow')); 5 | expectType(splitLines('foo\r\nbar\r\nbaz\nrainbow', {})); 6 | expectType(splitLines('foo\r\nbar\r\nbaz\nrainbow', {preserveNewlines: true})); 7 | -------------------------------------------------------------------------------- /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": "split-lines", 3 | "version": "3.0.0", 4 | "description": "Split lines into an array of lines", 5 | "license": "MIT", 6 | "repository": "sindresorhus/split-lines", 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 | "split", 27 | "lines", 28 | "line", 29 | "string", 30 | "str", 31 | "newline", 32 | "newlines", 33 | "linebreak", 34 | "line-break", 35 | "lf", 36 | "crlf", 37 | "eol", 38 | "linefeed" 39 | ], 40 | "devDependencies": { 41 | "ava": "^3.15.0", 42 | "tsd": "^0.14.0", 43 | "xo": "^0.38.2" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # split-lines 2 | 3 | > Split lines into an array of lines 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install split-lines 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import splitLines from 'split-lines'; 15 | 16 | splitLines('foo\r\nbar\r\nbaz\nrainbow'); 17 | //=> ['foo', 'bar', 'baz', 'rainbow'] 18 | 19 | splitLines('foo\r\nbar\r\nbaz\nrainbow', {preserveNewlines: true}); 20 | //=> ['foo\r\n', 'bar\r\n', 'baz\n', 'rainbow'] 21 | ``` 22 | 23 | ## API 24 | 25 | ### splitLines(string, options?) 26 | 27 | #### string 28 | 29 | Type: `string` 30 | 31 | String to split. 32 | 33 | #### options 34 | 35 | Type: `object` 36 | 37 | ##### preserveNewlines 38 | 39 | Type: `boolean`\ 40 | Default: `false` 41 | 42 | Preserve the line separator at the end of every line, except the last line, which will never contain one. 43 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import splitLines from './index.js'; 3 | 4 | test('split lines', t => { 5 | t.deepEqual(splitLines('foo\r\nbar\r\nbaz\nrainbow'), ['foo', 'bar', 'baz', 'rainbow']); 6 | }); 7 | 8 | test('preserveNewlines option', t => { 9 | t.deepEqual( 10 | splitLines('foo\r\nbar\r\nbaz\nrainbow', {preserveNewlines: true}), 11 | ['foo\r\n', 'bar\r\n', 'baz\n', 'rainbow'] 12 | ); 13 | 14 | t.deepEqual( 15 | splitLines('\nfoo\r\nbar\r\nbaz\nrainbow', {preserveNewlines: true}), 16 | ['\n', 'foo\r\n', 'bar\r\n', 'baz\n', 'rainbow'] 17 | ); 18 | 19 | t.deepEqual( 20 | splitLines('\nfoo\r\nbar\r\nbaz\nrainbow\n', {preserveNewlines: true}), 21 | ['\n', 'foo\r\n', 'bar\r\n', 'baz\n', 'rainbow\n', ''] 22 | ); 23 | }); 24 | --------------------------------------------------------------------------------