8colors 1.0.0 → 1.0.2

package/README.md

@@ -17,7 +17,7 @@ npm install --save 8colors
 #### Example
 
 ```javascript
-const c = require('./index')
+const c = require('8colors')
 
 var title ='WARNING'
 

package/index.d.ts

@@ -0,0 +1,71 @@
+declare module '8colors' {
+    interface EightColors {
+        store: string;
+
+        // Direct color methods
+        black(str: string): string;
+        red(str: string): string;
+        green(str: string): string;
+        yellow(str: string): string;
+        blue(str: string): string;
+        magenta(str: string): string;
+        cyan(str: string): string;
+        white(str: string): string;
+
+        // Chainable foreground standard
+        k(str: string): this;
+        r(str: string): this;
+        g(str: string): this;
+        y(str: string): this;
+        b(str: string): this;
+        m(str: string): this;
+        c(str: string): this;
+        w(str: string): this;
+
+        // Chainable foreground bright
+        bk(str: string): this;
+        br(str: string): this;
+        bg(str: string): this;
+        by(str: string): this;
+        bb(str: string): this;
+        bm(str: string): this;
+        bc(str: string): this;
+        bw(str: string): this;
+
+        // Chainable background standard
+        K(): this;
+        R(): this;
+        G(): this;
+        Y(): this;
+        B(): this;
+        M(): this;
+        C(): this;
+        W(): this;
+
+        // Chainable background bright
+        BK(): this; // Note: You have two BB's in your code, I've renamed bright_bg_black to BK
+        BR(): this;
+        BG(): this;
+        BY(): this;
+        BB(): this;
+        BM(): this;
+        BC(): this;
+        BW(): this;
+
+        // Chainable styles
+        V(): this;
+        _(): this;
+        reset(): this;
+        I(): this;
+        blk(): this;
+        rblk(): this;
+
+        /**
+         * Returns the final styled string and resets the internal store.
+         */
+        end(): string;
+    }
+
+    const eightColors: EightColors;
+    export = eightColors;
+}

package/index.js

@@ -1,147 +1,147 @@
-`use strict`
-
-const colors = {
-    //style
-    "reset" : "\033[0m",
-    "intense" : "\033[1m",
-    "underline" : "\033[4m",
-    "inverse" : "\033[7m",
-    "slow_blink": "\033[5m",
-    "rapid_blink": "\033[6m",
-    // foreground colors STANDARD
-    "black" : "\033[30m",
-    "red" : "\033[31m",
-    "green" : "\033[32m",
-    "yellow" : "\033[33m",
-    "blue" : "\033[34m",
-    "magenta" : "\033[35m",
-    "cyan" : "\033[36m",
-    "white" : "\033[37m",
-    // foreground colors BRIGHT
-    "bright_black" : "\033[90m",
-    "bright_red" : "\033[91m",
-    "bright_green" : "\033[92m",
-    "bright_yellow" : "\033[93m",
-    "bright_blue" : "\033[94m",
-    "bright_magenta" : "\033[95m",
-    "bright_cyan" : "\033[96m",
-    "bright_white" : "\033[97m",
-    // background colors STANDARD
-    "bg_black" : "\033[40m",
-    "bg_red" : "\033[41m",
-    "bg_green" : "\033[42m",
-    "bg_yellow" : "\033[43m",
-    "bg_blue" : "\033[44m",
-    "bg_magenta" : "\033[45m",
-    "bg_cyan" : "\033[46m",
-    "bg_white" : "\033[47m",
-     // background colors BRIGHT
-     "bright_bg_black" : "\033[100m",
-     "bright_bg_red" : "\033[101m",
-     "bright_bg_green" : "\033[102m",
-     "bright_bg_yellow" : "\033[103m",
-     "bright_bg_blue" : "\033[104m",
-     "bright_bg_magenta" : "\033[105m",
-     "bright_bg_cyan" : "\033[106m",
-     "bright_bg_white" : "\033[107m"
-  }
-
-
-module.exports =  {
-      store: '',
-      black : function(str) {return colors['black'] + str + colors['reset']},
-      red : function(str) {return colors['red'] + str + colors['reset']},
-      green : function(str) {return colors['green'] + str + colors['reset']},
-      yellow : function(str) {return colors['yellow'] + str + colors['reset']},
-      blue : function(str) {return colors['blue'] + str + colors['reset']},
-      magenta : function(str) {return colors['magenta'] + str + colors['reset']},
-      cyan : function(str) {return colors['cyan'] + str + colors['reset']},
-      white : function(str) {return colors['white'] + str + colors['reset']},
-      //shorthand Foreground STANDARD
-      k : function(str) {this.store += colors['black'] + str + colors['reset'] 
-                        return this},
-      r : function(str) {this.store += colors['red'] + str + colors['reset'] 
-                        return this},
-      g : function(str) {this.store += colors['green'] + str + colors['reset'] 
-                        return this},
-      y : function(str) {this.store += colors['yellow'] + str + colors['reset']
-                        return this},
-      b : function(str) {this.store += colors['blue'] + str + colors['reset'] 
-                        return this},
-      m : function(str) {this.store += colors['magenta'] + str + colors['reset'] 
-                        return this},
-      c : function(str) {this.store += colors['cyan'] + str + colors['reset'] 
-                        return this},
-      w : function(str) {this.store += colors['white'] + str + colors['reset'] 
-                        return this },
-      //shorthand Foreground BRIGHT
-      bk : function(str) {this.store += colors['bright_black'] + str + colors['reset'] 
-                        return this},
-      br : function(str) {this.store += colors['bright_red'] + str + colors['reset'] 
-                        return this},
-      bg : function(str) {this.store += colors['bright_green'] + str + colors['reset'] 
-                        return this},
-      by : function(str) {this.store += colors['bright_yellow'] + str + colors['reset']
-                        return this},
-      bb : function(str) {this.store += colors['bright_blue'] + str + colors['reset'] 
-                        return this},
-      bm : function(str) {this.store += colors['bright_magenta'] + str + colors['reset'] 
-                        return this},
-      bc : function(str) {this.store += colors['bright_cyan'] + str + colors['reset'] 
-                        return this},
-      bw : function(str) {this.store += colors['bright_white'] + str + colors['reset'] 
-                        return this },                        
-      //shorthand Background STANDARD
-      K : function(str) {this.store += colors['bg_black'] 
-                        return this},
-      R : function(str) {this.store += colors['bg_red'] 
-                        return this},
-      G : function(str) {this.store += colors['bg_green'] 
-                        return this},
-      Y : function(str) {this.store += colors['bg_yellow'] 
-                        return this},
-      B : function(str) {this.store += colors['bg_blue'] 
-                        return this},
-      M : function(str) {this.store += colors['bg_magenta']
-                        return this},
-      C : function(str) {this.store += colors['bg_cyan']
-                        return this},
-      W : function(str) {this.store += colors['bg_white']
-                        return this },
-      //shorthand Background BRIGHT
-      BB : function(str) {this.store += colors['bright_bg_black'] 
-                        return this},
-      BR : function(str) {this.store += colors['bright_bg_red'] 
-                        return this},
-      BG : function(str) {this.store += colors['bright_bg_green'] 
-                        return this},
-      BY : function(str) {this.store += colors['bright_bg_yellow'] 
-                        return this},
-      BB : function(str) {this.store += colors['bright_bg_blue'] 
-                        return this},
-      BM : function(str) {this.store += colors['bright_bg_magenta']
-                        return this},
-      BC : function(str) {this.store += colors['bright_bg_cyan']
-                        return this},
-      BW : function(str) {this.store += colors['bright_bg_white']
-                        return this },                        
-       //styles
-      V : function() {this.store += colors['inverse']
-                        return this},
-      _ : function() {this.store += colors['underline']
-                        return this},
-      reset : function() {this.store += colors['reset']
-                        return this},
-      I : function() {this.store += colors['intense']
-                        return this},
-      blk : function() {this.store += colors['slow_blink']
-                        return this},
-      rblk : function() {this.store += colors['rapid_blink']
-                        return this},                                       
-      end: function(){
-                      result = this.store 
-                      //reset store
-                       this.store='' 
-                       return result
-      }
+`use strict`
+
+const colors = {
+    //style
+    "reset" : "\033[0m",
+    "intense" : "\033[1m",
+    "underline" : "\033[4m",
+    "inverse" : "\033[7m",
+    "slow_blink": "\033[5m",
+    "rapid_blink": "\033[6m",
+    // foreground colors STANDARD
+    "black" : "\033[30m",
+    "red" : "\033[31m",
+    "green" : "\033[32m",
+    "yellow" : "\033[33m",
+    "blue" : "\033[34m",
+    "magenta" : "\033[35m",
+    "cyan" : "\033[36m",
+    "white" : "\033[37m",
+    // foreground colors BRIGHT
+    "bright_black" : "\033[90m",
+    "bright_red" : "\033[91m",
+    "bright_green" : "\033[92m",
+    "bright_yellow" : "\033[93m",
+    "bright_blue" : "\033[94m",
+    "bright_magenta" : "\033[95m",
+    "bright_cyan" : "\033[96m",
+    "bright_white" : "\033[97m",
+    // background colors STANDARD
+    "bg_black" : "\033[40m",
+    "bg_red" : "\033[41m",
+    "bg_green" : "\033[42m",
+    "bg_yellow" : "\033[43m",
+    "bg_blue" : "\033[44m",
+    "bg_magenta" : "\033[45m",
+    "bg_cyan" : "\033[46m",
+    "bg_white" : "\033[47m",
+     // background colors BRIGHT
+     "bright_bg_black" : "\033[100m",
+     "bright_bg_red" : "\033[101m",
+     "bright_bg_green" : "\033[102m",
+     "bright_bg_yellow" : "\033[103m",
+     "bright_bg_blue" : "\033[104m",
+     "bright_bg_magenta" : "\033[105m",
+     "bright_bg_cyan" : "\033[106m",
+     "bright_bg_white" : "\033[107m"
+  }
+
+
+module.exports =  {
+      store: '',
+      black : function(str) {return colors['black'] + str + colors['reset']},
+      red : function(str) {return colors['red'] + str + colors['reset']},
+      green : function(str) {return colors['green'] + str + colors['reset']},
+      yellow : function(str) {return colors['yellow'] + str + colors['reset']},
+      blue : function(str) {return colors['blue'] + str + colors['reset']},
+      magenta : function(str) {return colors['magenta'] + str + colors['reset']},
+      cyan : function(str) {return colors['cyan'] + str + colors['reset']},
+      white : function(str) {return colors['white'] + str + colors['reset']},
+      //shorthand Foreground STANDARD
+      k : function(str) {this.store += colors['black'] + str + colors['reset'] 
+                        return this},
+      r : function(str) {this.store += colors['red'] + str + colors['reset'] 
+                        return this},
+      g : function(str) {this.store += colors['green'] + str + colors['reset'] 
+                        return this},
+      y : function(str) {this.store += colors['yellow'] + str + colors['reset']
+                        return this},
+      b : function(str) {this.store += colors['blue'] + str + colors['reset'] 
+                        return this},
+      m : function(str) {this.store += colors['magenta'] + str + colors['reset'] 
+                        return this},
+      c : function(str) {this.store += colors['cyan'] + str + colors['reset'] 
+                        return this},
+      w : function(str) {this.store += colors['white'] + str + colors['reset'] 
+                        return this },
+      //shorthand Foreground BRIGHT
+      bk : function(str) {this.store += colors['bright_black'] + str + colors['reset'] 
+                        return this},
+      br : function(str) {this.store += colors['bright_red'] + str + colors['reset'] 
+                        return this},
+      bg : function(str) {this.store += colors['bright_green'] + str + colors['reset'] 
+                        return this},
+      by : function(str) {this.store += colors['bright_yellow'] + str + colors['reset']
+                        return this},
+      bb : function(str) {this.store += colors['bright_blue'] + str + colors['reset'] 
+                        return this},
+      bm : function(str) {this.store += colors['bright_magenta'] + str + colors['reset'] 
+                        return this},
+      bc : function(str) {this.store += colors['bright_cyan'] + str + colors['reset'] 
+                        return this},
+      bw : function(str) {this.store += colors['bright_white'] + str + colors['reset'] 
+                        return this },                        
+      //shorthand Background STANDARD
+      K : function(str) {this.store += colors['bg_black'] 
+                        return this},
+      R : function(str) {this.store += colors['bg_red'] 
+                        return this},
+      G : function(str) {this.store += colors['bg_green'] 
+                        return this},
+      Y : function(str) {this.store += colors['bg_yellow'] 
+                        return this},
+      B : function(str) {this.store += colors['bg_blue'] 
+                        return this},
+      M : function(str) {this.store += colors['bg_magenta']
+                        return this},
+      C : function(str) {this.store += colors['bg_cyan']
+                        return this},
+      W : function(str) {this.store += colors['bg_white']
+                        return this },
+      //shorthand Background BRIGHT
+      BB : function(str) {this.store += colors['bright_bg_black'] 
+                        return this},
+      BR : function(str) {this.store += colors['bright_bg_red'] 
+                        return this},
+      BG : function(str) {this.store += colors['bright_bg_green'] 
+                        return this},
+      BY : function(str) {this.store += colors['bright_bg_yellow'] 
+                        return this},
+      BB : function(str) {this.store += colors['bright_bg_blue'] 
+                        return this},
+      BM : function(str) {this.store += colors['bright_bg_magenta']
+                        return this},
+      BC : function(str) {this.store += colors['bright_bg_cyan']
+                        return this},
+      BW : function(str) {this.store += colors['bright_bg_white']
+                        return this },                        
+       //styles
+      V : function() {this.store += colors['inverse']
+                        return this},
+      _ : function() {this.store += colors['underline']
+                        return this},
+      reset : function() {this.store += colors['reset']
+                        return this},
+      I : function() {this.store += colors['intense']
+                        return this},
+      blk : function() {this.store += colors['slow_blink']
+                        return this},
+      rblk : function() {this.store += colors['rapid_blink']
+                        return this},                                       
+      end: function(){
+                      result = this.store 
+                      //reset store
+                       this.store='' 
+                       return result
+      }
   }

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "8colors",
-  "version": "1.0.0",
-  "description": "ANSI Colors for the terminal console",
+  "version": "1.0.2",
+  "description": "chainable ansi 8 terminal colors",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jmdisuanco/8colors.git"
+  },
   "keywords": [
-    "ansi",
-    "colors",
-    "eight",
     "8colors",
+    "terminal",
     "console",
+    "chainable",
+    "ansi",
+    "colors",
     "log",
     "cli",
     "color",
@@ -19,5 +24,14 @@
     "console.log"
   ],
   "author": "John Martin R. Disuanco",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jmdisuanco/8colors/issues"
+  },
+  "homepage": "https://github.com/jmdisuanco/8colors#readme",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "types": "index.d.ts"
+}

package/.npmignore

@@ -1,59 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-

package/example.js

@@ -1,17 +0,0 @@
-const c = require('./index')
-
-var title ='WARNING'
-
-//straight up 
-console.log(c.green('color me green'))
-
-console.log(c.red(title))
-
-//chaining
-console.log (c.b('color me blue').m(' and I am Magenta').bm(' I am bright Magenta').end())
-
-//background color
-console.log(c.R().w(title).end())
-
-console.log(c.R().w(title).by(' You are using and awesome library!').end())
-