diff --git a/.cspell.json b/.cspell.json index e30301ef..b9ddbcd6 100644 --- a/.cspell.json +++ b/.cspell.json @@ -4,7 +4,7 @@ "ignorePaths": [ "**/coverage/**", "**/node_modules/**", - "**/jsdoc/**", + "**/jsdoc/templates/*", "**/*.{json}", ".cspell.json" ], diff --git a/jsdoc/README.md b/jsdoc/README.md index e1c9a232..ce06e7a3 100644 --- a/jsdoc/README.md +++ b/jsdoc/README.md @@ -31,7 +31,7 @@ const db = pgp(connection); * `dc` = Database Context - optional parameter (see [Database] constructor). Object `db` represents the [Database] protocol with lazy connection, i.e. only the actual query methods acquire -and release the connection automatically. Therefore you should create only one global/shared `db` object per connection details. +and release the connection automatically. Therefore, you should create only one global/shared `db` object per connection details. It is best to initialize the library and create [Database] in its own module, see [Where should I initialize pg-promise]. diff --git a/package.json b/package.json index 8dc116d2..13564a11 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "lib/index.js", "typings": "typescript/pg-promise.d.ts", "scripts": { - "check-spelling": "cspell --config=.cspell.json \"**/*.{md,ts,js}\"", + "check-spelling": "cspell --config=.cspell.json \"**/*.{md,ts,js}\" --no-progress", "coverage": "istanbul cover ./node_modules/jasmine-node/bin/jasmine-node test", "doc": "jsdoc -c ./jsdoc/jsdoc.js ./jsdoc/README.md -t ./jsdoc/templates/custom", "lint": "eslint ./lib ./test/*.js ./test/db --fix",