ECN>> tools-kit>> 返回
项目作者： BlackB1RD-Development

项目描述 ：
An easy to use, powerful and multi-functionality tools-kit library for NodeJS written entirely in JavaScript.
高级语言： JavaScript
项目地址: git://github.com/BlackB1RD-Development/tools-kit.git
创建时间： 2019-04-15T16:10:38Z
项目社区：https://github.com/BlackB1RD-Development/tools-kit
开源协议：MIT License
下载



Tools-Kit Logo


An easy to use, powerful and multi-functionality tools-kit library for NodeJS written entirely in JavaScript.





npm


release


downloads


node


license


Coverage Status


Build





Code Style








© Tools-Kit By BlackB1RD-Development (Author: @RealBlackB1RD). All rights reserved ©

Features

  • A Hastebin Client that can post and fetch code easily from Hastebin.
  • A Logger Manager that can log a styled and colored text into the console.
  • A Styles Manager that can transfer your simple text into a styled and modern one.
  • A collection of easy to use and useful functions.
  • Extremely configurable and debuggable.
  • Well documented.

Install

NPM Through GitHub

  1. npm install BlackB1RD-Development/tools-kit --save

NPM

  1. npm install tools-kit --save

Yarn

  1. yarn add tools-kit

Documentations

Read the Documentations for more information about each method.

Table of Content

Click to jump between class examples

Class Name Class Description
Hastebin Client Post and fetch code easily from Hastebin
Logger Manager Log a styled and colored text into the console
Styles Manager Transfer your simple text into a styled and modern one (Console support only)
Utilities A collection of easy to use and useful functions

Hastebin Client

With the Hastebin Client you can post and fetch code easily from Hastebin.

  1. const { logger, hastebin } = require('tools-kit');
  3. hastebin.post('var test = \'test\';\n\nconsole.log(test);', '.js')
  4.   .then(async postRes => {
  5.     logger.success({ tag: 'POST RES' }, postRes);
  6.     // Console > [20/02/2020 - 00:00:00 | POST RES]: HastebinObject{}
  8.     await hastebin.get(postRes.link)
  9.       .then(getRes => {
  10.         logger.success({ tag: 'GET RES' }, getRes);
  11.         // Console > [20/02/2020 - 00:00:00 | GET RES]: HastebinObject{}
  12.       })
  13.       .catch(getErr => {
  14.         logger.error({ tag: 'GET ERROR' }, getErr);
  15.         // Console > [20/02/2020 - 00:00:00 | GET ERROR]: Error: Get Error
  16.       });
  17.   })
  18.   .catch(postErr => {
  19.     logger.error({ tag: 'POST ERROR' }, postErr);
  20.     // Console > [20/02/2020 - 00:00:00 | POST ERROR]: Error: Post Error
  21.   });

Logger Manager

With the Logger Manager you can log a styled and colored text into the console with pre made logging settings in each method.

  1. const { logger } = require('tools-kit');
  3. logger.log('content');
  4. // Console > [20/02/2020 - 00:00:00 | LOG]: content
  6. logger.important('Important log');
  7. // Console > [20/02/2020 - 00:00:00 | IMPORTANT]: Important log
  9. logger.success('Success log');
  10. // Console > [20/02/2020 - 00:00:00 | SUCCESS]: Success log
  12. logger.fatal('Fatal log');
  13. // Console > [20/02/2020 - 00:00:00 | FATAL]: Fatal log
  15. logger.trace('Trace log');
  16. // Console > [20/02/2020 - 00:00:00 | TRACE]: Trace log
  18. logger.error('Error log');
  19. // Console > [20/02/2020 - 00:00:00 | ERROR]: Error log
  21. logger.debug('Debug log');
  22. // Console > [20/02/2020 - 00:00:00 | DEBUG]: Debugging log
  24. logger.info('Information log');
  25. // Console > [20/02/2020 - 00:00:00 | INFO]: Information log
  27. logger.warn('Warning log');
  28. // Console > [20/02/2020 - 00:00:00 | WARN]: Warning log
  30. logger.figlet('FIGLET', 'LOG');
  31. /*
  32.   Console > [20/02/2020 - 00:00:00 | FIGLET]:   _____ ___ ____ _     _____ _____   _     ___   ____
  33.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  |  ___|_ _/ ___| |   | ____|_   _| | |   / _ \ / ___|
  34.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | |_   | | |  _| |   |  _|   | |   | |  | | | | |  _
  35.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  |  _|  | | |_| | |___| |___  | |   | |__| |_| | |_| |
  36.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  |_|   |___\____|_____|_____| |_|   |_____\___/ \____|
  37.   Console > [20/02/2020 - 00:00:00 | FIGLET]:
  38. */

