Comparing version 2.1.0 to 2.1.1
{ | ||
"name": "apg-exp", | ||
"version": "2.1.0", | ||
"description": "Pattern-matching alternative to RegExp. Replaces the regular expression syntax with ABNF. Adds APG parser features such as User Defined Terminals (hand-written pattern matchers) and access to the AST.", | ||
"version": "2.1.1", | ||
"description": "(Deprecated: use apg-js instead.) Pattern-matching alternative to RegExp. Replaces the regular expression syntax with ABNF. Adds APG parser features such as User Defined Terminals (hand-written pattern matchers) and access to the AST.", | ||
"main": "./src/apg-exp.js", | ||
@@ -6,0 +6,0 @@ "scripts": { |
# apg-exp - APG Expressions | ||
_**Deprecated:** Use [apg-js](https://www.npmjs.com/package/apg-js) instead. See [apg-js-examples](https://www.npmjs.com/package/apg-js-examples) for usage._ | ||
**apg-exp** is a regex-like pattern-matching engine that uses a superset of the [ABNF syntax](https://tools.ietf.org/html/rfc5234) for the pattern definitions and [**APG**](https://github.com/ldthomas/apg-js2) to create and apply the pattern-matching parser. | ||
@@ -8,3 +10,3 @@ | ||
**Complete User's Guide:** A complete user's guide can be found at `./guide/index.html` | ||
**Complete User's Guide:** A complete user's guide can be found at `./guide/index.html` | ||
or the [**APG** website](http://coasttocoastresearch.com/docjs2/apg-exp-guide/index.html). | ||
@@ -18,5 +20,6 @@ | ||
**apg-exp:** By way of introduction, the [regex Wikipedia article](https://en.wikipedia.org/wiki/Regular_expression) would be a good start and Jeffrey Friedl's book, [*Mastering Regular Expressions*](http://www.amazon.com/Mastering-Regular-Expressions-Jeffrey-Friedl/dp/0596528124) would be a lot better and more complete. This introduction will just mention features, a little on motivation and try to point out some possible advantages to **apg-exp**. | ||
**apg-exp:** By way of introduction, the [regex Wikipedia article](https://en.wikipedia.org/wiki/Regular_expression) would be a good start and Jeffrey Friedl's book, [_Mastering Regular Expressions_](http://www.amazon.com/Mastering-Regular-Expressions-Jeffrey-Friedl/dp/0596528124) would be a lot better and more complete. This introduction will just mention features, a little on motivation and try to point out some possible advantages to **apg-exp**. | ||
**Features:** | ||
**Features:** | ||
<ol> | ||
@@ -93,2 +96,3 @@ <li> | ||
The motivation was originally twofold. | ||
<ol> | ||
@@ -107,8 +111,9 @@ <li> | ||
But the best thing to do, probably, is to head over to the | ||
But the best thing to do, probably, is to head over to the | ||
[examples](https://github.com/ldthomas/apg-js2-examples/tree/master/apg-exp) and take a look. | ||
See and compare for yourself. I would suggest starting with the `flags`, `display` and `rules` examples to get your bearings and go from there. | ||
**Installation:** | ||
**Installation:** | ||
**GitHub:** In your project directory, | ||
``` | ||
@@ -118,11 +123,17 @@ git clone https://github.com/ldthomas/apg-js2-exp.git apgexp | ||
``` | ||
**npm:** In your project directory, | ||
``` | ||
npm install apg-exp --save | ||
``` | ||
**web page:** | ||
``` | ||
git clone https://github.com/ldthomas/apg-js2-exp.git apgexp | ||
``` | ||
Then, in the header of your web page include, | ||
``` | ||
@@ -132,3 +143,5 @@ <link rel="stylesheet" href="./apgexp/apgexp.css"> | ||
``` | ||
or, | ||
``` | ||
@@ -138,2 +151,3 @@ <link rel="stylesheet" href="./apgexp/apgexp-min.css"> | ||
``` | ||
(Note that some **apg-exp** output is in HTML format and apgexp.css is needed to properly style it. | ||
@@ -143,2 +157,3 @@ Also, it is simply a copy of [apglib.css](https://github.com/ldthomas/apg-js2-lib).) | ||
Now access **apg-exp** as, | ||
``` | ||
@@ -150,2 +165,3 @@ <script> | ||
``` | ||
See, specifically, the [email](https://github.com/ldthomas/apg-js2-examples/tree/master/apg-exp/email) example. | ||
@@ -156,6 +172,7 @@ | ||
**apg-exp**. | ||
**Documentation:** | ||
The full documentation is in the code in [`docco`](https://jashkenas.github.io/docco/) format. | ||
To generate the documentation, from the package directory: | ||
``` | ||
@@ -165,2 +182,3 @@ npm install -g docco | ||
``` | ||
View `docs/index.html` in any web browser to get started. | ||
@@ -170,6 +188,5 @@ Or view it on the [APG website](http://coasttocoastresearch.com/docjs2/apg-exp/index.html) | ||
**Copyright:** | ||
*Copyright © 2017 Lowell D. Thomas, all rights reserved* | ||
_Copyright © 2017 Lowell D. Thomas, all rights reserved_ | ||
**License:** | ||
Released under the BSD-3-Clause license. | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
1178238
181
0