{"_id":"node-ansiparser","_rev":"2796243","name":"node-ansiparser","description":"A parser for ANSI escape codes.","dist-tags":{"latest":"2.2.0"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"time":{"modified":"2022-07-12T09:45:27.000Z","created":"2014-12-22T04:50:37.795Z","2.2.0":"2016-07-12T03:09:00.359Z","2.1.0":"2015-11-19T18:05:28.027Z","2.0.2":"2015-08-07T22:53:30.221Z","2.0.1":"2015-08-07T18:18:12.689Z","2.0.0":"2015-08-06T14:13:19.729Z","2.0.0-beta":"2015-08-02T21:12:14.543Z","1.0.2":"2015-01-03T19:17:43.288Z","1.0.1":"2014-12-27T11:02:04.765Z","1.0.0":"2014-12-22T04:50:37.795Z"},"users":{},"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"versions":{"2.2.0":{"name":"node-ansiparser","version":"2.2.0","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal","escape sequence"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"chai":"^3.5.0","coveralls":"^2.11.9","istanbul":"^0.4.4","mocha":"^2.5.3","uglify-js":"^2.7.0"},"scripts":{"minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js","test":"node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"gitHead":"548ba7d39d0cc937d85ffdd2430424a4bff137df","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.2.0","_shasum":"b724d3e5e3fa5a854256bb63aceb091e720793ad","_from":".","_npmVersion":"2.15.8","_nodeVersion":"4.4.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"b724d3e5e3fa5a854256bb63aceb091e720793ad","size":11800,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.2.0.tgz"},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/node-ansiparser-2.2.0.tgz_1468292938605_0.21674698079004884"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:15.701Z","publish_time":1468292940359,"_cnpm_publish_time":1468292940359},"2.1.0":{"name":"node-ansiparser","version":"2.1.0","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal","escape sequence"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"uglify-js":"2.4.24","mocha":"2.2.5","chai":"3.2.0","istanbul":"0.3.17","coveralls":"2.11.3"},"scripts":{"minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js","test":"node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"gitHead":"06514884843c8b50ddb0b47e141d1fb2013c5c23","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.1.0","_shasum":"06ab9a170d70fb968f44c3cb11db3d1461d6b050","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"06ab9a170d70fb968f44c3cb11db3d1461d6b050","size":10943,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.1.0.tgz"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:14.827Z","publish_time":1447956328027,"_cnpm_publish_time":1447956328027},"2.0.2":{"name":"node-ansiparser","version":"2.0.2","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"uglify-js":"2.4.24","mocha":"2.2.5","chai":"3.2.0","istanbul":"0.3.17","coveralls":"2.11.3"},"scripts":{"minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js","test":"node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"gitHead":"b6f94acc173971b336bc825facae0a48c39baa3c","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.0.2","_shasum":"addf52f3c638b594670b64dff9d55d15c596a9ae","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"addf52f3c638b594670b64dff9d55d15c596a9ae","size":29950,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.0.2.tgz"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:13.980Z","publish_time":1438988010221,"_cnpm_publish_time":1438988010221},"2.0.1":{"name":"node-ansiparser","version":"2.0.1","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"uglify-js":"2.4.24","mocha":"latest","chai":"3.2.0","istanbul":"0.3.17","coveralls":"2.11.3"},"scripts":{"minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js","test":"node_modules/istanbul/lib/cli.js cover node_modules/mocha/bin/_mocha -- -R spec","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"gitHead":"3c0046ae7cf3951ef4e12f2c9ec27e0711c3b16d","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.0.1","_shasum":"cb826f4f7b2a393f05f24e61c58ea833629f1d6d","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"cb826f4f7b2a393f05f24e61c58ea833629f1d6d","size":29510,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.0.1.tgz"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:12.931Z","publish_time":1438971492689,"_cnpm_publish_time":1438971492689},"2.0.0":{"name":"node-ansiparser","version":"2.0.0","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"uglify-js":"2.4.24","mocha":"latest","chai":"3.2.0"},"scripts":{"test":"mocha test","minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js"},"gitHead":"f28a196c62dd6a7e4673424d45e0b63d84be32d5","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.0.0","_shasum":"6b90da8be826c0aa2879a0bd7f51438f023edb39","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"6b90da8be826c0aa2879a0bd7f51438f023edb39","size":9059,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.0.0.tgz"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:11.857Z","publish_time":1438870399729,"_cnpm_publish_time":1438870399729},"2.0.0-beta":{"name":"node-ansiparser","version":"2.0.0-beta","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"uglify-js":"2.4.24"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","minify":"node_modules/uglify-js/bin/uglifyjs --compress --mangle -- dist/ansiparser.js > dist/ansiparser.min.js"},"gitHead":"688aaac7c93706829327cd8f59bf843d82a5d282","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","_id":"node-ansiparser@2.0.0-beta","_shasum":"b706f723c02e38c97bbbc7c7809a05e03dc84665","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"dist":{"shasum":"b706f723c02e38c97bbbc7c7809a05e03dc84665","size":6152,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-2.0.0-beta.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-2.0.0-beta.tgz"},"directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:11.010Z","publish_time":1438549934543,"_cnpm_publish_time":1438549934543},"1.0.2":{"name":"node-ansiparser","version":"1.0.2","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"closurecompiler":"latest"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","minify":"ccjs ./dist/ansiparser.js --compilation_level=ADVANCED_OPTIMIZATIONS --language_in=ECMASCRIPT5_STRICT > ./dist/ansiparser.min.js"},"bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"_id":"node-ansiparser@1.0.2","dist":{"shasum":"1fa95f67b6fc028555861bd5829dcfa3f725cbb5","size":5844,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-1.0.2.tgz"},"_from":".","_npmVersion":"1.3.10","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"deprecated":"deprecated version, not maintained anymore","directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:10.156Z","publish_time":1420312663288,"_cnpm_publish_time":1420312663288},"1.0.1":{"name":"node-ansiparser","version":"1.0.1","description":"A parser for ANSI escape codes.","main":"dist/ansiparser.js","keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"https://github.com/netzkolchose/node-ansiparser.git"},"devDependencies":{"closurecompiler":"latest"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","minify":"ccjs ./dist/ansiparser.js --compilation_level=ADVANCED_OPTIMIZATIONS --language_in=ECMASCRIPT5_STRICT > ./dist/ansiparser.min.js"},"bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"_id":"node-ansiparser@1.0.1","dist":{"shasum":"f820883bddb413066617dcc6c89d92ce2acc544d","size":5945,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-1.0.1.tgz"},"_from":".","_npmVersion":"1.3.10","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"deprecated":"deprecated version, not maintained anymore","directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:09.287Z","publish_time":1419678124765,"_cnpm_publish_time":1419678124765},"1.0.0":{"name":"node-ansiparser","version":"1.0.0","description":"A parser for ANSI escape codes.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["ansi","parser","terminal"],"author":{"name":"Joerg Breitbart","email":"j.breitbart@netzkolchose.de"},"license":"MIT","repository":{"type":"git","url":"https://github.com/netzkolchose/node-ansiparser.git"},"bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"_id":"node-ansiparser@1.0.0","dist":{"shasum":"e921711f67e4d8d1da93621261ba1522339ba167","size":4313,"noattachment":false,"key":"/node-ansiparser/-/node-ansiparser-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-ansiparser/download/node-ansiparser-1.0.0.tgz"},"_from":".","_npmVersion":"1.3.10","_npmUser":{"name":"jerch","email":"j.breitbart@netzkolchose.de"},"maintainers":[{"name":"jerch","email":"j.breitbart@netzkolchose.de"}],"deprecated":"deprecated version, not maintained anymore","directories":{},"_cnpmcore_publish_time":"2021-12-21T01:37:08.419Z","publish_time":1419223837795,"_cnpm_publish_time":1419223837795}},"readme":"[![Build Status](https://travis-ci.org/netzkolchose/node-ansiparser.svg?branch=master)](https://travis-ci.org/netzkolchose/node-ansiparser)\n[![Coverage Status](https://coveralls.io/repos/netzkolchose/node-ansiparser/badge.svg?branch=master)](https://coveralls.io/r/netzkolchose/node-ansiparser?branch=master)\n\nA parser for ANSI escape code sequences. It implements the parser described here\nhttp://vt100.net/emu/dec_ansi_parser (thanks to Paul Williams).\n\n**NOTE ON UNICODE:** The parser works with unicode strings. High characters (any above 0x9f)\nare only allowed within the string consuming states GROUND (for print), OSC_STRING and DCS_PASSTHROUGH.\nAt any other state they will either be ignored (CSI_IGNORE and DCS_IGNORE)\nor cancel the active escape sequence. Although this doesn't follow any official specification\n(since I haven't found any) it seems to work with unicode terminal streams.\n\nThe parser uses callbacks to methods of a given terminal object.\nMethods a terminal should implement:\n\n* inst_p(s)                         *print string s*\n* inst_o(s)                         *osc call*\n* inst_x(flag)                      *trigger one char method*\n* inst_c(collected, params, flag)   *trigger csi method*\n* inst_e(collected, flag)           *trigger esc method*\n* inst_H(collected, params, flag)   *dcs command (hook)*\n* inst_P(data)                      *dcs put*\n* inst_U()                          *dcs unhook*\n\n**NOTE ON CALLBACK INVOCATIONS** All callbacks will be triggered as soon as the escape sequence\nis finished.\n\nThe callbacks `inst_o`, `inst_x`, `inst_c`, `inst_e`, `inst_H` and\n`int_U` are guaranteed to be finished. If a corresponding escape sequence is not\nfinished at the end of the parse input the parser will not trigger the callback until the\nsequence gets finished by later `.parse` calls.\n\n`inst_p` and `inst_P` are not guaranteed to be finished. They can occur multiple times in a row\nand they will always be triggered at the end of the parse input:\n\n* `inst_p`  - Since Javascript uses a variable multibyte encoding for high unicode characters\nthere is a small chance that the last character is part of a multibyte character\nand not directly printable, e.g. `parse('<high byte>'); parse('<low byte>');`. To handle\nit you will have to track this edge case in your terminal object.\n\n* `inst_P` - is part of the DCS subsystem and likely to contain arbitrary length data.\nTo handle this with the correct DCS subparser the terminal object has to respect\nthe dcs_hook via `inst_H` until dcs_unhook `inst_U` is called.\n\nAlthough the OSC subsystem is intended to work similar to the DCS subsystem the parser does not\nexpose the osc_start, osc_end and osc_put calls. The OSC use cases are well defined and\nthe data part is likely to be very short. Therefore the parser summarizes the OSC actions to\nonly one final OSC callback. OSC parsing itself is not covered by this parser.\n\nThere is an optional `inst_E(e)` callback to track parsing errors with `e` containing all internal\nparser states at error time. By returning a similar object from this callback \nyou can inject new values to the parsing process or abort it with `{abort:true}`.\nThe parser will fall to state 'GROUND' and continue with the next character\nif you don't return anything (default behavior).\n\n\n**NOTE:** If the terminal object doesn't provide the needed methods the parser\nwill inject dummy methods to keep working.\n\n\n## Methods\n\n* parse(s)  *parse the given string and call the terminal methods*\n* reset()   *reset the parser*\n\n\n## Usage example\nThis example uses a simple terminal object, which just logs the actions:\n```javascript\nvar AnsiParser = require('node-ansiparser');\n\nvar terminal = {\n    inst_p: function(s) {console.log('print', s);},\n    inst_o: function(s) {console.log('osc', s);},\n    inst_x: function(flag) {console.log('execute', flag.charCodeAt(0));},\n    inst_c: function(collected, params, flag) {console.log('csi', collected, params, flag);},\n    inst_e: function(collected, flag) {console.log('esc', collected, flag);},\n    inst_H: function(collected, params, flag) {console.log('dcs-Hook', collected, params, flag);},\n    inst_P: function(dcs) {console.log('dcs-Put', dcs);},\n    inst_U: function() {console.log('dcs-Unhook');}\n};\n\n\nvar parser = new AnsiParser(terminal);\nparser.parse('\\x1b[31mHello World!\\n');\nparser.parse('\\x1bP0!u%5\\x1b\\'');\n```\nFor a more complex terminal see [node-ansiterminal](https://github.com/netzkolchose/node-ansiterminal).\n\n\n## Parser Throughput\n\nThe parser has a throughput of 50 - 100 MB/s with my desktop computer.","_attachments":{},"homepage":"https://github.com/netzkolchose/node-ansiparser#readme","bugs":{"url":"https://github.com/netzkolchose/node-ansiparser/issues"},"license":"MIT"}