Using custom options:

  1. const { logger } = require('tools-kit');
  3. // Support custom logging options and rewriting of existing methods settings
  4. const scsSettings = {
  5.     time: 'H:mm',
  6.     tag: 'PUBLISH SUCCESS',
  7.     format: (options) => {
  8.       return `[${options.tag}]: Published ${options.content} successfully at ${options.time}`;
  9.     }
  10.   }, errSettings = {
  11.     time: 'H:mm',
  12.     tag: 'PUBLISH ERROR',
  13.     format: (options) => {
  14.       return `[${options.tag}]: Couldn't publish ${options.content} at ${options.time}`;
  15.     }
  16.   }, settings = {
  17.     tag: 'PUBLISH API',
  18.     format: (options) => {
  19.       return `[${options.tag}]: Publish API ${options.content} | Last Check: ${options.time}`;
  20.     }
  21.   }, figSettings = {
  22.     figlet: {
  23.       font: 'Ghost',
  24.       verticalLayout: 'default',
  25.       horizontalLayout: 'default'
  26.     },
  27.     log: {
  28.       name: 'figlet',
  29.       options: {
  30.         background: 'black',
  31.         color: 'red',
  32.         style: 'bold',
  33.         type: 'log',
  34.         time: 'MM/DD/YY',
  35.         tag: true,
  36.         format: (options) => {
  37.           return !options.time && !options.tag ? options.content : !options.time ? `[${options.tag}]: ${options.content}` : !options.tag ? `[${options.time}]: ${options.content}` : `[${options.time} | ${options.tag}]: ${options.content}`;
  38.         }
  39.       }
  40.     }
  41.   }, image = {
  42.     name: 'logo.png',
  43.     size: '5MB'
  44.   }, api = {
  45.     message: 'Internal Server Error',
  46.     code: '500'
  47.   };
  49. logger.success(scsSettings, 'image named "%s" with a total size of %s', image.name, image.size);
  50. // Console > [PUBLISH SUCCESS]: Published image named "logo.png" with a total size of 5MB successfully at 20:00
  52. logger.error(errSettings, 'image named "%s" with a total size of %s', image.name, image.size);
  53. // Console > [PUBLISH ERROR]: Couldn't publish image named "logo.png" with a total size of 5MB at 20:00
  55. logger.info(settings, 'respond with %s status code and "%s" message', api.code, api.message);
  56. // Console > [PUBLISH API]: Publish API respond with 500 status code and "Internal Server Error" message | Last Check: 20/2/2020 - 20:00:00
  58. logger.log({ time: false }, 'log', 'no time');
  59. // Console > [LOG]: log no time
  61. logger.figlet(figSettings, 'Boo');
  62. /*
  63.   Console > [20/02/2020 - 00:00:00 | FIGLET]: .-. .-')
  64.   Console > [20/02/2020 - 00:00:00 | FIGLET]: \  ( OO )
  65.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  ;-----.\  .-'),-----.  .-'),-----.
  66.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | .-.  | ( OO'  .-.  '( OO'  .-.  '
  67.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | '-' /_)/   |  | |  |/   |  | |  |
  68.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | .-. `. \_) |  |\|  |\_) |  |\|  |
  69.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | |  \  |  \ |  | |  |  \ |  | |  |
  70.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  | '--'  /   `'  '-'  '   `'  '-'  '
  71.   Console > [20/02/2020 - 00:00:00 | FIGLET]:  `------'      `-----'      `-----'
  72. */
  74. logger.log({ time: 'MM-DD-YY' }, 'log', 'custom time format');
  75. // Console > [02-20-2020 | LOG]: log custom time format
  77. logger.log({ tag: false }, 'log', 'no tag');
  78. // Console > [20/02/2020 - 00:00:00]: log no tag
  80. logger.log({ tag: 'CUSTOM TAG' }, 'log', 'custom tag');
  81. // Console > [20/02/2020 - 00:00:00 | CUSTOM TAG]: log custom tag
  83. logger.log({ time: false, tag: false }, 'log', 'no tag', 'no time');
  84. // Console > log no tag no time
  86. logger // Support chain logging
  87.   .log({ tag: 'FIRST LOG' }, 'First content')
  88.   .log({ tag: 'SECOND LOG' }, 'Second content')
  89.   .log({ tag: 'THIRD LOG' }, 'Third content');
  90. /*
  91.   Console > [20/02/2020 - 00:00:00 | FIRST LOG]: First content
  92.   Console > [20/02/2020 - 00:00:00 | SECOND LOG]: Second content
  93.   Console > [20/02/2020 - 00:00:00 | THIRD LOG]: Third content
  94. */

