- Linting (ESLint): Add rules to check for file-level tags

master
Brett Zamir 2020-01-01 01:15:16 +08:00
parent 63ba8f39a1
commit cc6937ce96
13 changed files with 49 additions and 9 deletions

View File

@ -201,6 +201,34 @@ module.exports = {
}],
"unicorn/prefer-query-selector": "off",
"unicorn/prefer-node-append": "off",
"unicorn/no-zero-fractions": "off"
"unicorn/no-zero-fractions": "off",
"jsdoc/require-file-overview": ["error", {
tags: {
file: {
"initialCommentsOnly": true,
"preventDuplicates": true,
},
license: {
"initialCommentsOnly": true,
"preventDuplicates": true,
},
copyright: {
"initialCommentsOnly": true,
"preventDuplicates": true,
},
author: {
"initialCommentsOnly": true,
"preventDuplicates": true,
},
module: {
"initialCommentsOnly": true,
"preventDuplicates": true,
},
exports: {
"initialCommentsOnly": true,
"preventDuplicates": true,
}
}
}]
}
};

View File

@ -16,7 +16,8 @@
- Refactoring: Ensure file-global tags are at beginning of file
- Linting (ESLint): Simplify regexes
- Linting (ESLint): Replace `innerHTML` with `textContent` from old demo
- Linting (ESLint): Update as per latest ash-nazg (bad jsdoc)
- Linting (ESLint): Update as per latest ash-nazg
- Linting (ESLint): Add rules to check for file-level tags
- Testing: Switch to Cypress with code coverage for UI testing;
use ESM version for faster debugging
- Testing: Add map file for underscore

2
dist/index-es.js vendored
View File

@ -9375,6 +9375,8 @@ var injectExtendedContextMenuItemsIntoDom = function injectExtendedContextMenuIt
});
};
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule

File diff suppressed because one or more lines are too long

2
dist/index-umd.js vendored
View File

@ -9381,6 +9381,8 @@
});
};
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule

File diff suppressed because one or more lines are too long

View File

@ -11280,6 +11280,8 @@ var SvgCanvas = (function () {
}
};
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule

File diff suppressed because one or more lines are too long

View File

@ -1,3 +1,4 @@
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule

View File

@ -9378,6 +9378,8 @@
});
};
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule

6
package-lock.json generated
View File

@ -4418,9 +4418,9 @@
}
},
"eslint-plugin-jsdoc": {
"version": "19.1.0",
"resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-19.1.0.tgz",
"integrity": "sha512-rw8ouveUzz41dgSCyjlZgh5cKuQIyBzsrJnKeGYoY74+9AXuOygAQMwvyN4bMRp0hJu0DYQptKyQiSBqOnXmTg==",
"version": "19.2.0",
"resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-19.2.0.tgz",
"integrity": "sha512-QdNifBFLXCDGdy+26RXxcrqzEZarFWNybCZQVqJQYEYPlxd6lm+LPkrs6mCOhaGc2wqC6zqpedBQFX8nQJuKSw==",
"dev": true,
"requires": {
"comment-parser": "^0.7.2",

View File

@ -144,7 +144,7 @@
"eslint-plugin-eslint-comments": "^3.1.2",
"eslint-plugin-html": "^6.0.0",
"eslint-plugin-import": "^2.19.1",
"eslint-plugin-jsdoc": "^19.1.0",
"eslint-plugin-jsdoc": "^19.2.0",
"eslint-plugin-markdown": "^1.0.1",
"eslint-plugin-no-unsanitized": "^3.0.2",
"eslint-plugin-no-use-extend-native": "^0.4.1",

View File

@ -9378,6 +9378,8 @@
});
};
/* eslint-disable jsdoc/require-file-overview */
/**
* Adapted from {@link https://github.com/uupaa/dynamic-import-polyfill/blob/master/importModule.js}.
* @module importModule