enable jsdoc/newline-after-description

.eslintrc.js

@@ -31,8 +31,6 @@ module.exports = {
         'no-restricted-syntax': 0,
         // jsdoc rules
         'jsdoc/check-tag-names': ['error', { definedTags: ['scriptlet', 'trustedScriptlet', 'redirect'] }],
-        'jsdoc/require-returns-description': 0,
-        'jsdoc/newline-after-description': 0,
         'jsdoc/require-param': 0,
         'jsdoc/tag-lines': 0,
         'jsdoc/require-jsdoc': 0,
@@ -42,6 +40,8 @@ module.exports = {
         // jsdoc problematics
         'jsdoc/valid-types': 0,
         'jsdoc/no-undefined-types': 0,
+        // jsdoc questionable
+        'jsdoc/require-returns-description': 0,
     },
     overrides: [
         {

scripts/build-compatibility-table.js

@@ -77,6 +77,7 @@ const getTableHeader = () => {
 
 /**
  * Builds markdown string of scriptlets/redirect compatibility table
+ *
  * @param {string} title title for scriptlets or redirects
  * @param {CompatibilityItem[]} data array of scriptlets or redirects compatibility data items
  * @param {'scriptlets'|'redirects'} id

scripts/build-redirects.js

@@ -143,6 +143,7 @@ const getJsRedirects = async (options = {}) => {
     // TODO: seems like duplicate of already existed code
     /**
      * Returns first line of describing comment from redirect resource file
+     *
      * @param {string} rrName redirect resource name
      */
     const getComment = (rrName) => {

scripts/build-tests.js

@@ -14,6 +14,7 @@ const TEST_FILE_NAME_MARKER = '.test.js';
 
 /**
  * Prepares rollup config for test file
+ *
  * @param {string} fileName test file name
  * @param {string} dirPath resolved directory path
  * @param {string} subDir subdirectory with test files

scripts/check-sources-updates.js

@@ -14,6 +14,7 @@ const {
 
 /**
  * Checks if arrays contain the same strings
+ *
  * @param {Array} arr1
  * @param {Array} arr2
  */
@@ -39,6 +40,7 @@ const getCompatibilityTable = () => {
 
 /**
  * Returns list of scriptlets listed in table for specified platform
+ *
  * @param {"ubo"|"abp"} platform
  */
 const getScriptletsFromTable = (platform) => {
@@ -48,6 +50,7 @@ const getScriptletsFromTable = (platform) => {
 
 /**
  * Returns list of redirects listed in table for specified platform
+ *
  * @param {"ubo"|"abp"} platform
  */
 const getRedirectsFromTable = (platform) => {
@@ -57,6 +60,7 @@ const getRedirectsFromTable = (platform) => {
 
 /**
  * Finds a difference between old and new array
+ *
  * @param {Array} oldList
  * @param {Array} newList
  */
@@ -77,6 +81,7 @@ const getDiff = (oldList, newList) => {
 
 /**
  * Marks removed rules with (removed) and adds new rules to the end of the table
+ *
  * @param {{removed: Array, added: Array}} diff Object with diffs for certain type and platform
  * @param {"scriptlets"|"redirects"} ruleType
  * @param {"ubo"|"abp"} platform

scripts/helpers.js

@@ -21,6 +21,7 @@ const writeFile = async (filePath, content) => {
 
 /**
  * Gets list of `.js` files in directory
+ *
  * @param {string} relativeDirPath relative path to directory
  * @returns {string[]} array of file names
  */
@@ -108,6 +109,7 @@ const prepareCommentsData = (commentTags, source) => {
 
 /**
  * Gets data objects which describe every required comment in one directory
+ *
  * @param {string[]} filesList list of files in directory
  * @param {string} relativeDirPath relative path to directory
  *

scripts/rollup-runners.js

@@ -5,6 +5,7 @@ const { log } = console;
 
 /**
  * Builds scriptlets
+ *
  * @param {object|object[]} config config may be list of configs or one config
  */
 export const rollupStandard = async (config) => {
@@ -26,6 +27,7 @@ export const rollupStandard = async (config) => {
 
 /**
  * Builds scriptlets in the watch mode
+ *
  * @param {object|object[]} config - config may be list of configs or one config
  */
 export const rollupWatch = (config) => {

src/helpers/add-event-listener-utils.js

@@ -1,5 +1,6 @@
 /**
  * Validates event type
+ *
  * @param {*} type
  * @returns {boolean}
  */
@@ -10,6 +11,7 @@ export const validateType = (type) => {
 
 /**
  * Validates event listener
+ *
  * @param {*} listener
  * @returns {boolean}
  */
@@ -26,6 +28,7 @@ export const validateListener = (listener) => {
 /**
  * Serialize valid event listener
  * https://developer.mozilla.org/en-US/docs/Web/API/EventListener
+ *
  * @param {EventListener} listener valid listener
  * @returns {string}
  */

src/helpers/adjust-set-utils.js

@@ -4,6 +4,7 @@ export const shouldMatchAnyDelay = (delay) => delay === '*';
 
 /**
  * Handles input delay value
+ *
  * @param {*} delay
  * @returns {number} proper number delay value
  */
@@ -18,6 +19,7 @@ export const getMatchDelay = (delay) => {
 
 /**
  * Checks delay match condition
+ *
  * @param {*} inputDelay
  * @param {number} realDelay
  * @returns {boolean}
@@ -29,6 +31,7 @@ export const isDelayMatched = (inputDelay, realDelay) => {
 
 /**
  * Handles input boost value
+ *
  * @param {*} boost
  * @returns {number} proper number boost multiplier value
  */

src/helpers/array-utils.js

@@ -2,6 +2,7 @@
  * Some browsers do not support Array.prototype.flat()
  * for example, Opera 42 which is used for browserstack tests
  * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flat
+ *
  * @param {Array} input
  */
 export const flatten = (input) => {
@@ -24,6 +25,7 @@ export const flatten = (input) => {
 
 /**
  * Predicate method to check if the array item exists
+ *
  * @param {any} item
  * @returns {boolean}
  */

src/helpers/converter.js

@@ -66,6 +66,7 @@ const REMOVE_ATTR_CLASS_APPLYING = ['asap', 'stay', 'complete'];
 
 /**
  * Returns array of strings separated by space which not in quotes
+ *
  * @param {string} str
  */
 const getSentences = (str) => {
@@ -75,6 +76,7 @@ const getSentences = (str) => {
 
 /**
  * Replaces string with data by placeholders
+ *
  * @param {string} str
  * @param {object} data - where keys are placeholders names
  */
@@ -104,6 +106,7 @@ const splitArgs = (str) => {
 
 /**
  * Validates remove-attr/class scriptlet args
+ *
  * @param {string[]} parsedArgs
  * @returns {string[]|Error} valid args OR error for invalid selector
  */
@@ -147,6 +150,7 @@ const validateRemoveAttrClassArgs = (parsedArgs) => {
 
 /**
  * Converts string of UBO scriptlet rule to AdGuard scriptlet rule
+ *
  * @param {string} rule - UBO scriptlet rule
  * @returns {string[]} - array with one AdGuard scriptlet rule
  */
@@ -193,6 +197,7 @@ export const convertUboScriptletToAdg = (rule) => {
 
 /**
  * Convert string of ABP snippet rule to AdGuard scriptlet rule
+ *
  * @param {string} rule - ABP snippet rule
  * @returns {Array} - array of AdGuard scriptlet rules -
  * one or few items depends on Abp-rule
@@ -221,6 +226,7 @@ export const convertAbpSnippetToAdg = (rule) => {
 
 /**
  * Converts scriptlet rule to AdGuard one
+ *
  * @param {string} rule
  * @returns {Array} - array of AdGuard scriptlet rules -
  * one item for Adg and Ubo or few items for Abp
@@ -240,6 +246,7 @@ export const convertScriptletToAdg = (rule) => {
 
 /**
  * Converts UBO scriptlet rule to AdGuard one
+ *
  * @param {string} rule - AdGuard scriptlet rule
  * @returns {string} - UBO scriptlet rule
  */
@@ -328,6 +335,7 @@ export const convertAdgScriptletToUbo = (rule) => {
 
 /**
  * Checks whether the ADG scriptlet exists or UBO/ABP scriptlet is compatible to ADG
+ *
  * @param {string} input - can be ADG or UBO or ABP scriptlet rule
  * @returns {boolean}
  */
@@ -350,6 +358,7 @@ export const isValidScriptletRule = (input) => {
 
 /**
  * Gets index and redirect resource marker from UBO/ADG modifiers array
+ *
  * @param {string[]} modifiers
  * @param {object} redirectsData validator.REDIRECT_RULE_TYPES.(UBO|ADG)
  * @param {string} rule
@@ -373,6 +382,7 @@ const getMarkerData = (modifiers, redirectsData, rule) => {
 
 /**
  * Converts Ubo redirect rule to Adg one
+ *
  * @param {string} rule
  * @returns {string}
  */
@@ -403,6 +413,7 @@ export const convertUboRedirectToAdg = (rule) => {
 
 /**
  * Converts Abp redirect rule to Adg one
+ *
  * @param {string} rule
  * @returns {string}
  */
@@ -428,6 +439,7 @@ export const convertAbpRedirectToAdg = (rule) => {
 
 /**
  * Converts redirect rule to AdGuard one
+ *
  * @param {string} rule
  * @returns {string}
  */
@@ -452,6 +464,7 @@ export const convertRedirectToAdg = (rule) => {
  *    Source types are chosen according to redirect name
  *    e.g. ||ad.com^$redirect=<name>,important  ->>  ||ad.com^$redirect=<name>,important,script
  * 3. Replaces Adg redirect name by Ubo analog
+ *
  * @param {string} rule
  * @returns {string}
  */

src/helpers/cookie-utils.js

@@ -94,6 +94,7 @@ export const getLimitedCookieValue = (value) => {
 
 /**
  * Parses cookie string into object
+ *
  * @param {string} cookieString string that conforms to document.cookie format
  * @returns {object} key:value object that corresponds with incoming cookies keys and values
  */
@@ -124,6 +125,7 @@ export const parseCookieString = (cookieString) => {
 
 /**
  * Check if cookie with specified name and value is present in a cookie string
+ *
  * @param {string} cookieString
  * @param {string} name
  * @param {string} value

src/helpers/create-on-error-handler.js

@@ -1,6 +1,7 @@
 /**
  * Generates function which silents global errors on page generated by scriptlet
  * If error doesn't belong to our error we transfer it to the native onError handler
+ *
  * @param {string} rid - unique identifier of scriptlet
  * @returns {onError}
  */

src/helpers/hit.js

@@ -1,6 +1,7 @@
 /* eslint-disable no-console, no-underscore-dangle */
 /**
  * Hit used only for debug purposes now
+ *
  * @param {Source} source
  * use LOG_MARKER = 'log: ' at the start of a message
  * for logging scriptlets

src/helpers/injector.js

@@ -1,5 +1,6 @@
 /**
  * Concat dependencies to scriptlet code
+ *
  * @param {string} scriptlet string view of scriptlet
  */
 export function attachDependencies(scriptlet) {
@@ -11,6 +12,7 @@ export function attachDependencies(scriptlet) {
 
 /**
  * Add scriptlet call to existing code
+ *
  * @param {Function} scriptlet
  * @param {string} code
  */
@@ -64,6 +66,7 @@ export function passSourceAndProps(source, code, redirect = false) {
 
 /**
  * Wrap code in no name function
+ *
  * @param {string} code which must be wrapped
  */
 export function wrapInNonameFunc(code) {

src/helpers/log-message.js

@@ -7,6 +7,7 @@
  * Convention is to log messages by source.verbose if such log
  * is not a part of scriptlet's functionality, eg on invalid input,
  * and use 'forced' argument otherwise.
+ *
  * @param {Source} source required
  * @param {string} message required, message to log
  * @param {boolean} [forced=false] to log message unconditionally

src/helpers/match-request-props.js

@@ -13,6 +13,7 @@ import { logMessage } from './log-message';
  * Checks if given propsToMatch string matches with given request data
  * This is used by prevent-xhr, prevent-fetch, trusted-replace-xhr-response
  * and  trusted-replace-fetch-response scriptlets
+ *
  * @param {Source} source
  * @param {string} propsToMatch
  * @param {object} requestData object with standard properties of fetch/xhr like url, method etc

src/helpers/match-stack.js

@@ -5,6 +5,7 @@ import { getNativeRegexpTest } from './regexp-utils';
 /**
  * Checks if the stackTrace contains stackRegexp
  * https://github.com/AdguardTeam/Scriptlets/issues/82
+ *
  * @param {string|undefined} stackMatch - input stack value to match
  * @param {string} stackTrace - script error stack trace
  * @returns {boolean}