refactor: Enable jsdoc/tag-lines and jsdoc/sort-tags rules

scripts/finalizeRelease.ts

@@ -27,7 +27,9 @@ async function commitAndTag(): Promise<void> {
 
 /**
  * Prompts the user for input
+ *
  * @param query - A string to prompt the user
+ *
  * @returns Promise with the input of the user
  */
 async function waitForUserInput(query: string): Promise<string> {

scripts/formatChangelog.ts

@@ -14,7 +14,9 @@ import { readFile, writeFile } from 'fs-extra';
 
 /**
  * Capitalize all list entries
+ *
  * @param input - String to search/replace
+ *
  * @returns Promise with output string
  */
 async function capitalizeListEntries(input: string): Promise<string> {
@@ -31,7 +33,9 @@ function endProcess(error: Error): never {
 
 /**
  * Main function for changelog formatting
+ *
  * @param filePath - Path to the changelog file
+ *
  * @returns Promise
  */
 async function formatChangelog(filePath: string): Promise<void> {

scripts/upgradeConfig.ts

@@ -18,6 +18,7 @@ import { joinFilePath, readPackageJson } from '../src/util/PathUtil';
 
 /**
  * Search and replace the version of a component with given name
+ *
  * @param  filePath - File to search/replace
  * @param  regex - RegExp matching the component reference
  * @param  version - Semantic version to change to
@@ -31,8 +32,10 @@ async function replaceComponentVersion(filePath: string, regex: RegExp, version:
 
 /**
  * Recursive search for files that match a given Regex
+ *
  * @param  path - Path of folder to start search in
  * @param  regex - A regular expression to which file names will be matched
+ *
  * @returns Promise with all file pathss
  */
 async function getFilePaths(path: string, regex: RegExp): Promise<string[]> {