Skip to content

Commit

Permalink
Disable JSDoc requirements that are not upheld anyway
Browse files Browse the repository at this point in the history
  • Loading branch information
fatso83 committed Oct 20, 2023
1 parent 11a8e3f commit d2a16b9
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ plugins:

rules:
"@sinonjs/no-prototype-methods/no-prototype-methods": error
"jsdoc/require-param-type": off
"jsdoc/require-jsdoc": off
"jsdoc/tag-lines": off
2 changes: 2 additions & 0 deletions lib/sinon/proxy-call.js
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ callProto.invokeCallback = callProto.yield;
* @param exception
* @param id
* @param errorWithCallStack
*
* @returns {object} proxyCall
*/
function createProxyCall(
proxy,
Expand Down
6 changes: 5 additions & 1 deletion lib/sinon/spy-formatters.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ const slice = arrayProto.slice;
* @param matcher
* @param calledArg
* @param calledArgMessage
*
* @returns {string} the colored text
*/
function colorSinonMatchText(matcher, calledArg, calledArgMessage) {
let calledArgumentMessage = calledArgMessage;
Expand All @@ -32,8 +34,9 @@ function colorSinonMatchText(matcher, calledArg, calledArgMessage) {
}

/**
*
* @param diff
*
* @returns {string} the colored diff
*/
function colorDiffText(diff) {
const objects = map(diff, function (part) {
Expand All @@ -54,6 +57,7 @@ function colorDiffText(diff) {
/**
*
* @param value
* @returns {string} a quoted string
*/
function quoteStringValue(value) {
if (typeof value === "string") {
Expand Down
2 changes: 2 additions & 0 deletions lib/sinon/util/fake-timers.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ const globalObject = require("@sinonjs/commons").global;
*
* @param config
* @param globalCtx
*
* @returns {object} the clock, after installing it on the global context, if given
*/
function createClock(config, globalCtx) {
let FakeTimersCtx = FakeTimers;
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"dev-docs": "cd docs; rsync -r --delete release-source/ releases/dev; npm run serve-docs",
"build-docs": "cd docs; bundle exec jekyll build",
"serve-docs": "cd docs; bundle exec jekyll serve --incremental --verbose --livereload",
"lint": "eslint --max-warnings 101 '**/*.{js,cjs,mjs}'",
"lint": "eslint --max-warnings 0 '**/*.{js,cjs,mjs}'",
"unimported": "unimported .",
"pretest-webworker": "npm run build",
"prebuild": "rimraf pkg && npm run check-dependencies",
Expand Down

0 comments on commit d2a16b9

Please sign in to comment.