anser - npm Package Compare versions

Comparing version 1.4.9 to 1.4.10

package.json

 {
   "name": "anser",
-  "version": "1.4.9",
+  "version": "1.4.10",
   "description": "A low level parser for ANSI sequences.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -0,1 +1,2 @@
+<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
@@ -18,13 +19,51 @@
 
+
 # anser
 
-A low level parser for ANSI sequences.
+ [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Travis](https://img.shields.io/travis/IonicaBizau/anser.svg)](https://travis-ci.org/IonicaBizau/anser/) [![Version](https://img.shields.io/npm/v/anser.svg)](https://www.npmjs.com/package/anser) [![Downloads](https://img.shields.io/npm/dt/anser.svg)](https://www.npmjs.com/package/anser) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
 
+<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
 
 
 
-## Installation
 
+
+
+
+> A low level parser for ANSI sequences.
+
+
+
+
+
+
+## :rocket: Features
+
+
+ - Converts text containing [ANSI color escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors) into equivalent HTML elements.
+ - Allows converting the input into JSON output.
+ - HTML escaping
+ - Converts links into HTML elements
+ - Friendly APIs to use with  virtual dom libraries
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :cloud: Installation
+
 ```sh
-$ npm i anser
+# Using npm
+npm install --save anser
+
+# Using yarn
+yarn add anser
 ```
@@ -40,3 +79,2 @@
 
-## Example
 
@@ -46,7 +84,7 @@
 
+## :clipboard: Example
 
 
+
 ```js
-"use strict";
-
 const Anser = require("anser");
@@ -108,3 +146,15 @@
 //     isEmpty: [Function: isEmpty] } ]
+```
 
+
+
+
+
+
+When using **TypeScript** you can do the following:
+```ts
+import * as Anser from 'anser';
+const txt = "\u001b[38;5;196mHello\u001b[39m \u001b[48;5;226mWorld\u001b[49m";
+console.log(Anser.ansiToHtml(txt));
+// <span style="color:rgb(255, 0, 0)">Hello</span> <span style="background-color:rgb(255, 255, 0)">World</span>
 ```
@@ -117,8 +167,20 @@
 
-## Documentation
 
+## :question: Get Help
 
+There are few ways to get help:
 
 
 
+ 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
+ 2. For bug reports and feature requests, open issues. :bug:
+ 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+
+
+
+
+
+## :memo: Documentation
+
+
 ### `Anser.escapeForHtml(txt)`
@@ -132,2 +194,3 @@ Escape the input HTML.
 #### Params
+
 - **String** `txt`: The input text (containing the ANSI snippets).
@@ -147,2 +210,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -171,2 +235,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -182,2 +247,3 @@ - **Object** `options`: The options passed to the ansiToHTML method.
 #### Params
+
 - **String** `txt`: The input text.
@@ -193,2 +259,3 @@ - **Object** `options`: The options passed to the ansiToHTML method.
 #### Params
+
 - **String** `txt`: The input text.
@@ -212,2 +279,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -222,2 +290,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -232,2 +301,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -243,2 +313,3 @@ - **Object** `options`: The options passed ot the `process` method.
 #### Params
+
 - **String** `txt`: The input text.
@@ -254,2 +325,3 @@ - **Object** `options`: The options passed ot the `process` method.
 #### Params
+
 - **String** `txt`: The input text.
@@ -264,2 +336,3 @@
 #### Params
+
 - **String** `txt`: The input text.
@@ -275,2 +348,3 @@ - **Object** `options`: An object passed to `processChunk` method, extended with:
 #### Params
+
 - **String** `text`: The input text.
@@ -297,2 +371,3 @@ - **Object** `options`: An object containing the following fields:
 #### Params
+
 - **String** `text`: The input text.
@@ -312,13 +387,137 @@ - **Object** `options`: An object containing the following fields:
 
-## How to contribute
+
+
+
+
+
+
+
+
+## :yum: How to contribute
 Have an idea? Found a bug? See [how to contribute][contributing].
 
 
+## :sparkling_heart: Support my projects
+I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
+this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
 
-## License
-See the [LICENSE][license] file.
+However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
 
 
+ - Starring and sharing the projects you like :rocket:
+ - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
+ - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
+ - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
+ - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
+
+    ![](https://i.imgur.com/z6OQI95.png)
+
+
+Thanks! :heart:
+
+
+
+
+
+
+
+
+
+## :cake: Thanks
+This project is highly based on [`ansi_up`](https://github.com/drudru/ansi_up), by [@drudru](https://github.com/drudru/). Thanks! :cake:
+
+
+
+
+
+
+
+
+## :dizzy: Where is this library used?
+If you are using this library in one of your projects, add it in this list. :sparkles:
+
+ - `react-native`
+ - `ansi-to-react`
+ - `mesh-devtool`
+ - `nuclide-commons-ui`
+ - `@next/react-dev-overlay`
+ - `transformime`
+ - `@viankakrisna/react-dev-utils`
+ - `react-webpack-build-helper`
+ - `redux-devtools-trace-monitor`
+ - `timer-react-dev-utils`
+ - `react-dev-utils-extra`
+ - `ansi-html-themed`
+ - `uyun-react-dev-utils`
+ - `react-dev-utils-sebfl-update`
+ - `@jjavery/react-error-overlay`
+ - `lambda-dev-utils`
+ - `react-error-overlay-canary`
+ - `@axio/react-dev-utils`
+ - `react-error-overlay-dangerous`
+ - `@classflow/react-dev-utils`
+ - `ansi-to-json`
+ - `nuclide`
+ - `react-native-okhttp-fork`
+ - `@devpodio/console`
+ - `ipynb2html`
+ - `webpack-isomorphic-dev-middleware`
+ - `@theia/console`
+ - `stack-frame-overlay`
+ - `cycle-dev-utils`
+ - `@viankakrisna/react-error-overlay`
+ - `callstack-task-react-error-overlay`
+ - `callstack-task-react-dev-utils`
+ - `ansi-to-react-with-options`
+ - `@plansys/react-dev-utils`
+ - `zc-react-dev-utils`
+ - `@ehyland-org/react-error-overlay`
+ - `react-dev-utils-custom-hmr`
+ - `ansi-to-react-with-classes`
+ - `linklog`
+ - `@naze/error`
+ - `react-error-guard`
+ - `singularityui-tailer`
+ - `@unforgiven/react-native`
+ - `react-ansi`
+ - `@digibear/socket-bridge`
+ - `ada-pack`
+ - `react-native-hlf-wrapper`
+ - `webpack-universal-compiler`
+ - `@prague-digi/react-error-overlay`
+ - `kunai`
+ - `@apardellass/react-native-audio-stream`
+ - `react-native-tvos`
+ - `react-native-plugpag-wrapper`
+ - `@codewars/jest-reporter`
+
+
+
+
+
+
+
+
+
+
+
+## :scroll: License
+
+[MIT][license] © [Ionică Bizău][website]
+
+
+
+
+
+
 [license]: /LICENSE
+[website]: https://ionicabizau.net
 [contributing]: /CONTRIBUTING.md
 [docs]: /DOCUMENTATION.md
+[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
+[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
+[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
+[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
+[patreon]: https://www.patreon.com/ionicabizau
+[amazon]: http://amzn.eu/hRo9sIZ
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

45952

increased by13.96%

Number of lines in readme file

505

increased by65.03%

No dependency changes