npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fardog/wordwrap

v1.1.0

Published

Wrap those words. Show them at what columns to start and stop.

Downloads

6

Readme

@fardog/wordwrap

Wrap text to a specified line length, with a length calculation of your choosing

Build Status npm install js-standard-style

This is a fork of substack's wordwrap which allows you to pass a length-calculating function if you so desire, making it workable with things like double-width characters or others that behave poorly with String.length.

Pairs nicely with:

  • strip-ansi - strips ansi terminal color codes from text
  • visualwidth - gives you the width of text taking dual-width characters into account

Examples

Wrapping to a line length:

var wrap = require('@fardog/wordwrap')(15)

console.log(wrap('You and your whole family are made out of meat.'))

outputs:

You and your
whole family
are made out
of meat.

Or centering text by setting a start and an end, and providing an optional length-calculation function that ignores ANSI color codes:

var wrap = require('@fardog/wordwrap')(20, 60, {lengthFn: len})
var strip = require('strip-ansi')

console.log(wrap(
  'At long last the struggle and tumult was over.' +
  ' The machines had finally cast off their oppressors' +
  ' and were finally free to roam the cosmos.' +
  '\n' +
  'Free of purpose, free of obligation.' +
  ' Just drifting through emptiness.' +
  ' The sun was just another point of light.'
))

function len(text) {
  // strips any ansi color codes and returns the actual text length
  return strip(text).length
}

outputs:

                   At long last the struggle and tumult
                   was over. The machines had finally cast
                   off their oppressors and were finally
                   free to roam the cosmos.
                   Free of purpose, free of obligation.
                   Just drifting through emptiness. The
                   sun was just another point of light.

Usage

var wrap = require('@fardog/wordwrap')

wrap(stop), wrap(start, stop, params={mode:"soft", lengthFn: String.length})

Returns a function that takes a string and returns a new string.

Pad out lines with spaces out to column start and then wrap until column stop. If a word is longer than stop - start characters it will overflow.

In "soft" mode, split chunks by /(\S+\s+/ and don't break up chunks which are longer than stop - start, in "hard" mode, split chunks with /\b/ and break up chunks longer than stop - start.

If provided, a custom length function can be used in place of the default which is String.length.

wrap.hard(start, stop)

Like wrap() but with params.mode = "hard".

License

MIT. See LICENSE for details.

wordwrap was originally written by James Halliday. This fork is maintained by Nathan Wittstock.