Merge pull request #1485 from Fdawgs/chore/try

.eslintrc.js

@@ -7,6 +7,7 @@ module.exports = {
  },
  extends: [
  "airbnb-base",
+ "plugin:@eslint-community/eslint-comments/recommended",
  "plugin:jsdoc/recommended",
  "plugin:promise/recommended",
  "plugin:regexp/recommended",
@@ -49,13 +50,17 @@ module.exports = {
  ],
  root: true,
  rules: {
+ "@eslint-community/eslint-comments/disable-enable-pair": "off",
+ "@eslint-community/eslint-comments/no-unused-disable": "error",
+ "@eslint-community/eslint-comments/require-description": "error",
  "import/no-extraneous-dependencies": "error",
  "jsdoc/check-syntax": "error",
  "jsdoc/require-hyphen-before-param-description": "error",
  "no-multiple-empty-lines": ["error", { max: 1 }],
  "prefer-destructuring": ["error", { object: true, array: false }],
  "promise/prefer-await-to-callbacks": "warn",
  "promise/prefer-await-to-then": "warn",
+ "security/detect-object-injection": "off",
  strict: ["error", "global"],
  },
 };

.github/dependabot.yml

@@ -20,6 +20,7 @@ updates:
  - "@commitlint*"
  eslint:
  patterns:
+ - "@eslint-community*"
  - "eslint*"
  fastify-core:
  patterns:

.vscode/extensions.json

