halil / string-builder Goto Github PK

View Code? Open in Web Editor NEW

9.0 3.0 9.0 23 KB

Node.JS String Builder

License: MIT License

JavaScript 100.00%

nodejs node-module stringbuilder javascript no-dependencies string-builder

string-builder's Introduction

StringBuilder

An string builder for Node.js

Installation

npm install string-builder

Usage

const StringBuilder = require("string-builder");
const sb = new StringBuilder();

const buffer = Buffer.from([0x30, 0x31, 0x32]); // 012

sb.append("normal text");
sb.appendLine();
sb.appendFormat("formatted text {0}, {1}", "format 1", "format 2");
sb.appendLine()
sb.append(12)
sb.appendLine()
sb.append(1)
sb.appendLine()
sb.append(0)
sb.appendLine()
sb.appendFormat("formatted text {0}, {1}", 3.6745674, 12);
sb.appendLine()
sb.appendLine(true)
sb.appendLine(false)
sb.appendLine(buffer)
sb.appendLine()
sb.append(undefined);
sb.appendLine()
sb.append(null);
sb.appendLine()
sb.appendFormat("formatted text {0}, {1}", 3.6745674, 1);

console.log("======")
console.log(sb.toString());
console.log("======")

/*
console =>
======
normal text
formatted text format 1, format 2
12
1
0
formatted text 3.6745674, 12

true
false
012


formatted text 3.6745674, 1
======
*/

License

The MIT License (MIT)

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.

string-builder's People

Contributors

Stargazers

Watchers

Forkers

gitter-badger gantrim nirvanagit fossabot iconum-nl ml054 jaime-lee jglanz kuzalekon

string-builder's Issues

Regex ile istenilen değerlerin birleştirilmesi

Syntax Düzenlemeleri

Dökümantasyonun Güncellenmesi

NPM release of string builder 0.1.5 appears to have included a .git file in the module.

We are seeing errors similar to this in automated builds:

16:52:50 npm ERR! path [path omitted]/node_modules/string-builder
16:52:50 npm ERR! code EISGIT
16:52:50 npm ERR! git [path omitted]/node_modules/string-builder: Appears to be a git repo or submodule.
16:52:50 npm ERR! git [path omitted]/node_modules/string-builder
16:52:50 npm ERR! git Refusing to remove it. Update manually,
16:52:50 npm ERR! git or move it out of the way first.
16:52:50 
16:52:50 npm ERR! A complete log of this run can be found in:
16:52:50 npm ERR!     [path omitted]

This was during an npm install command, and it was working on string-builder 0.1.5, though the workspace may have had a previous version before this.

Invalid handling of numbers / falsy

    it("a", () => {
        const sb1 = new StringBuilder("init");
        sb1.append(0);

        const sb2 = new StringBuilder("init");
        sb2.append(1);

        console.log(sb1.toString());
        console.log(sb2.toString());

        const sb_true = new StringBuilder("init");
        sb_true.append(true);

        const sb_false = new StringBuilder("init");
        sb_false.append(false);

        console.log(sb_true.toString());
        console.log(sb_false.toString());
    })

output:

init
init1
inittrue
init

so if pass falsy nothing is appended to output which is really misleading.

Update NPM

I installed by NPM, but this version has a features (57d7768).

Bug in Linux OS

I think there is a bug in this function

StringBuilder.prototype.appendLine = function (v) {
  this.s.push("\r\n");
  if (v) {
    this.s.push(v);
  }
  return this;
};

\r\n will work in Windows OS, while in Linux this will cause problems (by adding '\r')

Version 0.1.7 has breaking changes

Hi,

Sometime ago I reported #13

After your fix some of this features stopped working since currently string-builder only accepts string and numbers. We passed booleans and even buffer and it worked fine. I'm affraid it could break dependent projects.

Let's assume testing code:

var StringBuilder = require("../src/StringBuilder");
var sb = new StringBuilder();

sb.append("normal text ");

sb.appendLine();

sb.appendFormat("formatted text {0},{1}", "format 1", "format 2");

var buffer = Buffer.from([0x30, 0x31, 0x32]);

sb.appendLine()
sb.append(12)
sb.appendLine()
sb.append(1)
sb.appendLine()
sb.append(0)
sb.appendLine()
sb.appendFormat("formatted text {0},{1}", 3.6745674, 12);
sb.appendLine()
sb.appendLine(true)
sb.appendLine(false)
sb.append(buffer)
sb.appendLine()
sb.append(undefined);
sb.appendLine()
sb.append(null);
sb.appendLine()

sb.appendFormat("formatted text {0},{1}", 3.6745674, 1);

console.log("======")
console.log(sb.toString());
console.log("======")

output on 0.1.6:

======
normal text
formatted text format 1,format 2
12
1

formatted text 3.6745674,12

true
012


formatted text 3.6745674,1
======

output on 0.1.7:

======
normal text
formatted text format 1,format 2
12
1
0
formatted text 3.6745674,12





formatted text 3.6745674,1
======

as you can see most of lines are empty in 0.1.7.

Output with my fix:

======
normal text
formatted text format 1,format 2
12
1
0
formatted text 3.6745674,12

true
false012


formatted text 3.6745674,1
======

so it doesn't output anything when value is null or undefined. I will create PR soon.