Gathering detailed insights and metrics for parser
Installations
npm install parserDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
0.4-0.9
NPM Version
1.1.66
Score
74
Supply Chain
97.8
Quality
74.9
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
3
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
floby
Download Statistics
Total Downloads
433,727
Last Day
300
Last Week
1,392
Last Month
5,703
Last Year
75,137
GitHub Statistics
26 Stars
33 Commits
13 Forks
5 Watchers
1 Branches
3 Contributors
Updated on Oct 14, 2023
Bundle Size
2.14 kB
Minified
887.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.1.4
Package Id
parser@0.1.4
Size
5.10 kB
NPM Version
1.1.66
Total Downloads
Cumulative downloads
Total Downloads
433,727
Last Day
17.2%
300
Compared to previous day
Last Week
-3.5%
1,392
Compared to previous week
Last Month
18.1%
5,703
Compared to previous month
Last Year
-1.7%
75,137
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Synopsis
This module is basically a class that provides general mechanisms for parsing strings. It works with my tokenizer although it can be used with pretty much anything emitting tokens the same way. The parser works with a queue of functions. For each token the next function in the queue is called.
write you own parser
tokenizer
Only one thing is required for the parser to work : a tokenizer. These concepts are very different and that is why they are implemented separately. The easiest solution is to use my tokenizer
parser
The default behaviour upon receiving a new token is ignoring it. It prints a warning when reaching EOF with the number of tokens that have been ignored. However this is probably not what you want to do!
In order to parse what you need to parse you have to provide the parser with the functions which will be called for each token. Let's call these functions 'handlers'. This can be achieved through configuration of the basic parser or through inheritance.
1var Parser = require('parser'); 2var util = require('util'); 3var MyTokenizer = require('./MyTokenizer'); 4 5function MyParser() { 6 // MyTokenizer is the tokenizer we configured 7 // but it's not the subject of this module 8 Parser.apply(this, new MyTokenizer()); 9 10 // override the default behaviour 11 this.defaultHandler(this.default); 12 13 // specify the function that will be called on the first token 14 this.initialHander(this.initial); 15} 16util.inherits(MyParser, Parser); 17 18/** 19 * Of course you will have to define these functions somewhere 20 */
This is very theoretic but you can have a look at what is in the example folder
Handlers
Handlers are just javascript functions accepting the following arguments:
tokenthe actual token emitted by the tokenizertypethe type of this token (i.e.'number','whitespace','word')nexta function to specify what needs to be called on the next token(s)
the next function takes a random number of handlers which will be pushed
in front of the handlers queue (they will be next!).
returning true from a handler causes the same token to be reemitted
to the next handler.
This allows you to define handlers doing some kind of "sniffing" if you find
yourself in a state in which you cannot determine what will come next.
This kind of handlers expand themselves to a greater number of handlers that
will effectively parse the following tokens. They do that by adding a few handlers
to the queue with next and returning true to notify the parser that the token
should be reemitted.
Handlers utilities
there are a few handlers factories provided by this module.
checkType(type)returns a handler that only checks the type of the token without doing anything so the same token is pass down to the next handlerexpect(type)returns a handler that checks for the specified type and consumes the tokenlist(separator, element, end)returns a handler expanding to the handlers needed to parse a list of elements able to be parsed byelementand separated by tokens of typeseparator. The list should end by a token of typeend
project
TODOs
- more robustness / better error handling
- features requests
- Support for asynchronous handlers
- allow for complex separator an ending tokens for handler utilities
Features requests / bugs
If you'd like the parser to do something that it doesn't do or want to report a bug please use the github issue tracker on github
fork / patches / pull requests
You are very welcome to send patches or pull requests
License
Copyright (c) 2012 Florent Jaby
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Score
2.6
/10
Last Scanned on 2025-02-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More