See more backgrounds, colors, styles & consoles types by clicking here

Styles Manager

With the Styles Manager you can transfer your simple text into a styled and modern one.

  1. const { logger, style } = require('tools-kit');
  3. logger.log({ tag: 'STYLE' },
  4.   styles.bgGreen('testing %s', 'background'),
  5.   styles.red('testing %s', 'color'),
  6.   styles.underline('testing %s', 'style'),
  7.   styles.bgGreen.red.underline('testing %s', 'a style chain')
  8. );
  9. // Console > [20/02/2020 - 00:00:00 | STYLE]: testing background testing color testing style testing a style chain
  11. logger.log({ tag: 'STYLE OBJECT' }, styles.stylify({ background: 'bgGreen' }, 'styled background'), 'normal background');
  12. // Console > [20/02/2020 - 00:00:00 | STYLE OBJECT]: styled background normal background
  14. logger.log({ tag: 'STYLE OBJECT' }, styles.stylify({ color: 'red' }, 'styled color'), 'normal color');
  15. // Console > [20/02/2020 - 00:00:00 | STYLE OBJECT]: styled color normal color
  17. logger.log({ tag: 'STYLE OBJECT' }, styles.stylify({ style: 'underline' }, 'styled style'), 'normal style');
  18. // Console > [20/02/2020 - 00:00:00 | STYLE OBJECT]: styled style normal style
  20. logger.log({ tag: 'STYLE OBJECT' }, styles.stylify({ background: 'bgGreen', color: 'red', style: 'underline' }, 'styled text'), 'normal text');
  21. // Console > [20/02/2020 - 00:00:00 | STYLE OBJECT]: styled text normal text
  23. logger.log({ tag: 'STYLE METHOD' }, styles.background('bgGreen', 'styled background'), 'normal style');
  24. // Console > [20/02/2020 - 00:00:00 | STYLE METHOD]: styled background normal style
  26. logger.log({ tag: 'STYLE METHOD' }, styles.color('red', 'styled color'), 'normal style');
  27. // Console > [20/02/2020 - 00:00:00 | STYLE METHOD]: styled color normal style
  29. logger.log({ tag: 'STYLE METHOD' }, styles.style('underline', 'styled style'), 'normal style');
  30. // Console > [20/02/2020 - 00:00:00 | STYLE METHOD]: styled style normal style
  32. logger.log({ tag: 'STYLE METHOD' }, styles.bgGreen.red.underline('styled text'), 'normal text');
  33. // Console > [20/02/2020 - 00:00:00 | STYLE METHOD]: styled text normal text
  35. const colors = [
  36.   styles.rgb([255, 0, 0]),
  37.   styles.hex('#ffff00'),
  38.   styles.hsv([180, 100, 100]),
  39.   styles.hsl([120, 100, 50]),
  40.   styles.hwb([240, 0, 0]),
  41.   styles.lab([35, 80, -104]),
  42.   styles.xyz([59, 28, 97]),
  43.   styles.lch([88, 90, 149]),
  44.   styles.cmyk([100, 50, 0, 0]),
  45.   styles.ansi16(12),
  46.   styles.ansi256(250),
  47.   styles.keyword('DeepSkyBlue')
  48. ];
  50. logger.log({ tag: 'CUSTOM MAP' }, styles.map('custom map styled-text', colors), 'normal text');
  51. // Console > [20/02/2020 - 00:00:00 | CUSTOM MAP]: custom map styled-text normal text

Using pre-made cool colors maps:

  1. const { logger, color } = require('tools-kit');
  3. logger.log({ tag: 'RAINBOW' }, styles.rainbow('rainbow styled-text'), 'normal text');
  4. // Console > [20/02/2020 - 00:00:00 | RAINBOW]: rainbow styled-text normal text
  6. logger.log({ tag: 'RANDOM' }, styles.random('random styled-text'), 'normal text');
  7. // Console > [20/02/2020 - 00:00:00 | RANDOM]: random styled-text normal text
  9. logger.log({ tag: 'ZEBRA' }, styles.zebra('zebra styled-text'), 'normal text');
  10. // Console > [20/02/2020 - 00:00:00 | ZEBRA]: zebra styled-text normal text

Utilities

With Tools-Kit Utilities you can use the functions that everyone uses in one simple line.

  1. const { logger, util } = require('tools-kit');
  3. logger.log({ tag: 'HAS?' }, util.has({}, 'name'));
  4. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  6. logger.log({ tag: 'HAS?' }, util.has([], 'name'));
  7. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  9. logger.log({ tag: 'HAS?' }, util.has({ name: 'test' }, 'name'));
  10. // Console > [20/02/2020 - 00:00:00 | HAS?]: true
  12. logger.log({ tag: 'HAS?' }, util.has({ name: 'test' }, 'test'));
  13. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  15. logger.log({ tag: 'HAS?' }, util.has({ name: 'test' }, 'name', 'test'));
  16. // Console > [20/02/2020 - 00:00:00 | HAS?]: true
  18. logger.log({ tag: 'HAS?' }, util.has({ name: 'test' }, 'name', 'not test'));
  19. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  21. logger.log({ tag: 'HAS?' }, util.has(['name', 'test'], 'name'));
  22. // Console > [20/02/2020 - 00:00:00 | HAS?]: true
  24. logger.log({ tag: 'HAS?' }, util.has(['test', 'not test'], 'name'));
  25. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  27. logger.log({ tag: 'HAS?' }, util.has([{ 'name': 'not test' }, { 'name': 'test' }], 'name'));
  28. // Console > [20/02/2020 - 00:00:00 | HAS?]: true
  30. logger.log({ tag: 'HAS?' }, util.has([{ 'name': 'not test' }, { 'name': 'test' }], 'test', 'name'));
  31. // Console > [20/02/2020 - 00:00:00 | HAS?]: false
  33. logger.log({ tag: 'HAS?' }, util.has([{ 'name': 'not test' }, { 'name': 'test' }], 'name', 'test'));
  34. // Console > [20/02/2020 - 00:00:00 | HAS?]: true
  36. logger.log({ tag: 'ARRAY?' }, util.isArray(new Array()));
  37. // Console > [20/02/2020 - 00:00:00 | ARRAY?]: true
  39. logger.log({ tag: 'ARRAY?' }, util.isArray(new Object()));
  40. // Console > [20/02/2020 - 00:00:00 | ARRAY?]: false
  42. logger.log({ tag: 'ARRAY?' }, util.isArray([]));
  43. // Console > [20/02/2020 - 00:00:00 | ARRAY?]: true
  45. logger.log({ tag: 'ARRAY?' }, util.isArray({}));
  46. // Console > [20/02/2020 - 00:00:00 | ARRAY?]: false
  48. logger.log({ tag: 'OBJECT?' }, util.isObject(new Object()));
  49. // Console > [20/02/2020 - 00:00:00 | OBJECT?]: true
  51. logger.log({ tag: 'OBJECT?' }, util.isObject(new Array()));
  52. // Console > [20/02/2020 - 00:00:00 | OBJECT?]: false
  54. logger.log({ tag: 'OBJECT?' }, util.isObject({}));
  55. // Console > [20/02/2020 - 00:00:00 | OBJECT?]: true
  57. logger.log({ tag: 'OBJECT?' }, util.isObject([]));
  58. // Console > [20/02/2020 - 00:00:00 | OBJECT?]: false
  60. logger.log({ tag: 'RANDOM ITEM' }, util.randomItem(['cat', 'dog', 'fish']));
  61. // Console > [20/02/2020 - 00:00:00 | RANDOM ITEM]: fish
  63. logger.log({ tag: 'RANDOM NUMBER' }, util.randomNumber(5, 10));
  64. // Console > [20/02/2020 - 00:00:00 | RANDOM NUMBER]: 8
  66. logger.log({ tag: 'RANDOM NUMBER' }, util.randomNumber(5, 10, false)); // Default is true
  67. // Console > [20/02/2020 - 00:00:00 | RANDOM NUMBER]: 9.478004123859458

