advisory-lock - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

package.json

 {
   "name": "advisory-lock",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Distributed locking using PostgreSQL advisory locks",
   "main": "lib/index.js",
+  "bin": {
+    "withlock": "./lib/bin/withlock.js"
+  },
   "scripts": {
@@ -51,4 +54,5 @@ "pretest": "npm run lint",
     "debug": "^2.2.0",
+    "minimist": "^1.2.0",
     "pg": "^4.5.5"
   }
 }

README.md

@@ -32,2 +32,26 @@ # advisory-lock
 
+## CLI Usage
+
+A `withlock` command line utility is provided to make to facilitate the
+common use case of ensuring only one instance of a process is running at any
+time.
+
+![withlock demo](./withlock-demo.gif)
+
+```bash
+withlock <lockName> [--db <connectionString>] -- <command>
+```
+
+Where `<lockName>` is the name of the lock, `<command>` (everything after
+`--`) is the command to run exclusively, once the lock is acquired.
+`--db <connectionString>` is optional and if not specified, the
+`PG_CONNECTION_STRING` environment variable will be used.
+
+Example:
+
+```bash
+export PG_CONNECTION_STRING="postgres://postgres@127.0.0.1/mydb"
+withlock dbmigration -- npm run knex migrate:latest
+```
+
 ## Usage
@@ -34,0 +58,0 @@

New alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

143583

increased by1118.87%

Number of package files

8

increased by33.33%

Lines of code

206

increased by32.05%

Number of lines in readme file

163

increased by17.27%

Worsened metrics

Dependency count

3

increased by50%

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedminimist@^1.2.0

• + Addedminimist@1.2.8(transitive)