ansi-fragments - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

build/fragments/Color.d.ts

 import IFragment from './IFragment';
-export declare type AnsiColor = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'brightBlack' | 'brightRed' | 'brightGreen' | 'brightYellow' | 'brightBlue' | 'brightMagenta' | 'brightCyan' | 'brightWhite' | 'gray' | 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite' | 'bgBrightBlack' | 'bgBrightRed' | 'bgBrightGreen' | 'bgBrightYellow' | 'bgBrightBlue' | 'bgBrightMagenta' | 'bgBrightCyan' | 'bgBrightWhite';
+export declare type AnsiColor = 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'brightBlack' | 'brightRed' | 'brightGreen' | 'brightYellow' | 'brightBlue' | 'brightMagenta' | 'brightCyan' | 'brightWhite' | 'gray' | 'bgBlack' | 'bgRed' | 'bgGreen' | 'bgYellow' | 'bgBlue' | 'bgMagenta' | 'bgCyan' | 'bgWhite' | 'bgBrightBlack' | 'bgBrightRed' | 'bgBrightGreen' | 'bgBrightYellow' | 'bgBrightBlue' | 'bgBrightMagenta' | 'bgBrightCyan' | 'bgBrightWhite' | 'none';
 export declare function color(ansiColor: AnsiColor, ...children: Array<string | IFragment>): Color;
