alpine-ts - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

package.json

 {
     "name": "alpine-ts",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "description": "Alpine - the Apache Log Parser in Typescript",
@@ -12,4 +12,3 @@ "main": "src/index.js",
         "byline": "^5.0.0",
-        "through2": "^0.6.2",
-        "underscore.string": "^3.3.5"
+        "through2": "^4.0.2"
     },
@@ -20,4 +19,3 @@ "devDependencies": {
         "@types/through2": "^2.0.36",
-        "@types/underscore.string": "^0.0.38",
-        "mocha": "^8.2.1",
+        "mocha": "^8.3.0",
         "nyc": "^15.1.0",
@@ -36,3 +34,3 @@ "rimraf": "^3.0.2",
         "type": "git",
-        "url": "https://github.com/blarsen/node-alpine.git"
+        "url": "https://github.com/UrielCh/node-alpine-ts.git"
     },
@@ -48,3 +46,4 @@ "keywords": [
     "author": "uriel chemouni <[e-mail]>",
-    "contributors": [{
+    "contributors": [
+        {
             "name": "Bjørn Hell Larsen",
@@ -61,5 +60,5 @@ "email": "[e-mail]"
     "bugs": {
-        "url": "https://github.com/UrielCh/node-alpine/issues"
+        "url": "https://github.com/UrielCh/node-alpine-ts/issues"
     },
-    "homepage": "https://github.com/UrielCh/node-alpine",
+    "homepage": "https://github.com/UrielCh/node-alpine-ts",
     "files": [
@@ -69,2 +68,2 @@ "src/*.js",
     ]
-}
+}

README.md

 # Alpine
 
-`alpine2` is a fork of `alpine`, this version is writen in Typescript, and so contains de full typing.
+`alpine-ts` is a fork of `alpine`, this version is writen in Typescript, so contains a full typing.
 
-`alpine2` is a parser for Apache mod_log log files. It supports the three most common log formats (the Common Log Format,
+`alpine-ts` is a parser for Apache mod_log log files. It supports the three most common log formats (the Common Log Format,
 the Common Log Format with a vhost field and the Combined log format)
@@ -28,5 +28,6 @@ and also allows you to specify custom log formats by passing it the LogFormat string used to generate the log file you want parsed.
 ```typescript
-import Alpine from 'alpine';
-const alpine = new Alpine("%h %s %B");
-const data = alpine.parseLine("www.brain-salad.com 403 4321");
+import Alpine, {AlpineLine} from 'alpine';
+
+const alpine: Alpine = new Alpine("%h %s %B");
+const data: AlpineLine = alpine.parseLine("www.brain-salad.com 403 4321");
 console.log(data);
@@ -50,10 +51,22 @@ ```
 import fs from 'fs';
-import Alpine from 'alpine';
+import Alpine, {AlpineLine} from 'alpine';
+
 const alpine = new Alpine();
 alpine.parseReadStream(fs.createReadStream('access_log', {encoding: "utf8"}),
-  function(data) {
-    console.log("Status: " + data.status + ", request: " + data.request);
+  function(data: AlpineLine) {
+    console.log(`Status: ${data.status}, request: ${data.request}`);
   });
 ```
 
+### Change from the legacy `alpine` 
+
+- Parameterized filed like `AlpineLine['RequestHeader header']` are now avalable in `AlpineLine.RequestHeader['header']`
+- AlpineLine contains some helper like:
+  - AlpineLine.url return the log line as a request (patial if not all data are available in the log format)
+  - AlpineLine.method return 'GET'/'POST'/'PUT' ...
+  - AlpineLine.pathname return the requested path
+  - AlpineLine.extension return the file extention from the requested path like (.js, .css, .html ....)
+  - AlpineLine.getQuery('name') return a query parameter value
+  - AlpineLine.getQueryAll('name') return a query parameter value in a string[]
+
 ### Use streams
@@ -60,0 +73,0 @@

src/alpine.js

@@ -16,3 +16,2 @@ /**
 const byline_1 = __importDefault(require("byline"));
-const underscore_string_1 = __importDefault(require("underscore.string"));
 const through2_1 = __importDefault(require("through2"));
@@ -152,7 +151,11 @@ const fields_1 = require("./fields");
 function stripQuotes(text) {
-    if ((underscore_string_1.default.startsWith(text, '"') && underscore_string_1.default.endsWith(text, '"')) ||
-        (underscore_string_1.default.startsWith(text, "[") && underscore_string_1.default.endsWith(text, "]")))
-        return text.substr(1, text.length - 2);
+    const length = text.length;
+    if (length <= 2)
+        return text;
+    const c1 = text[0];
+    const c2 = text[length - 1];
+    if ((c1 === '"' && c2 === '"') || (c1 === '[' && c2 === ']'))
+        return text.substr(1, length - 2);
     return text;
 }
 //# sourceMappingURL=alpine.js.map

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

32399

increased by1.69%

Dependency count

2

decreased by-33.33%

Dev dependency count

8

decreased by-11.11%

Lines of code

547

increased by0.55%

Number of lines in readme file

92

increased by16.46%

Worsened metrics

Number of downloads

0

decreased by-100%

Dependency changes

• + Addedreadable-stream@3.6.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedthrough2@4.0.2(transitive)

• - Removedunderscore.string@^3.3.5

• - Removedcore-util-is@1.0.3(transitive)

• - Removedisarray@0.0.1(transitive)

• - Removedreadable-stream@1.0.34(transitive)

• - Removedsprintf-js@1.1.3(transitive)

• - Removedstring_decoder@0.10.31(transitive)

• - Removedthrough2@0.6.5(transitive)

• - Removedunderscore.string@3.3.6(transitive)

• - Removedxtend@4.0.2(transitive)

• Updatedthrough2@^4.0.2