firest commit

2026-02-21 22:48:40 +08:00
commit 55e8053e07
1034 changed files with 99049 additions and 0 deletions
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-21 Lloyd Brookes <75pound@gmail.com>
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.
@@ -0,0 +1,61 @@
+[![view on npm](https://badgen.net/npm/v/wordwrapjs)](https://www.npmjs.org/package/wordwrapjs)
+[![npm module downloads](https://badgen.net/npm/dt/wordwrapjs)](https://www.npmjs.org/package/wordwrapjs)
+[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/wordwrapjs)](https://github.com/75lb/wordwrapjs/network/dependents?dependent_type=REPOSITORY)
+[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/wordwrapjs)](https://github.com/75lb/wordwrapjs/network/dependents?dependent_type=PACKAGE)
+[![Build Status](https://travis-ci.org/75lb/wordwrapjs.svg?branch=master)](https://travis-ci.org/75lb/wordwrapjs)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
+
+# wordwrapjs
+
+Word wrapping, with a few features.
+
+- force-break option
+- wraps hypenated words
+- multilingual - wraps any language that uses whitespace for word separation.
+
+## Synopsis
+
+Wrap some text in a 20 character column.
+
+```js
+> wordwrap = require('wordwrapjs')
+
+> text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
+
+> result = wordwrap.wrap(text, { width: 20 })
+```
+
+`result` now looks like this:
+```
+Lorem ipsum dolor
+sit amet,
+consectetur
+adipiscing elit, sed
+do eiusmod tempor
+incididunt ut labore
+et dolore magna
+aliqua.
+```
+
+By default, long words will not break. Unless you set the `break` option.
+```js
+> url = 'https://github.com/75lb/wordwrapjs'
+
+> wrap.lines(url, { width: 18 })
+[ 'https://github.com/75lb/wordwrapjs' ]
+
+> wrap.lines(url, { width: 18, break: true })
+[ 'https://github.com', '/75lb/wordwrapjs' ]
+```
+
+## API Reference
+
+{{#module name="wordwrapjs"}}
+{{>body~}}
+{{>member-index~}}
+{{>members~}}
+{{/module}}
+
+* * *
+
+&copy; 2015-21 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
@@ -0,0 +1,115 @@
+[![view on npm](https://badgen.net/npm/v/wordwrapjs)](https://www.npmjs.org/package/wordwrapjs)
+[![npm module downloads](https://badgen.net/npm/dt/wordwrapjs)](https://www.npmjs.org/package/wordwrapjs)
+[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/wordwrapjs)](https://github.com/75lb/wordwrapjs/network/dependents?dependent_type=REPOSITORY)
+[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/wordwrapjs)](https://github.com/75lb/wordwrapjs/network/dependents?dependent_type=PACKAGE)
+[![Build Status](https://travis-ci.org/75lb/wordwrapjs.svg?branch=master)](https://travis-ci.org/75lb/wordwrapjs)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
+
+# wordwrapjs
+
+Word wrapping, with a few features.
+
+- force-break option
+- wraps hypenated words
+- multilingual - wraps any language that uses whitespace for word separation.
+
+## Synopsis
+
+Wrap some text in a 20 character column.
+
+```js
+> wordwrap = require('wordwrapjs')
+
+> text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
+
+> result = wordwrap.wrap(text, { width: 20 })
+```
+
+`result` now looks like this:
+```
+Lorem ipsum dolor
+sit amet,
+consectetur
+adipiscing elit, sed
+do eiusmod tempor
+incididunt ut labore
+et dolore magna
+aliqua.
+```
+
+By default, long words will not break. Unless you set the `break` option.
+```js
+> url = 'https://github.com/75lb/wordwrapjs'
+
+> wrap.lines(url, { width: 18 })
+[ 'https://github.com/75lb/wordwrapjs' ]
+
+> wrap.lines(url, { width: 18, break: true })
+[ 'https://github.com', '/75lb/wordwrapjs' ]
+```
+
+## API Reference
+
+
+* [wordwrapjs](#module_wordwrapjs)
+    * [WordWrap](#exp_module_wordwrapjs--WordWrap) ⏏
+        * [.wrap(text, [options])](#module_wordwrapjs--WordWrap.wrap) ⇒ <code>string</code>
+        * [.lines(text, options)](#module_wordwrapjs--WordWrap.lines)
+        * [.isWrappable(text)](#module_wordwrapjs--WordWrap.isWrappable) ⇒ <code>boolean</code>
+        * [.getChunks(text)](#module_wordwrapjs--WordWrap.getChunks) ⇒ <code>Array.&lt;string&gt;</code>
+
+<a name="exp_module_wordwrapjs--WordWrap"></a>
+
+### WordWrap ⏏
+**Kind**: Exported class  
+<a name="module_wordwrapjs--WordWrap.wrap"></a>
+
+#### WordWrap.wrap(text, [options]) ⇒ <code>string</code>
+**Kind**: static method of [<code>WordWrap</code>](#exp_module_wordwrapjs--WordWrap)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | the input text to wrap |
+| [options] | <code>object</code> | optional configuration |
+| [options.width] | <code>number</code> | the max column width in characters (defaults to 30). |
+| [options.break] | <code>boolean</code> | if true, words exceeding the specified `width` will be forcefully broken |
+| [options.noTrim] | <code>boolean</code> | By default, each line output is trimmed. If `noTrim` is set, no line-trimming occurs - all whitespace from the input text is left in. |
+
+<a name="module_wordwrapjs--WordWrap.lines"></a>
+
+#### WordWrap.lines(text, options)
+Wraps the input text, returning an array of strings (lines).
+
+**Kind**: static method of [<code>WordWrap</code>](#exp_module_wordwrapjs--WordWrap)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | input text |
+| options | <code>object</code> | Accepts same options as constructor. |
+
+<a name="module_wordwrapjs--WordWrap.isWrappable"></a>
+
+#### WordWrap.isWrappable(text) ⇒ <code>boolean</code>
+Returns true if the input text would be wrapped if passed into `.wrap()`.
+
+**Kind**: static method of [<code>WordWrap</code>](#exp_module_wordwrapjs--WordWrap)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | input text |
+
+<a name="module_wordwrapjs--WordWrap.getChunks"></a>
+
+#### WordWrap.getChunks(text) ⇒ <code>Array.&lt;string&gt;</code>
+Splits the input text into an array of words and whitespace.
+
+**Kind**: static method of [<code>WordWrap</code>](#exp_module_wordwrapjs--WordWrap)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | input text |
+
+
+* * *
+
+&copy; 2015-21 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
@@ -0,0 +1,148 @@
+const os = require('os')
+const t = require('typical')
+
+/**
+ * @module wordwrapjs
+ */
+
+const re = {
+  chunk: /[^\s-]+?-\b|\S+|\s+|\r\n?|\n/g,
+  ansiEscapeSequence: /\u001b.*?m/g
+}
+
+/**
+ * @alias module:wordwrapjs
+ * @typicalname wordwrap
+ */
+class WordWrap {
+  constructor (text, options) {
+    options = options || {}
+    if (!t.isDefined(text)) text = ''
+
+    this._lines = String(text).split(/\r\n|\n/g)
+    this.options = options
+    this.options.width = options.width === undefined ? 30 : options.width
+  }
+
+  lines () {
+    const flatten = require('reduce-flatten')
+
+    /* trim each line of the supplied text */
+    return this._lines.map(trimLine.bind(this))
+
+      /* split each line into an array of chunks, else mark it empty */
+      .map(line => line.match(re.chunk) || [ '~~empty~~' ])
+
+      /* optionally, break each word on the line into pieces */
+      .map(lineWords => {
+        if (this.options.break) {
+          return lineWords.map(breakWord.bind(this))
+        } else {
+          return lineWords
+        }
+      })
+      .map(lineWords => lineWords.reduce(flatten, []))
+
+      /* transforming the line of words to one or more new lines wrapped to size */
+      .map(lineWords => {
+        return lineWords
+          .reduce((lines, word) => {
+            let currentLine = lines[lines.length - 1]
+            if (replaceAnsi(word).length + replaceAnsi(currentLine).length > this.options.width) {
+              lines.push(word)
+            } else {
+              lines[lines.length - 1] += word
+            }
+            return lines
+          }, [ '' ])
+      })
+      .reduce(flatten, [])
+
+      /* trim the wrapped lines */
+      .map(trimLine.bind(this))
+
+      /* filter out empty lines */
+      .filter(line => line.trim())
+
+      /* restore the user's original empty lines */
+      .map(line => line.replace('~~empty~~', ''))
+  }
+
+  wrap () {
+    return this.lines().join(os.EOL)
+  }
+
+  toString () {
+    return this.wrap()
+  }
+
+  /**
+   * @param {string} - the input text to wrap
+   * @param [options] {object} - optional configuration
+   * @param [options.width] {number} - the max column width in characters (defaults to 30).
+   * @param [options.break] {boolean} - if true, words exceeding the specified `width` will be forcefully broken
+   * @param [options.noTrim] {boolean} - By default, each line output is trimmed. If `noTrim` is set, no line-trimming occurs - all whitespace from the input text is left in.
+   * @return {string}
+   */
+  static wrap (text, options) {
+    const block = new this(text, options)
+    return block.wrap()
+  }
+
+  /**
+   * Wraps the input text, returning an array of strings (lines).
+   * @param {string} - input text
+   * @param {object} - Accepts same options as constructor.
+   */
+  static lines (text, options) {
+    const block = new this(text, options)
+    return block.lines()
+  }
+
+  /**
+   * Returns true if the input text would be wrapped if passed into `.wrap()`.
+   * @param {string} - input text
+   * @return {boolean}
+   */
+  static isWrappable (text) {
+    if (t.isDefined(text)) {
+      text = String(text)
+      var matches = text.match(re.chunk)
+      return matches ? matches.length > 1 : false
+    }
+  }
+
+  /**
+   * Splits the input text into an array of words and whitespace.
+   * @param {string} - input text
+   * @returns {string[]}
+   */
+  static getChunks (text) {
+    return text.match(re.chunk) || []
+  }
+}
+
+function trimLine (line) {
+  return this.options.noTrim ? line : line.trim()
+}
+
+function replaceAnsi (string) {
+  return string.replace(re.ansiEscapeSequence, '')
+}
+
+/* break a word into several pieces */
+function breakWord (word) {
+  if (replaceAnsi(word).length > this.options.width) {
+    const letters = word.split('')
+    let piece
+    const pieces = []
+    while ((piece = letters.splice(0, this.options.width)).length) {
+      pieces.push(piece.join(''))
+    }
+    return pieces
+  } else {
+    return word
+  }
+}
+
+module.exports = WordWrap
@@ -0,0 +1,34 @@
+{
+  "name": "wordwrapjs",
+  "author": "Lloyd Brookes <75pound@gmail.com>",
+  "version": "4.0.1",
+  "description": "Word-wrapping for javascript.",
+  "repository": "https://github.com/75lb/wordwrapjs.git",
+  "license": "MIT",
+  "keywords": [
+    "word",
+    "line",
+    "wrap",
+    "text",
+    "columns",
+    "wordwrap"
+  ],
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "scripts": {
+    "test": "test-runner test.js",
+    "docs": "jsdoc2md -t README.hbs index.js > README.md; echo"
+  },
+  "devDependencies": {
+    "jsdoc-to-markdown": "^7.0.0",
+    "test-runner": "~0.6.3"
+  },
+  "dependencies": {
+    "reduce-flatten": "^2.0.0",
+    "typical": "^5.2.0"
+  },
+  "files": [
+    "index.js"
+  ]
+}