Skip to content

aashutoshrathi/word-wrap

 
 

Repository files navigation

Note

If you came here looking for what this package is, as it showed up on top of your node_modules. This is probably a dependency of Optionator in your project.

Why this fork?

word-wrap had a high rank vulnerability (CVE-2023-26115) which is now fixed in this PR and now the main package can be used too. It was taking time to merge that PR so, some projects shifted to this fork of the project.

word-wrap NPM version NPM monthly downloads NPM total downloads GitHub Workflow Status (with event)

Wrap words to a specified length.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save @aashutoshrathi/word-wrap

Deep Dependencies Workaround

If you are running yarn audit or npm audit and you get failures like "word-wrap vulnerable to Regular Expression Denial of Service" here is a work around if one of your dependencies is still using an old version of the original library.

YARN

"resolutions": {
  "word-wrap": "@aashutoshrathi/word-wrap"
}

NPM (8 or higher)

"overrides": {
  "word-wrap" : "@aashutoshrathi/word-wrap"
}

Usage

var wrap = require('@aashutoshrathi/word-wrap');

wrap('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.');

Results in:

  Lorem ipsum dolor sit amet, consectetur adipiscing
  elit, sed do eiusmod tempor incididunt ut labore
  et dolore magna aliqua. Ut enim ad minim veniam,
  quis nostrud exercitation ullamco laboris nisi ut
  aliquip ex ea commodo consequat.

Options

image

options.width

Type: Number

Default: 50

The width of the text before wrapping to a new line.

Example:

wrap(str, {width: 60});

options.indent

Type: String

Default: `` (two spaces)

The string to use at the beginning of each line.

Example:

wrap(str, {indent: '      '});

options.newline

Type: String

Default: \n

The string to use at the end of each line.

Example:

wrap(str, {newline: '\n\n'});

options.escape

Type: function

Default: function(str){return str;}

An escape function to run on each line after splitting them.

Example:

var xmlescape = require('xml-escape');
wrap(str, {
  escape: function(string){
    return xmlescape(string);
  }
});

options.trim

Type: Boolean

Default: false

Trim trailing whitespace from the returned string. This option is included since .trim() would also strip the leading indentation from the first line.

Example:

wrap(str, {trim: true});

options.cut

Type: Boolean

Default: false

Break a word between any two letters when the word is longer than the specified width.

Example:

wrap(str, {cut: true});

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

Contributors

Commits Contributor
47 jonschlinkert
7 OlafConijn
3 doowb
2 aashutoshrathi
2 lordvlad
2 hildjj
1 danilosampaio
1 2fd
1 leonard-thieu
1 mohd-akram
1 toddself
1 wolfgang42
1 zachhale

Author

Jon Schlinkert

License

Copyright © 2023, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.8.0, on July 22, 2023.

About

Wrap words to a specified length.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages

  • JavaScript 100.0%