roarr - npm Package Compare versions

Comparing version 7.14.3 to 7.14.4

package.json

@@ -8,10 +8,10 @@ {
   "ava": {
-    "extensions": [
-      "ts"
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=tsx"
     ],
     "files": [
       "test/roarr/**/*"
-    ],
-    "require": [
-      "ts-node/register/transpile-only"
     ]
@@ -42,8 +42,6 @@ },
     "coveralls": "^3.1.1",
-    "del-cli": "^4.0.1",
     "delay": "^5.0.0",
     "domain-parent": "^1.0.0",
-    "eslint": "^8.29.0",
-    "eslint-config-canonical": "^37.0.3",
-    "gitdown": "^3.1.4",
+    "eslint": "^8.35.0",
+    "eslint-config-canonical": "^40.0.9",
     "husky": "^7.0.4",
@@ -53,5 +51,9 @@ "nyc": "^15.1.0",
     "sinon": "^11.1.2",
-    "ts-node": "^10.9.1",
+    "tsx": "^3.12.3",
     "typescript": "^4.9.4"
   },
+  "files": [
+    "src",
+    "dist"
+  ],
   "engines": {
@@ -66,3 +68,3 @@ "node": ">=12.0"
   "license": "BSD-3-Clause",
-  "main": "./dist/src/Roarr.js",
+  "main": "./dist/Roarr.js",
   "name": "roarr",
@@ -74,11 +76,10 @@ "repository": {
   "scripts": {
-    "benchmark": "ROARR_LOG=true ts-node --transpile-only test/benchmark.ts",
-    "build": "del-cli ./dist && tsc",
-    "create-readme": "gitdown ./.README/README.md --output-file ./README.md",
-    "dev": "tsc --watch",
-    "lint": "eslint ./src ./test && tsc --noEmit",
+    "benchmark": "ROARR_LOG=true tsx test/benchmark.ts",
+    "build": "rm -fr ./dist && tsc --project tsconfig.build.json",
+    "dev": "tsc --watch --project tsconfig.build.json",
+    "lint": "eslint ./src ./test && tsc",
     "test": "NODE_ENV=test ava --serial --verbose"
   },
-  "types": "./dist/src/Roarr.d.ts",
-  "version": "7.14.3"
+  "types": "./dist/Roarr.d.ts",
+  "version": "7.14.4"
 }

README.md

@@ -1,2 +0,1 @@
-<a name="roarr"></a>
 # Roarr
@@ -10,49 +9,2 @@
 
-* [Roarr](#roarr)
-    * [Motivation](#roarr-motivation)
-    * [Usage](#roarr-usage)
-        * [Producing logs](#roarr-usage-producing-logs)
-        * [Consuming logs](#roarr-usage-consuming-logs)
-        * [Filtering logs](#roarr-usage-filtering-logs)
-    * [Log message format](#roarr-log-message-format)
-    * [API](#roarr-api)
-        * [`adopt`](#roarr-api-adopt)
-        * [`child`](#roarr-api-child)
-        * [`getContext`](#roarr-api-getcontext)
-        * [`trace`](#roarr-api-trace)
-        * [`debug`](#roarr-api-debug)
-        * [`info`](#roarr-api-info)
-        * [`warn`](#roarr-api-warn)
-        * [`error`](#roarr-api-error)
-        * [`fatal`](#roarr-api-fatal)
-        * [`traceOnce`](#roarr-api-traceonce)
-        * [`debugOnce`](#roarr-api-debugonce)
-        * [`infoOnce`](#roarr-api-infoonce)
-        * [`warnOnce`](#roarr-api-warnonce)
-        * [`errorOnce`](#roarr-api-erroronce)
-        * [`fatalOnce`](#roarr-api-fatalonce)
-    * [Utilities](#roarr-utilities)
-        * [`getLogLevelName`](#roarr-utilities-getloglevelname)
-    * [Middlewares](#roarr-middlewares)
-    * [CLI program](#roarr-cli-program)
-    * [Transports](#roarr-transports)
-    * [Node.js environment variables](#roarr-node-js-environment-variables)
-    * [Conventions](#roarr-conventions)
-        * [Context property names](#roarr-conventions-context-property-names)
-        * [Using Roarr in an application](#roarr-conventions-using-roarr-in-an-application)
-    * [Recipes](#roarr-recipes)
-        * [Overriding message serializer](#roarr-recipes-overriding-message-serializer)
-        * [Logging errors](#roarr-recipes-logging-errors)
-    * [Anti-patterns](#roarr-anti-patterns)
-        * [Overriding `globalThis.ROARR.write` in Node.js](#roarr-anti-patterns-overriding-globalthis-roarr-write-in-node-js)
-    * [Integrations](#roarr-integrations)
-        * [Using with Sentry](#roarr-integrations-using-with-sentry)
-        * [Using with Fastify](#roarr-integrations-using-with-fastify)
-        * [Using with Elasticsearch](#roarr-integrations-using-with-elasticsearch)
-        * [Using with Scalyr](#roarr-integrations-using-with-scalyr)
-    * [Documenting use of Roarr](#roarr-documenting-use-of-roarr)
-    * [Developing](#roarr-developing)
-
-
-<a name="roarr-motivation"></a>
 ## Motivation
@@ -84,6 +36,4 @@
 
-<a name="roarr-usage"></a>
 ## Usage
 
-<a name="roarr-usage-producing-logs"></a>
 ### Producing logs
@@ -106,3 +56,2 @@
 
-<a name="roarr-usage-consuming-logs"></a>
 ### Consuming logs
@@ -112,3 +61,2 @@
 
-<a name="roarr-usage-consuming-logs-node-js"></a>
 #### Node.js
@@ -124,3 +72,2 @@
 
-<a name="roarr-usage-consuming-logs-browser"></a>
 #### Browser
@@ -171,6 +118,4 @@
 
-<a name="roarr-usage-filtering-logs"></a>
 ### Filtering logs
 
-<a name="roarr-usage-filtering-logs-node-js-1"></a>
 #### Node.js
@@ -186,3 +131,2 @@
 
-<a name="roarr-usage-filtering-logs-browser-1"></a>
 #### Browser
@@ -202,3 +146,2 @@
 
-<a name="roarr-log-message-format"></a>
 ## Log message format
@@ -231,3 +174,2 @@
 
-<a name="roarr-api"></a>
 ## API
@@ -275,4 +217,3 @@
 
-<a name="roarr-api-adopt"></a>
-### <code>adopt</code>
+### `adopt`
 
@@ -312,4 +253,3 @@ ```ts
 
-<a name="roarr-api-adopt-sequence-value"></a>
-#### <code>sequence</code> value
+#### `sequence` value
 
@@ -350,3 +290,2 @@ `sequence` represents async context hierarchy in [`ltree`](https://www.postgresql.org/docs/current/ltree.html) format, i.e.
 
-<a name="roarr-api-adopt-requirements"></a>
 #### Requirements
@@ -356,4 +295,3 @@
 
-<a name="roarr-api-child"></a>
-### <code>child</code>
+### `child`
 
@@ -365,3 +303,2 @@ The `child` function has two signatures:
 
-<a name="roarr-api-child-object-parameter"></a>
 #### Object parameter
@@ -396,3 +333,2 @@
 
-<a name="roarr-api-child-function-parameter"></a>
 #### Function parameter
@@ -441,4 +377,3 @@
 
-<a name="roarr-api-getcontext"></a>
-### <code>getContext</code>
+### `getContext`
 
@@ -463,14 +398,8 @@ Returns the current context.
 
-<a name="roarr-api-trace"></a>
-### <code>trace</code>
-<a name="roarr-api-debug"></a>
-### <code>debug</code>
-<a name="roarr-api-info"></a>
-### <code>info</code>
-<a name="roarr-api-warn"></a>
-### <code>warn</code>
-<a name="roarr-api-error"></a>
-### <code>error</code>
-<a name="roarr-api-fatal"></a>
-### <code>fatal</code>
+### `trace`
+### `debug`
+### `info`
+### `warn`
+### `error`
+### `fatal`
 
@@ -503,14 +432,8 @@ Convenience methods for logging a message with `logLevel` context property value set to a numeric value representing the [log level](#log-levels), e.g.
 
-<a name="roarr-api-traceonce"></a>
-### <code>traceOnce</code>
-<a name="roarr-api-debugonce"></a>
-### <code>debugOnce</code>
-<a name="roarr-api-infoonce"></a>
-### <code>infoOnce</code>
-<a name="roarr-api-warnonce"></a>
-### <code>warnOnce</code>
-<a name="roarr-api-erroronce"></a>
-### <code>errorOnce</code>
-<a name="roarr-api-fatalonce"></a>
-### <code>fatalOnce</code>
+### `traceOnce`
+### `debugOnce`
+### `infoOnce`
+### `warnOnce`
+### `errorOnce`
+### `fatalOnce`
 
@@ -521,7 +444,5 @@ Just like the regular logger methods, but logs the message only once.
 
-<a name="roarr-utilities"></a>
 ## Utilities
 
-<a name="roarr-utilities-getloglevelname"></a>
-### <code>getLogLevelName</code>
+### `getLogLevelName`
 
@@ -545,3 +466,2 @@ Provides log level name (trace, debug, ...) for a numeric log level (10, 20, ...).
 
-<a name="roarr-middlewares"></a>
 ## Middlewares
@@ -578,3 +498,2 @@
 
-<a name="roarr-cli-program"></a>
 ## CLI program
@@ -594,3 +513,2 @@
 
-<a name="roarr-transports"></a>
 ## Transports
@@ -610,6 +528,5 @@
 
-<a name="roarr-node-js-environment-variables"></a>
 ## Node.js environment variables
 
-Use environment variables to control `roarr` behaviour.
+Use environment variables to control `roarr` behavior.
 
@@ -623,6 +540,4 @@ |Name||Function|Default|
 
-<a name="roarr-conventions"></a>
 ## Conventions
 
-<a name="roarr-conventions-context-property-names"></a>
 ### Context property names
@@ -641,3 +556,2 @@
 
-<a name="roarr-conventions-context-property-names-log-levels"></a>
 #### Log levels
@@ -656,3 +570,2 @@
 
-<a name="roarr-conventions-using-roarr-in-an-application"></a>
 ### Using Roarr in an application
@@ -682,6 +595,4 @@
 
-<a name="roarr-recipes"></a>
 ## Recipes
 
-<a name="roarr-recipes-overriding-message-serializer"></a>
 ### Overriding message serializer
@@ -707,3 +618,2 @@
 
-<a name="roarr-recipes-logging-errors"></a>
 ### Logging errors
@@ -740,7 +650,5 @@
 
-<a name="roarr-anti-patterns"></a>
 ## Anti-patterns
 
-<a name="roarr-anti-patterns-overriding-globalthis-roarr-write-in-node-js"></a>
-### Overriding <code>globalThis.ROARR.write</code> in Node.js
+### Overriding `globalThis.ROARR.write` in Node.js
 
@@ -751,6 +659,4 @@ Overriding `globalThis.ROARR.write` in Node.js works the same way as it down in [browser](#browser). However, overriding `ROARR.write` in Node.js is considered an anti-pattern because it defeats some of the major benefits outlined in [Motivation](https://github.com/gajus/roarr#motivation) section of the documentation. Namely, by overriding `ROARR.write` in Node.js you are adding blocking events to the event cycle and coupling application logic with log handling logic.
 
-<a name="roarr-integrations"></a>
 ## Integrations
 
-<a name="roarr-integrations-using-with-sentry"></a>
 ### Using with Sentry
@@ -760,3 +666,2 @@
 
-<a name="roarr-integrations-using-with-fastify"></a>
 ### Using with Fastify
@@ -766,3 +671,2 @@
 
-<a name="roarr-integrations-using-with-elasticsearch"></a>
 ### Using with Elasticsearch
@@ -820,3 +724,2 @@
 
-<a name="roarr-integrations-using-with-scalyr"></a>
 ### Using with Scalyr
@@ -843,3 +746,2 @@
 
-<a name="roarr-documenting-use-of-roarr"></a>
 ## Documenting use of Roarr
@@ -859,3 +761,2 @@
 
-<a name="roarr-developing"></a>
 ## Developing
@@ -862,0 +763,0 @@

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

Major refactor

Supply chain risk

Package 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

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

94399

increased by6.49%

Dev dependency count

22

decreased by-8.33%

Number of package files

69

increased by43.75%

Number of low supply chain risk alerts

1

decreased by-66.67%

Worsened metrics

Lines of code

1297

decreased by-28.81%

Number of lines in readme file

732

decreased by-11.91%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes