Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/justified
Wrap, align and justify the words in a string.
https://github.com/jonschlinkert/justified
align console javascript justified justify node nodejs pad padding prompt repeat string terminal text
Last synced: about 5 hours ago
JSON representation
Wrap, align and justify the words in a string.
- Host: GitHub
- URL: https://github.com/jonschlinkert/justified
- Owner: jonschlinkert
- License: mit
- Created: 2014-05-21T14:54:52.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-12T13:59:46.000Z (over 6 years ago)
- Last Synced: 2024-09-09T14:30:34.299Z (24 days ago)
- Topics: align, console, javascript, justified, justify, node, nodejs, pad, padding, prompt, repeat, string, terminal, text
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 29.3 KB
- Stars: 29
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# justified [](https://www.npmjs.com/package/justified) [](https://npmjs.org/package/justified) [](https://npmjs.org/package/justified) [](https://travis-ci.org/jonschlinkert/justified)
> Wraps words to a specified length and justifies the text in each line.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save justified
```
## Usage
```js
var justify = require('justified');
justify('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. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.');
```
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. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat
cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.
```
## Options
See [word-wrap](https://github.com/jonschlinkert/word-wrap) for additional options beyond the following.
### options.width
**Type**: `number`
**Default**: `55`
Set the maximum width for the justified text.
### options.indent
**Type**: `number`
**Default**: `0`
Add the specified number of spaces (left padding) before each line in the given string.
### options.random
**Type**: `function`
**Default**: a pseudo-random function is used to provide the appearance of randomization. The purpose of this is to ensure that whitespace doesn't appear to be somewhat "aligned" in columns on the left or right side of the text (which is distracting to readers), whilst also making the result technically predictable so that you're not getting a different result every time you call the "justified" function.
### options.justifyLastLine
**Type**: `boolean|function`
**Default**: `false`
The last line in the string is not justified by default.
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [pad-left](https://www.npmjs.com/package/pad-left): Left pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-left "Left pad a string with zeros or a specified string. Fastest implementation.")
* [pad-right](https://www.npmjs.com/package/pad-right): Right pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-right "Right pad a string with zeros or a specified string. Fastest implementation.")
* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 19 | [jonschlinkert](https://github.com/jonschlinkert) |
| 2 | [parro-it](https://github.com/parro-it) |
### Author
**Jon Schlinkert**
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](http://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 12, 2018._