Fix linting issues after upgrade

sinonjs · May 7, 2024 · 794aea4 · 794aea4
1 parent 2fae20b
commit 794aea4
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 4 deletions.
diff --git a/lib/sinon/util/core/get-property-descriptor.js b/lib/sinon/util/core/get-property-descriptor.js
@@ -1,8 +1,18 @@
 "use strict";
 
-/* eslint-disable jsdoc/valid-types */
+/**
+ * @typedef {object} PropertyDescriptor
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty#description
+ * @property {boolean} configurable defaults to false
+ * @property {boolean} enumerable   defaults to false
+ * @property {boolean} writable     defaults to false
+ * @property {*} value defaults to undefined
+ * @property {Function} get defaults to undefined
+ * @property {Function} set defaults to undefined
+ */
+
 /*
- * The following type def is strictly an illegal JSDoc, but the expression forms a
+ * The following type def is strictly speaking illegal in JSDoc, but the expression forms a
  * legal Typescript union type and is understood by Visual Studio and the IntelliJ
  * family of editors. The "TS" flavor of JSDoc is becoming the de-facto standard these
  * days for that reason (and the fact that JSDoc is essentially unmaintained)
@@ -13,7 +23,6 @@
  * a slightly enriched property descriptor
  * @property {boolean} isOwn true if the descriptor is owned by this object, false if it comes from the prototype
  */
-/* eslint-enable jsdoc/valid-types */
 
 /**
  * Returns a slightly modified property descriptor that one can tell is from the object or the prototype

diff --git a/test/es2015/module-support-assessment-test.mjs b/test/es2015/module-support-assessment-test.mjs
@@ -19,7 +19,7 @@ import sinon from "../../pkg/sinon-esm.js";
 const { assert, refute } = referee;
 
 /**
- * @param action
+ * @param action {string} the export on the `sinon` namespace to test
  */
 function createTestSuite(action) {
     var stub;

diff --git a/test/issues/issues-test.js b/test/issues/issues-test.js
@@ -681,6 +681,7 @@ describe("issues", function () {
         };
 
         let sandbox;
+
         beforeEach(function () {
             sandbox = sinon.createStubInstance(Foo);
         });

diff --git a/test/proxy-call-test.js b/test/proxy-call-test.js
@@ -216,6 +216,7 @@ describe("sinonSpy.call", function () {
     describe("call.calledWithMatch", spyCallCalledTests("calledWithMatch"));
     // eslint-disable-next-line mocha/no-setup-in-describe
     describe("call.notCalledWith", spyCallNotCalledTests("notCalledWith"));
+
     describe(
         "call.notCalledWithMatch",
         // eslint-disable-next-line mocha/no-setup-in-describe

diff --git a/test/proxy-test.js b/test/proxy-test.js
@@ -43,6 +43,7 @@ describe("proxy", function () {
                 });
                 assert.equals(named.printf("%n"), "cool");
             });
+
             it("anon", function () {
                 const anon = sinonSpy(function () {
                     return;

diff --git a/test/spy-test.js b/test/spy-test.js
@@ -1113,6 +1113,7 @@ describe("spy", function () {
 
     // eslint-disable-next-line mocha/no-setup-in-describe
     describe(".alwaysCalledWith", spyAlwaysCalledTests("alwaysCalledWith"));
+
     describe(
         ".alwaysCalledWithMatch",
         // eslint-disable-next-line mocha/no-setup-in-describe
@@ -1168,6 +1169,7 @@ describe("spy", function () {
 
     // eslint-disable-next-line mocha/no-setup-in-describe
     describe(".neverCalledWith", spyNeverCalledTests("neverCalledWith"));
+
     describe(
         ".neverCalledWithMatch",
         // eslint-disable-next-line mocha/no-setup-in-describe

diff --git a/test/stub-test.js b/test/stub-test.js
@@ -1066,6 +1066,7 @@ describe("stub", function () {
 
         describe("lazy instantiation of exceptions", function () {
             let errorSpy;
+
             beforeEach(function () {
                 this.originalError = globalContext.Error;
                 errorSpy = createSpy(globalContext, "Error");