@@ -4,0 +4,0 @@ export declare class Color implements IFragment {

build/fragments/Color.js

@@ -19,3 +19,6 @@ "use strict";
         const children = utils_1.buildChildren(this.children);
-        if (this.color in colorette_1.default) {
+        if (this.color === 'none') {
+            return children;
+        }
+        else if (this.color in colorette_1.default) {
             // tslint:disable-next-line: no-unsafe-any no-any
@@ -22,0 +25,0 @@ return colorette_1.default[this.color](children);

build/fragments/Modifier.d.ts

 import IFragment from './IFragment';
-export declare type AnsiModifier = 'dim' | 'bold' | 'hidden' | 'italic' | 'underline' | 'strikethrough';
+export declare type AnsiModifier = 'dim' | 'bold' | 'hidden' | 'italic' | 'underline' | 'strikethrough' | 'none';
 export declare function modifier(ansiModifier: AnsiModifier, ...children: Array<string | IFragment>): Modifier;
@@ -4,0 +4,0 @@ export declare class Modifier implements IFragment {

build/fragments/Modifier.js

@@ -19,3 +19,6 @@ "use strict";
         const children = utils_1.buildChildren(this.children);
-        if (this.modifier in colorette_1.default) {
+        if (this.modifier === 'none') {
+            return children;
+        }
+        else if (this.modifier in colorette_1.default) {
             // tslint:disable-next-line: no-unsafe-any no-any
@@ -22,0 +25,0 @@ return colorette_1.default[this.modifier](children);

package.json

 {
   "name": "ansi-fragments",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "build/index.js",
@@ -25,2 +25,3 @@ "license": "MIT",
     "lint": "tslint -t stylish --project tsconfig.json",
+    "test": "jest",
     "build": "tsc --build tsconfig.json",
@@ -32,3 +33,2 @@ "clean": "del build",
     "colorette": "^1.0.7",
-    "del-cli": "^1.1.0",
     "slice-ansi": "^2.0.0",
@@ -39,7 +39,15 @@ "strip-ansi": "^5.0.0"
     "@callstack/tslint-config": "^0.1.0",
+    "@types/jest": "^23.3.13",
     "@types/slice-ansi": "^2.0.0",
     "@types/strip-ansi": "^3.0.0",
+    "del-cli": "^1.1.0",
+    "jest": "^24.0.0",
+    "ts-jest": "^23.10.5",
     "tslint": "^5.12.0",
     "typescript": "^3.2.2"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "rootDir": "./src"
   }
 }

README.md

@@ -12,2 +12,13 @@ # ansi-fragments
 
+- [ansi-fragments](#ansi-fragments)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [API](#api)
+      - [`color`](#color)
+      - [`modifier`](#modifier)
+      - [`container`](#container)
+      - [`pad`](#pad)
+      - [`fixed`](#fixed)
+      - [`provide`](#provide)
+
 ## Installation
@@ -46,4 +57,11 @@
 
-#### `color(ansiColor: AnsiColor, ...children: Array<string | IFragment>): IFragment`
+#### `color`
 
+```ts
+color(
+  ansiColor: AnsiColor,
+  ...children: Array<string | IFragment>
+): IFragment
+```
+
 Creates fragment for standard ANSI [colors](./src/fragments/Color.ts).
@@ -57,4 +75,11 @@
 
-#### `modifier(ansiModifier: AnsiModifier, ...children: Array<string | IFragment>): IFragment`
+#### `modifier`
 
+```ts
+modifier(
+  ansiModifier: AnsiModifier,
+  ...children: Array<string | IFragment>
+): IFragment
+```
+
 Creates fragment for standard ANSI [modifiers](./src/fragments/Modifier.ts): `dim`, `bold`, `hidden`, `italic`, `underline`, `strikethrough`.
@@ -68,4 +93,8 @@
 
-#### `container(...children: Array<string | IFragment>): IFragment`
+#### `container`
 
+```ts
+container(...children: Array<string | IFragment>): IFragment
+```
+
 Creates fragment, which sole purpose is to hold and build nested fragments.
@@ -83,4 +112,8 @@
 
-#### `pad(count: number, separator?: string): IFragment`
+#### `pad`
 
+```ts
+pad(count: number, separator?: string): IFragment
+```
+
 Creates fragment, which repeats given separator (default: ` `) given number of times.
@@ -94,4 +127,12 @@
 
-#### `fixed(value: number, bias: 'start' | 'end', ...children: Array<string | IFragment>): IFragment`
+#### `fixed`
 
+```ts
+fixed(
+  value: number,
+  bias: 'start' | 'end',
+  ...children: Array<string | IFragment>
+): IFragment
+```
+
 Creates fragment, which makes sure the children will always build to given number of non-ANSI characters. It will either trim the results or add necessary amount of spaces. The `bias` control if trimming/padding should be done at the start of the string representing built children or at the end.
@@ -105,3 +146,35 @@
 
+#### `provide`
 
+```ts
+provide<T>(
+  value: T,
+  builder: (value: T) => string | IFragment
+): IFragment
+```
+
+Provides given value to a builder function, which should return `string` or fragment. Useful in situations when the output is connected with some calculated value - using `provide` you only need to calculate final value once and forward it to custom styling logic.
+
+```js
+provide(getMessageFromSomewhere(), value => {
+  switch (value.level) {
+    case 'error':
+      return container(
+        color('red', modifier('bold', value.level.toUpperCase())),
+        pad(2),
+        value.log
+      );
+    case 'info':
+      return container(
+        color('blue', value.level.toUpperCase()),
+        pad(2),
+        value.log
+      );
+    default:
+      return container(value.level.toUpperCase(), pad(2), value.log);
+  }
+})
+```
+
+
 <!-- badges (common) -->
@@ -108,0 +181,0 @@

No alert changes

Improved metrics

Total package byte prevSize

24767

increased by21.58%

Dependency count

3

decreased by-25%

Number of package files

38

increased by11.76%

Lines of code

222

increased by13.27%

Number of lines in readme file

186

increased by64.6%

Worsened metrics

Dev dependency count

9

increased by80%

Dependency changes

• - Removeddel-cli@^1.1.0

• - Removedansi-align@2.0.0(transitive)

• - Removedansi-regex@3.0.1(transitive)

• - Removedarray-find-index@1.0.2(transitive)

• - Removedarray-union@1.0.2(transitive)

• - Removedarray-uniq@1.0.3(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedboxen@1.3.0(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedcamelcase@2.1.14.1.0(transitive)

• - Removedcamelcase-keys@2.1.0(transitive)

• - Removedcapture-stack-trace@1.0.2(transitive)

• - Removedchalk@2.4.2(transitive)

• - Removedci-info@1.6.0(transitive)

• - Removedcli-boxes@1.0.0(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedconfigstore@3.1.5(transitive)

• - Removedcreate-error-class@3.0.2(transitive)

• - Removedcross-spawn@5.1.0(transitive)

• - Removedcrypto-random-string@1.0.0(transitive)

• - Removedcurrently-unhandled@0.4.1(transitive)

• - Removeddecamelize@1.2.0(transitive)

• - Removeddeep-extend@0.6.0(transitive)

• - Removeddel@3.0.0(transitive)

• - Removeddel-cli@1.1.0(transitive)

• - Removeddot-prop@4.2.1(transitive)

• - Removedduplexer3@0.1.5(transitive)

• - Removederror-ex@1.3.2(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedexeca@0.7.0(transitive)

• - Removedfind-up@1.1.2(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedget-stdin@4.0.1(transitive)

• - Removedget-stream@3.0.0(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedglobal-dirs@0.1.1(transitive)

• - Removedglobby@6.1.0(transitive)

• - Removedgot@6.7.1(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedhas-flag@3.0.0(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedhosted-git-info@2.8.9(transitive)

• - Removedimport-lazy@2.1.0(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedindent-string@2.1.0(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedini@1.3.8(transitive)

• - Removedis-arrayish@0.2.1(transitive)

• - Removedis-ci@1.2.1(transitive)

• - Removedis-core-module@2.14.0(transitive)

• - Removedis-finite@1.1.0(transitive)

• - Removedis-installed-globally@0.1.0(transitive)

• - Removedis-npm@1.0.0(transitive)

• - Removedis-obj@1.0.1(transitive)

• - Removedis-path-cwd@1.0.0(transitive)

• - Removedis-path-in-cwd@1.0.1(transitive)

• - Removedis-path-inside@1.0.1(transitive)

• - Removedis-redirect@1.0.0(transitive)

• - Removedis-retry-allowed@1.2.0(transitive)

• - Removedis-stream@1.1.0(transitive)

• - Removedis-utf8@0.2.1(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removedlatest-version@3.1.0(transitive)

• - Removedload-json-file@1.1.0(transitive)

• - Removedloud-rejection@1.6.0(transitive)

• - Removedlowercase-keys@1.0.1(transitive)

• - Removedlru-cache@4.1.5(transitive)

• - Removedmake-dir@1.3.0(transitive)

• - Removedmap-obj@1.0.1(transitive)

• - Removedmeow@3.7.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removednormalize-package-data@2.5.0(transitive)

• - Removednpm-run-path@2.0.2(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedp-finally@1.0.0(transitive)

• - Removedp-map@1.2.0(transitive)

• - Removedpackage-json@4.0.1(transitive)

• - Removedparse-json@2.2.0(transitive)

• - Removedpath-exists@2.1.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpath-is-inside@1.0.2(transitive)

• - Removedpath-key@2.0.1(transitive)

• - Removedpath-parse@1.0.7(transitive)

• - Removedpath-type@1.1.0(transitive)

• - Removedpify@2.3.03.0.0(transitive)

• - Removedpinkie@2.0.4(transitive)

• - Removedpinkie-promise@2.0.1(transitive)

• - Removedprepend-http@1.0.4(transitive)

• - Removedpseudomap@1.0.2(transitive)

• - Removedrc@1.2.8(transitive)

• - Removedread-pkg@1.1.0(transitive)

• - Removedread-pkg-up@1.0.1(transitive)

• - Removedredent@1.0.0(transitive)

• - Removedregistry-auth-token@3.4.0(transitive)

• - Removedregistry-url@3.1.0(transitive)

• - Removedrepeating@2.0.1(transitive)

• - Removedresolve@1.22.8(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsemver@5.7.2(transitive)

• - Removedsemver-diff@2.1.0(transitive)

• - Removedshebang-command@1.2.0(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedspdx-correct@3.2.0(transitive)

• - Removedspdx-exceptions@2.5.0(transitive)

• - Removedspdx-expression-parse@3.0.1(transitive)

• - Removedspdx-license-ids@3.0.18(transitive)

• - Removedstring-width@2.1.1(transitive)

• - Removedstrip-ansi@4.0.0(transitive)

• - Removedstrip-bom@2.0.0(transitive)

• - Removedstrip-eof@1.0.0(transitive)

• - Removedstrip-indent@1.0.1(transitive)

• - Removedstrip-json-comments@2.0.1(transitive)

• - Removedsupports-color@5.5.0(transitive)

• - Removedsupports-preserve-symlinks-flag@1.0.0(transitive)

• - Removedterm-size@1.2.0(transitive)

• - Removedtimed-out@4.0.1(transitive)

• - Removedtrim-newlines@1.0.0(transitive)

• - Removedunique-string@1.0.0(transitive)

• - Removedunzip-response@2.0.1(transitive)

• - Removedupdate-notifier@2.5.0(transitive)

• - Removedurl-parse-lax@1.0.0(transitive)

• - Removedvalidate-npm-package-license@3.0.4(transitive)

• - Removedwhich@1.3.1(transitive)

• - Removedwidest-line@2.0.1(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedwrite-file-atomic@2.4.3(transitive)

• - Removedxdg-basedir@3.0.0(transitive)

• - Removedyallist@2.1.2(transitive)