chore: change comment blocks with one line into single block

Fdawgs · Sep 17, 2023 · 3732126 · 3732126
1 parent 630c72b
commit 3732126
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 48 deletions.
diff --git a/src/config/index.js b/src/config/index.js
@@ -337,9 +337,7 @@ async function getConfig() {
  if (env.LOG_ROTATION_FILENAME) {
  const logFile = normalizeTrim(env.LOG_ROTATION_FILENAME);
 
- /**
- * @see {@link https://github.com/rogerc/file-stream-rotator/#options | File stream rotator options}
- */
+ /** @see {@link https://github.com/rogerc/file-stream-rotator/#options | File stream rotator options} */
  config.fastifyInit.logger.stream = getStream({
  audit_file: joinSafe(dirname(logFile), ".audit.json"),
  date_format: env.LOG_ROTATION_DATE_FORMAT || "YYYY-MM-DD",

diff --git a/src/plugins/clean-object/plugin.test.js b/src/plugins/clean-object/plugin.test.js
@@ -4,9 +4,7 @@ const Fastify = require("fastify");
 const plugin = require(".");
 
 describe("Clean-Object plugin", () => {
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/plugins/convert-date-param-operator/plugin.test.js b/src/plugins/convert-date-param-operator/plugin.test.js
@@ -4,9 +4,7 @@ const Fastify = require("fastify");
 const plugin = require(".");
 
 describe("Convert-Date-Param-Operator plugin", () => {
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/plugins/db/plugin.test.js b/src/plugins/db/plugin.test.js
@@ -20,9 +20,7 @@ jest.mock("pg", () => ({
 
 describe("DB plugin", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  const query = "SELECT 'test' AS \"example\"";

diff --git a/src/routes/admin/access/bearer-token/route.test.js b/src/routes/admin/access/bearer-token/route.test.js
@@ -202,9 +202,7 @@ describe("Access route", () => {
  ];
  describe.each(connectionTests)("$testName", ({ envVariables, mocks }) => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/routes/admin/healthcheck/route.test.js b/src/routes/admin/healthcheck/route.test.js
@@ -10,9 +10,7 @@ const sharedSchemas = require("../../../plugins/shared-schemas");
 describe("Healthcheck route", () => {
  describe("GET requests", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/routes/contact/route.test.js b/src/routes/contact/route.test.js
@@ -199,9 +199,7 @@ describe("Contact route", () => {
  connectionTests.forEach((testObject) => {
  describe(`${testObject.testName} - with request scopes`, () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {
@@ -847,9 +845,7 @@ describe("Contact route", () => {
 
  describe(`${testObject.testName} - without request scopes`, () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/routes/docs/openapi/route.test.js b/src/routes/docs/openapi/route.test.js
@@ -11,9 +11,7 @@ const sharedSchemas = require("../../../plugins/shared-schemas");
 describe("OpenAPI route", () => {
  describe("GET requests", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/routes/docs/route.test.js b/src/routes/docs/route.test.js
@@ -10,9 +10,7 @@ const sharedSchemas = require("../../plugins/shared-schemas");
 describe("Docs route", () => {
  describe("GET requests", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {

diff --git a/src/server.test.js b/src/server.test.js
@@ -266,9 +266,7 @@ describe("Server deployment", () => {
 
  describe("Bearer token disabled", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {
@@ -370,9 +368,7 @@ describe("Server deployment", () => {
 
  describe("Bearer token enabled", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {
@@ -561,9 +557,7 @@ describe("Server deployment", () => {
 
  describe("Basic auth", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {
@@ -665,13 +659,9 @@ describe("Server deployment", () => {
 
  describe("CORS", () => {
  let config;
- /**
- * @type {{ [x: string]: any }}
- */
+ /** @type {{ [key: string]: any }} */
  let currentEnv;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(() => {
@@ -936,9 +926,7 @@ describe("Server deployment", () => {
 
  describe("API documentation", () => {
  let config;
- /**
- * @type {Fastify.FastifyInstance}
- */
+ /** @type {Fastify.FastifyInstance} */
  let server;
 
  beforeAll(async () => {