style: jsdoc comments must be complete sentences

Fdawgs · Dec 18, 2023 · a663853 · a663853
1 parent f4cafd3
commit a663853
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/.eslintrc.js b/.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 }],

diff --git a/scripts/license-checker.js b/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 = [