Logger Options

options.background

  • bgBlack
  • bgGray
  • bgGrey
  • bgRed
  • bgGreen
  • bgYellow
  • bgBlue
  • bgMagenta
  • bgCyan
  • bgWhite

Light Backgrounds

  • bgLBlack
  • bgLRed
  • bgLGreen
  • bgLYellow
  • bgLBlue
  • bgLMagenta
  • bgLCyan
  • bgLWhite

Bright Backgrounds

  • bgBGray
  • bgBGrey
  • bgBRed
  • bgBGreen
  • bgBYellow
  • bgBBlue
  • bgBMagenta
  • bgBCyan
  • bgBWhite

options.colors

  • black
  • gray
  • grey
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white

Light Colors

  • lblack
  • lred
  • lgreen
  • lyellow
  • lblue
  • lmagenta
  • lcyan
  • lwhite

Bright Colors

  • bgray
  • bgrey
  • bred
  • bgreen
  • byellow
  • bblue
  • bmagenta
  • bcyan
  • bwhite

options.style

  • reset - Resets the current color to the default console color.
  • bold - Make the text bold.
  • dim - Emitting only a small amount of the text light.
  • italic - Make the text italic styled - Not widely supported
  • underline - Make the text underline styled - Not widely supported
  • inverse- Inverse the background and the foreground colors.
  • hidden - Prints the text, but makes it invisible.
  • strikethrough - Puts a horizontal line through the center of the text - Not widely supported

options.type

  • log - Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).
  • error - Prints to stderr with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).
  • trace - Prints to stderr the string ‘Trace: ‘, followed by the util.format() formatted message and stack trace to the current position in the code.
  • debug- The console.debug() function is an alias for console.log().
  • info - The console.info() function is an alias for console.log().
  • warn - The console.warn() function is an alias for console.error().

options.time

The options.time can be either of this two

  • Boolean (true/false) - If to include the current time and date with the stock format when logging (Stock used moment format: DD/M/YYYY - H:mm:ss)
  • String - A custom moment time format to use when logging

options.tag

The options.tag can be either of this two

  • Boolean (true/false) - If to include the a tag when logging
  • String - A custom string value to use as a tag when logging (Case sensitive)

Author

Maintainers

See also the list of contributors who participated in this project.

Changelog

See the Changes Log for more information about each update.

License

FOSSA Status

Related Modules

  • supports-color — Detect whether a terminal supports color.
  • color-convert — Plain color conversion functions.
  • node-fetch — A light-weight module that brings window.fetch to Node.js.
  • moment — A lightweight JavaScript date library for parsing, validating, manipulating, and formatting dates.
  • figlet — Creates ASCII Art from text. A full implementation of the FIGfont spec.