style: jsdoc comments must be complete sentences

.eslintrc.js

@@ -47,6 +47,7 @@ module.exports = {
  "@eslint-community/eslint-comments/require-description": "error",
  "import/no-extraneous-dependencies": "error",
  "jsdoc/check-syntax": "error",
+ "jsdoc/require-description-complete-sentence": "error",
  "jsdoc/require-hyphen-before-param-description": "error",
  "no-multiple-empty-lines": ["error", { max: 1 }],
  "prefer-destructuring": ["error", { object: true, array: false }],

scripts/license-checker.js

@@ -18,7 +18,7 @@ async function checkLicenses() {
  console.log("Checking licenses of direct production dependencies...");
 
  /**
- * List of deprecated copyleft license identifiers
+ * List of deprecated copyleft license identifiers.
  * @see {@link https://spdx.org/licenses/#deprecated | SPDX Deprecated License Identifiers}
  */
  const deprecatedLicenseList = [

src/routes/redirect/index.js

@@ -57,7 +57,7 @@ async function route(server, options) {
  /**
  * Unable to use WHATWG URL API here to serialise URL,
  * as the API treats hashes in shebangs as the start
- * of a fragment
+ * of a fragment.
  */
  const espUrl = options.redirectUrl + fastStringify(req.query);
  server.log.debug(espUrl);

src/server.js

@@ -119,7 +119,7 @@ async function plugin(server, config) {
  /**
  * Encapsulate the docs routes into a child context, so that the
  * CSP can be relaxed, and cache enabled, without affecting
- * security of other routes
+ * security of other routes.
  */
  .register(async (publicContext) => {
  const relaxedHelmetConfig = structuredClone(config.helmet);
@@ -173,13 +173,13 @@ async function plugin(server, config) {
  /**
  * Catch 5xx errors, log them, and return a generic 500
  * response. This avoids leaking internal server error details
- * to the client
+ * to the client.
  */
  if (
  (err.statusCode >= 500 && err.statusCode !== 503) ||
  /**
  * Uncaught errors will have a res.statusCode but not
- * an err.statusCode as @fastify/sensible sets that
+ * an err.statusCode as @fastify/sensible sets that.
  */
  (res.statusCode === 200 && !err.statusCode)
  ) {

src/server.test.js

@@ -739,7 +739,7 @@ describe("Server deployment", () => {
  });
  });
 
- /** @todo fix this impacting the API documentation `describe` block, and move it back to running before it */
+ /** @todo Fix this impacting the API documentation `describe` block, and move it back to running before it. */
  describe("Query string API key auth enabled", () => {
  let config;
  /** @type {Fastify.FastifyInstance} */