{"maintainers":[{"name":"sokra","email":"tobias.koppers@googlemail.com"}],"keywords":["parser","regexp"],"dist-tags":{"latest":"1.1.1"},"author":{"name":"Tobias Koppers @sokra"},"description":"A very simple and stupid parser, based on a statemachine and regular expressions.","readme":"# fastparse\r\n\r\nA very simple and stupid parser, based on a statemachine and regular expressions.\r\n\r\nIt's not intended for complex languages. It's intended to easily write a simple parser for a simple language.\r\n\r\n\r\n\r\n## Usage\r\n\r\nPass a description of statemachine to the constructor. The description must be in this form:\r\n\r\n``` javascript\r\nnew Parser(description)\r\n\r\ndescription is {\r\n\t// The key is the name of the state\r\n\t// The value is an object containing possible transitions\r\n\t\"state-name\": {\r\n\t\t// The key is a regular expression\r\n\t\t// If the regular expression matches the transition is executed\r\n\t\t// The value can be \"true\", a other state name or a function\r\n\r\n\t\t\"a\": true,\r\n\t\t// true will make the parser stay in the current state\r\n\t\t\r\n\t\t\"b\": \"other-state-name\",\r\n\t\t// a string will make the parser transit to a new state\r\n\t\t\r\n\t\t\"[cde]\": function(match, index, matchLength) {\r\n\t\t\t// \"match\" will be the matched string\r\n\t\t\t// \"index\" will be the position in the complete string\r\n\t\t\t// \"matchLength\" will be \"match.length\"\r\n\t\t\t\r\n\t\t\t// \"this\" will be the \"context\" passed to the \"parse\" method\"\r\n\t\t\t\r\n\t\t\t// A new state name (string) can be returned\r\n\t\t\treturn \"other-state-name\";\r\n\t\t},\r\n\t\t\r\n\t\t\"([0-9]+)(\\\\.[0-9]+)?\": function(match, first, second, index, matchLength) {\r\n\t\t\t// groups can be used in the regular expression\r\n\t\t\t// they will match to arguments \"first\", \"second\"\r\n\t\t},\r\n\t\t\r\n\t\t// the parser stops when it cannot match the string anymore\r\n\t\t\r\n\t\t// order of keys is the order in which regular expressions are matched\r\n\t\t// if the javascript runtime preserves the order of keys in an object\r\n\t\t// (this is not standardized, but it's a de-facto standard)\r\n\t}\r\n}\r\n```\r\n\r\nThe statemachine is compiled down to a single regular expression per state. So basically the parsing work is delegated to the (native) regular expression logic of the javascript runtime.\r\n\r\n\r\n``` javascript\r\nParser.prototype.parse(initialState: String, parsedString: String, context: Object)\r\n```\r\n\r\n`initialState`: state where the parser starts to parse.\r\n\r\n`parsedString`: the string which should be parsed.\r\n\r\n`context`: an object which can be used to save state and results. Available as `this` in transition functions.\r\n\r\nreturns `context`\r\n\r\n\r\n\r\n\r\n## Example\r\n\r\n``` javascript\r\nvar Parser = require(\"fastparse\");\r\n\r\n// A simple parser that extracts @licence ... from comments in a JS file\r\nvar parser = new Parser({\r\n\t// The \"source\" state\r\n\t\"source\": {\r\n\t\t// matches comment start\r\n\t\t\"/\\\\*\": \"comment\",\r\n\t\t\"//\": \"linecomment\",\r\n\t\t\r\n\t\t// this would be necessary for a complex language like JS\r\n\t\t// but omitted here for simplicity\r\n\t\t// \"\\\"\": \"string1\",\r\n\t\t// \"\\'\": \"string2\",\r\n\t\t// \"\\/\": \"regexp\"\r\n\t\t\r\n\t},\r\n\t// The \"comment\" state\r\n\t\"comment\": {\r\n\t\t\"\\\\*/\": \"source\",\r\n\t\t\"@licen[cs]e\\\\s((?:[^*\\n]|\\\\*+[^*/\\n])*)\": function(match, licenseText) {\r\n\t\t\tthis.licences.push(licenseText.trim());\r\n\t\t}\r\n\t},\r\n\t// The \"linecomment\" state\r\n\t\"linecomment\": {\r\n\t\t\"\\n\": \"source\",\r\n\t\t\"@licen[cs]e\\\\s(.*)\": function(match, licenseText) {\r\n\t\t\tthis.licences.push(licenseText.trim());\r\n\t\t}\r\n\t}\r\n});\r\n\r\nvar licences = parser.parse(\"source\", sourceCode, { licences: [] }).licences;\r\n\r\nconsole.log(licences);\r\n```\r\n\r\n\r\n\r\n## License\r\n\r\nMIT (http://www.opensource.org/licenses/mit-license.php)\r\n","repository":{"type":"git","url":"git+https://github.com/webpack/fastparse.git"},"users":{"arteffeckt":true},"bugs":{"url":"https://github.com/webpack/fastparse/issues"},"license":"MIT","versions":{"1.0.0":{"name":"fastparse","version":"1.0.0","description":"A very simple and stupid parser, based on a statemachine and regular expressions.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git@github.com:webpack/fastparse.git"},"keywords":["parser","regexp"],"author":{"name":"Tobias Koppers @sokra"},"license":"MIT","bugs":{"url":"https://github.com/webpack/fastparse/issues"},"homepage":"https://github.com/webpack/fastparse","_id":"fastparse@1.0.0","dist":{"shasum":"608dfee3ca4eb609b7b3fc36507418a51dd20a78","tarball":"http://nexus.dui88.com:8081/nexus/content/repositories/npm-registry/fastparse/-/fastparse-1.0.0.tgz"},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"sokra","email":"tobias.koppers@googlemail.com"},"maintainers":[{"name":"sokra","email":"tobias.koppers@googlemail.com"}],"directories":{}},"1.1.0":{"name":"fastparse","version":"1.1.0","description":"A very simple and stupid parser, based on a statemachine and regular expressions.","main":"lib/Parser.js","scripts":{"pretest":"npm run lint","test":"mocha","travis":"npm run cover -- --report lcovonly","lint":"eslint lib","precover":"npm run lint","cover":"istanbul cover node_modules/mocha/bin/_mocha","publish-patch":"mocha && npm version patch && git push && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/webpack/fastparse.git"},"keywords":["parser","regexp"],"author":{"name":"Tobias Koppers @sokra"},"license":"MIT","bugs":{"url":"https://github.com/webpack/fastparse/issues"},"homepage":"https://github.com/webpack/fastparse","devDependencies":{"coveralls":"^2.11.2","eslint":"^0.21.2","istanbul":"^0.3.14","mocha":"^2.2.5","should":"^6.0.3"},"gitHead":"7d9f6dfa15ba17ab8091fa383b3ff796ab16f29d","_id":"fastparse@1.1.0","_shasum":"02fcf0b63867c557bf986f0106a5912ea47f80fb","_from":".","_npmVersion":"2.10.0","_nodeVersion":"0.12.2","_npmUser":{"name":"sokra","email":"tobias.koppers@googlemail.com"},"maintainers":[{"name":"sokra","email":"tobias.koppers@googlemail.com"}],"dist":{"shasum":"02fcf0b63867c557bf986f0106a5912ea47f80fb","tarball":"http://nexus.dui88.com:8081/nexus/content/repositories/npm-registry/fastparse/-/fastparse-1.1.0.tgz"},"directories":{}},"1.1.1":{"name":"fastparse","version":"1.1.1","description":"A very simple and stupid parser, based on a statemachine and regular expressions.","main":"lib/Parser.js","scripts":{"pretest":"npm run lint","test":"mocha","travis":"npm run cover -- --report lcovonly","lint":"eslint lib","precover":"npm run lint","cover":"istanbul cover node_modules/mocha/bin/_mocha","publish-patch":"mocha && npm version patch && git push && git push --tags && npm publish"},"repository":{"type":"git","url":"git+https://github.com/webpack/fastparse.git"},"keywords":["parser","regexp"],"author":{"name":"Tobias Koppers @sokra"},"license":"MIT","bugs":{"url":"https://github.com/webpack/fastparse/issues"},"homepage":"https://github.com/webpack/fastparse","devDependencies":{"coveralls":"^2.11.2","eslint":"^0.21.2","istanbul":"^0.3.14","mocha":"^2.2.5","should":"^6.0.3"},"gitHead":"9206e0921135115b6941f3174530fafa40287e44","_id":"fastparse@1.1.1","_shasum":"d1e2643b38a94d7583b479060e6c4affc94071f8","_from":".","_npmVersion":"2.10.0","_nodeVersion":"0.12.2","_npmUser":{"name":"sokra","email":"tobias.koppers@googlemail.com"},"maintainers":[{"name":"sokra","email":"tobias.koppers@googlemail.com"}],"dist":{"shasum":"d1e2643b38a94d7583b479060e6c4affc94071f8","tarball":"http://nexus.dui88.com:8081/nexus/content/repositories/npm-registry/fastparse/-/fastparse-1.1.1.tgz"},"directories":{}}},"name":"fastparse","time":{"modified":"2017-01-07T23:53:17.534Z","created":"2014-08-08T12:02:11.553Z","1.0.0":"2014-08-08T12:02:11.553Z","1.1.0":"2015-05-24T18:57:17.733Z","1.1.1":"2015-05-24T19:32:14.557Z"},"readmeFilename":"README.md","homepage":"https://github.com/webpack/fastparse"}