@@ -3,6 +3,7 @@
  // for the documentation about the extensions.json format
  "recommendations": [
  "dbaeumer.vscode-eslint",
+ "eamodio.gitlens",
  "esbenp.prettier-vscode",
  "ms-azuretools.vscode-docker",
  "redhat.vscode-xml",

.vscode/settings.json

@@ -2,6 +2,7 @@
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "files.eol": "\n",
+ "gitlens.telemetry.enabled": false,
  "[javascript]": {
  "editor.defaultFormatter": "esbenp.prettier-vscode"
  },

jsconfig.json

@@ -3,7 +3,7 @@
  // Uncomment as and when needed
  // "checkJs": true,
  // "strict": true,
- "lib": ["ES2023"],
+ "lib": ["ES2022"],
  "module": "NodeNext",
  "moduleResolution": "NodeNext",
  "resolveJsonModule": true,

migrations/mssql/004.do.create_tables.js

@@ -1,6 +1,6 @@
 "use strict";
 
-// eslint-disable-next-line func-names
+// eslint-disable-next-line func-names -- Style required by Postgrator
 module.exports.generateSql = function () {
  return `IF OBJECT_ID('access.tokens', 'U') IS NULL CREATE TABLE access.tokens
  (

migrations/mssql/005.do.create_records.js

@@ -1,6 +1,6 @@
 "use strict";
 
-// eslint-disable-next-line func-names
+// eslint-disable-next-line func-names -- Style required by Postgrator
 module.exports.generateSql = function () {
  return `INSERT INTO ${process.env.DB_PATIENT_PREFERENCES_TYPE_TABLE}
  (preference_type)

migrations/postgres/001.do.create_tables.js

@@ -1,6 +1,6 @@
 "use strict";
 
-// eslint-disable-next-line func-names
+// eslint-disable-next-line func-names -- Style required by Postgrator
 module.exports.generateSql = function () {
  return `CREATE SCHEMA IF NOT EXISTS access;
  

migrations/postgres/002.do.create_records.js

@@ -1,6 +1,6 @@
 "use strict";
 
-// eslint-disable-next-line func-names
+// eslint-disable-next-line func-names -- Style required by Postgrator
 module.exports.generateSql = function () {
  return `INSERT INTO ${
  process.env.DB_PATIENT_PREFERENCES_TYPE_TABLE ||

package.json

@@ -67,10 +67,8 @@
  },
  "nodemonConfig": {
  "env": {
- "NODE_ENV": "development",
- "SUPPRESS_SUPPORT": 1
+ "NODE_ENV": "development"
  },
- "verbose": true,
  "watch": [
  ".env",
  "src/**/!(*.test).*"
@@ -79,6 +77,7 @@
  "devDependencies": {
  "@commitlint/cli": "^17.7.2",
  "@commitlint/config-conventional": "^17.7.0",
+ "@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
  "@types/jest": "^29.5.5",
  "autocannon": "^7.12.0",
  "esbuild": "^0.19.4",

scripts/license-checker.js

@@ -1,6 +1,3 @@
-/* eslint-disable security/detect-object-injection */
-/* eslint-disable security-node/detect-crlf */
-
 "use strict";
 
 const { promisify } = require("node:util");

src/app.js

@@ -11,7 +11,7 @@ const migrate = require("./migrate");
  */
 async function main() {
  process.on("unhandledRejection", (err) => {
- // eslint-disable-next-line no-console
+ // eslint-disable-next-line no-console -- Pino logger may not be initialised
  console.error(err);
  process.exit(1);
  });

src/config/config.test.js

@@ -1,3 +1,5 @@
+/* eslint-disable security/detect-non-literal-fs-filename -- Test filenames are not user-provided */
+
 "use strict";
 
 const { unlink } = require("node:fs/promises");
@@ -17,7 +19,6 @@ describe("Configuration", () => {
  dot: true,
  });
 
- // eslint-disable-next-line security/detect-non-literal-fs-filename
  await Promise.all(files.map((file) => unlink(file)));
  });
 

src/config/index.js

@@ -322,9 +322,9 @@ async function getConfig() {
  if (env.HTTPS_SSL_CERT_PATH && env.HTTPS_SSL_KEY_PATH) {
  try {
  config.fastifyInit.https = {
- // eslint-disable-next-line security/detect-non-literal-fs-filename
+ // eslint-disable-next-line security/detect-non-literal-fs-filename -- Filename not user-provided
  cert: await readFile(normalizeTrim(env.HTTPS_SSL_CERT_PATH)),
- // eslint-disable-next-line security/detect-non-literal-fs-filename
+ // eslint-disable-next-line security/detect-non-literal-fs-filename -- Filename not user-provided
  key: await readFile(normalizeTrim(env.HTTPS_SSL_KEY_PATH)),
  };
  } catch (err) {
@@ -338,7 +338,7 @@ async function getConfig() {
  try {
  config.fastifyInit.https = {
  passphrase: env.HTTPS_PFX_PASSPHRASE,
- // eslint-disable-next-line security/detect-non-literal-fs-filename
+ // eslint-disable-next-line security/detect-non-literal-fs-filename -- Filename not user-provided
  pfx: await readFile(normalizeTrim(env.HTTPS_PFX_FILE_PATH)),
  };
  } catch (err) {

src/migrate.js

@@ -1,4 +1,4 @@
-/* eslint-disable no-console */
+/* eslint-disable no-console -- CLI script */
 
 "use strict";
 

src/plugins/clean-object/index.js

@@ -1,5 +1,3 @@
-/* eslint-disable security/detect-object-injection */
-
 "use strict";
 
 const fp = require("fastify-plugin");

src/plugins/convert-date-param-operator/plugin.test.js

@@ -49,7 +49,6 @@ describe("Convert-Date-Param-Operator plugin", () => {
  body: `${key}`,
  })
  .then((response) => {
- // eslint-disable-next-line security/detect-object-injection
  expect(response.body).toStrictEqual(values[key]);
  expect(response.statusCode).toBe(200);
 

src/routes/admin/access/bearer-token/schema.js

@@ -10,8 +10,8 @@ const tags = ["System administration"];
  * converts this from a RegExp to a String
  */
 const dateTimeSearchPattern =
- // eslint-disable-next-line security/detect-unsafe-regex
- /^(?:ap|eb|eq|ge|gt|le|lt|ne|sa)?\d{4}-[01]\d-[0-3]\d(?:T(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:Z|[+-]\d{2}(?::?\d{2})?))?$/u;
+ // eslint-disable-next-line security/detect-unsafe-regex -- False positive
+ /^(?:ap|e[bq]|g[et]|l[et]|ne|sa)?\d{4}-[01]\d-[0-3]\d(?:T(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:Z|[+-]\d{2}(?::?\d{2})?))?$/u;
 
 const dateTimeSearchPatternExamples = [
  "2022-01-13",
@@ -403,7 +403,7 @@ const accessPostSchema = {
  "2022-01-13T00:00:01.001Z",
  ])
  .pattern(
- // eslint-disable-next-line security/detect-unsafe-regex
+ // eslint-disable-next-line security/detect-unsafe-regex -- False positive
  /^\d{4}-\d{2}-\d{2}(?:t\d{2}:\d{2}:\d{2})?(?:.\d{3})?z?$/imu
  )
  )

src/routes/documents/register/schema.js

@@ -9,8 +9,8 @@ const tags = ["Documents"];
  * converts this from a RegExp to a String
  */
 const dateTimeSearchPattern =
- // eslint-disable-next-line security/detect-unsafe-regex
- /^(?:ap|eb|eq|ge|gt|le|lt|ne|sa)?\d{4}-[01]\d-[0-3]\d(?:T(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:Z|[+-]\d{2}(?::?\d{2})?))?$/u;
+ // eslint-disable-next-line security/detect-unsafe-regex -- False positive
+ /^(?:ap|e[bq]|g[et]|l[et]|ne|sa)?\d{4}-[01]\d-[0-3]\d(?:T(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:Z|[+-]\d{2}(?::?\d{2})?))?$/u;
 
 const dateTimeSearchPatternExamples = [
  "2022-01-13",

src/server.js

@@ -229,7 +229,7 @@ async function plugin(server, config) {
  )
 
  // Errors thrown by routes and plugins are caught here
- // eslint-disable-next-line promise/prefer-await-to-callbacks
+ // eslint-disable-next-line promise/prefer-await-to-callbacks -- False positive
  .setErrorHandler(async (err, _req, res) => {
  /**
  * Catch 5xx errors, log them, and return a generic 500

src/utils/escape-single-quotes/index.js

@@ -1,5 +1,4 @@
-/* eslint-disable jsdoc/require-param-description */
-/* eslint-disable security/detect-object-injection */
+/* eslint-disable jsdoc/require-param-description -- Params are self-explanatory */
 
 "use strict";