tecfu / smartwrap Goto Github PK

8.0 1.0 4.0 131 KB

Textwrap for javascript/nodejs. Correctly handles wide characters (宽字符) and emojis (😃). Automatically breaks long words. https://www.npmjs.com/package/smartwrap

License: MIT License

JavaScript 100.00%

textwrap wordwrap wide-characters

smartwrap's Introduction

smartwrap

Textwrap for javascript/nodejs. Correctly handles wide characters (宽字符) and emojis (😃). Optionally break words when wrapping strings.

Why?

I needed a javascript package to correctly wrap wide characters - which have a "length" property value of 1 but occupy 2 or more spaces in the terminal.

Example Usages:

Terminal:

npm i -g smartwrap
echo somestring you want to wrap | smartwrap --width=3 --paddingLeft=1

Output:

 so
 me
 st
 ri
 ng
 yo
 u
 wa
 nt
 to
 wr
 ap

Node module:

Wide Character Wrapping

var Smartwrap = require('smartwrap');
var exampleText1 = '宽字符';
console.log(Smartwrap(exampleText1,{
  width: 2
}));

Output:

宽
字
符

String Wrapping

let exampleText2 = "break at word"

console.log(smartwrap(exampleText2,{
  width: 10,
  breakword: false //default
}))

Output:

break at
word

Breaking Words When Wrapping Strings

console.log(smartwrap(exampleText2,{
  width: 10,
  breakword: true
}))

Output:

break at w
ord

Options

--breakword       Choose whether or not to break words when wrapping a string
                                                                 [default: false]
--errorChar       Placeholder for wide characters when minWidth < 2
                                                                 [default: �]
--minWidth        Never change this unless you are certin you are not using
                  wide characters and you want a column 1 space wide. Then
                  change to 1.                   [choices: 1, 2] [default: 2]
--paddingLeft     Set the left padding of the output             [default: 0]
--paddingRight    Set the right padding of the output            [default: 0]
--splitAt         Characters at which to split input    [default: [" ","\t"]]
--trim            Trim the whitespace from end of input       [default: true]
--width, -w       Set the line width of the output (in spaces)
                                                     [required] [default: 10]

Compatibility

node 6.0 <

License

MIT

smartwrap's People

Contributors

Stargazers

Watchers

Forkers

arunasank mscalora hipsterzipster jpeer264

smartwrap's Issues

upgrade GPL 2.0 to GPL 3.0

Hi man. I tried to use your module to integrate to my module. Can you please to consider upgrade your GPL 2.0 license to GPL 3.0? That would be more clearly.

Suggestion to reduce number of dependencies

array.prototype.flat has 50 dependencies.

Node 10 support ended May 19, 2020.

Would you be open to a PR to drop support for Node 6-10 and remove array.prototype.flat as a dependency?

Fail to include v1.0.10 package using yarn

$ yarn add smartwrap
yarn add v1.12.3
[1/4] Resolving packages...
[2/4] Fetching packages...
error http://registry.npm.taobao.org/smartwrap/download/smartwrap-1.0.10.tgz: Extracting tar content of undefined failed, the file appears to be corrupt: "ENOENT: no such file or directory, open 'd:\yarn-cache\v4\npm-smartwrap-1.0.10-873ef350d4ee1262fed4a80a55634d86ae1faf48\node_modules\smartwrap\e'"

wepy-cli因为本仓库不能使用了

Tencent/wepy#2021

smartwrap is not as smart as breakword

smartwrap is not able to break words as well as breakword

I think maybe there is some use of .split() and/or .substr() that needs to be changed to arrays created with the spread operator [...str] which knows how to correctly divide strings to characters

See output from:

const breakword = require("breakword")

const str = "😀😀😀😀"

console.log(`String: ${str}`)
for (let w = 0; w < 10; w++) {
  let x = breakword(str,w),
    part1 = [...str].slice(0, x + 1).join(""),
    part2 = [...str].slice(x + 1).join("")

  console.log(`w=${w} bw=${x} "${part1}"   "${part2}"`)
}

const smartwrap = require("smartwrap")

console.log(`String: ${str}`)
for (let w = 0; w < 10; w++) {
  let wrapped = smartwrap(str, {width: w, breakword: true, errorChar: "é"}),
    lines = wrapped.split("\n"),
    part1 = lines[0],
    part2 = lines[1] || null

  console.log(`lines=${lines.length} ${JSON.stringify(part1)}   ${JSON.stringify(part2)}`)
}

Change license from GPL to MIT

Hi,
My team has come to depend on this package given the recent change in GraphQL Tools to depend on value-or-promise which indirectly relies on smartwrap. Unfortunately, we cannot leverage GPL licensed dependencies due to legal restrictions. Is it possible to change the license to a more permissive one such as Apache or MIT instead?

PR: #13