ESLint fixes

JamesMessinger · JamesMessinger · commit 93ffa8f6f51a · 2020-07-19T06:24:32.000-05:00
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -4,3 +4,6 @@
 
 root: true
 extends: "@jsdevtools"
+env:
+  node: true
+  browser: true
diff --git a/lib/index.d.ts b/lib/index.d.ts
diff --git a/lib/index.js b/lib/index.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-unused-vars */
 "use strict";
 
 const $Refs = require("./refs");
diff --git a/lib/parsers/json.js b/lib/parsers/json.js
@@ -36,7 +36,7 @@ module.exports = {
    * @param {*}      file.data      - The file contents. This will be whatever data type was returned by the resolver
    * @returns {Promise}
    */
-  async parse (file) {
+  async parse (file) {      // eslint-disable-line require-await
     let data = file.data;
     if (Buffer.isBuffer(data)) {
       data = data.toString();
diff --git a/lib/parsers/yaml.js b/lib/parsers/yaml.js
@@ -37,7 +37,7 @@ module.exports = {
    * @param {*}      file.data      - The file contents. This will be whatever data type was returned by the resolver
    * @returns {Promise}
    */
-  async parse (file) {
+  async parse (file) {      // eslint-disable-line require-await
     let data = file.data;
     if (Buffer.isBuffer(data)) {
       data = data.toString();
diff --git a/lib/ref.js b/lib/ref.js
@@ -3,7 +3,7 @@
 module.exports = $Ref;
 
 const Pointer = require("./pointer");
-const { JSONParserError, JSONParserErrorGroup, ParserError, MissingPointerError, ResolverError, InvalidPointerError, isHandledError, normalizeError } = require("./util/errors");
+const { InvalidPointerError, isHandledError, normalizeError } = require("./util/errors");
 const { safePointerToPath, stripHash, getHash } = require("./util/url");
 
 /**
diff --git a/lib/refs.js b/lib/refs.js
@@ -41,7 +41,7 @@ function $Refs () {
  * @param {...string|string[]} [types] - Only return paths of the given types ("file", "http", etc.)
  * @returns {string[]}
  */
-$Refs.prototype.paths = function (types) {
+$Refs.prototype.paths = function (types) {    // eslint-disable-line no-unused-vars
   let paths = getPaths(this._$refs, arguments);
   return paths.map((path) => {
     return path.decoded;
@@ -54,7 +54,7 @@ $Refs.prototype.paths = function (types) {
  * @param {...string|string[]} [types] - Only return references of the given types ("file", "http", etc.)
  * @returns {object}
  */
-$Refs.prototype.values = function (types) {
+$Refs.prototype.values = function (types) {   // eslint-disable-line no-unused-vars
   let $refs = this._$refs;
   let paths = getPaths($refs, arguments);
   return paths.reduce((obj, path) => {
diff --git a/test/specs/callbacks.spec.js b/test/specs/callbacks.spec.js
@@ -21,8 +21,8 @@ describe("Callback & Promise syntax", () => {
       let parser = new $RefParser();
       parser[method](path.rel("specs/internal/internal.yaml"), (err, result) => {
         try {
-          expect(err).to.be.null;
-          expect(result).to.be.an("object").and.ok;
+          expect(err).to.equal(null);
+          expect(result).to.be.an("object");
 
           if (method === "resolve") {
             expect(result).to.equal(parser.$refs);
@@ -44,7 +44,7 @@ describe("Callback & Promise syntax", () => {
       $RefParser[method](path.rel("specs/invalid/invalid.yaml"), (err, result) => {
         try {
           expect(err).to.be.an.instanceOf(ParserError);
-          expect(result).to.be.undefined;
+          expect(result).to.equal(undefined);
           done();
         }
         catch (e) {
@@ -59,7 +59,7 @@ describe("Callback & Promise syntax", () => {
       let parser = new $RefParser();
       return parser[method](path.rel("specs/internal/internal.yaml"))
         .then((result) => {
-          expect(result).to.be.an("object").and.ok;
+          expect(result).to.be.an("object");
 
           if (method === "resolve") {
             expect(result).to.equal(parser.$refs);
diff --git a/test/specs/deep/dereferenced.js b/test/specs/deep/dereferenced.js
@@ -1,7 +1,5 @@
 "use strict";
 
-const helper = require("../../utils/helper");
-
 let name = {
   required: [
     "first",
diff --git a/test/specs/empty/empty.spec.js b/test/specs/empty/empty.spec.js
@@ -10,7 +10,7 @@ describe("Empty schema", () => {
     let parser = new $RefParser();
     const schema = await parser.parse(path.rel("specs/empty/empty.json"));
     expect(schema).to.be.an("object");
-    expect(schema).to.be.empty;
+    expect(schema).to.be.empty;  // eslint-disable-line no-unused-expressions
     expect(parser.schema).to.equal(schema);
     expect(parser.$refs.paths()).to.deep.equal([path.abs("specs/empty/empty.json")]);
   });
@@ -24,7 +24,7 @@ describe("Empty schema", () => {
     let parser = new $RefParser();
     const schema = await parser.dereference(path.rel("specs/empty/empty.json"));
     expect(schema).to.be.an("object");
-    expect(schema).to.be.empty;
+    expect(schema).to.be.empty;  // eslint-disable-line no-unused-expressions
     expect(parser.schema).to.equal(schema);
     expect(parser.$refs.paths()).to.deep.equal([path.abs("specs/empty/empty.json")]);
     // The "circular" flag should NOT be set
@@ -35,7 +35,7 @@ describe("Empty schema", () => {
     let parser = new $RefParser();
     const schema = await parser.bundle(path.rel("specs/empty/empty.json"));
     expect(schema).to.be.an("object");
-    expect(schema).to.be.empty;
+    expect(schema).to.be.empty;  // eslint-disable-line no-unused-expressions
     expect(parser.schema).to.equal(schema);
     expect(parser.$refs.paths()).to.deep.equal([path.abs("specs/empty/empty.json")]);
   });
diff --git a/test/specs/exports.spec.js b/test/specs/exports.spec.js
@@ -1,3 +1,4 @@
+/* eslint-disable require-await */
 "use strict";
 
 const { expect } = require("chai");
diff --git a/test/specs/http.spec.js b/test/specs/http.spec.js
@@ -157,7 +157,7 @@ describe("HTTP options", () => {
       let schema = await parser.parse("https://petstore.swagger.io/v2/swagger.json");
 
       expect(schema).to.be.an("object");
-      expect(schema).not.to.be.empty;
+      expect(schema).not.to.be.empty;  // eslint-disable-line no-unused-expressions
       expect(parser.schema).to.equal(schema);
     });
 
@@ -171,7 +171,7 @@ describe("HTTP options", () => {
       });
 
       expect(schema).to.be.an("object");
-      expect(schema).not.to.be.empty;
+      expect(schema).not.to.be.empty;  // eslint-disable-line no-unused-expressions
       expect(parser.schema).to.equal(schema);
     });
 
@@ -188,7 +188,7 @@ describe("HTTP options", () => {
 
           // The request succeeded, which means this browser doesn't support CORS.
           expect(schema).to.be.an("object");
-          expect(schema).not.to.be.empty;
+          expect(schema).not.to.be.empty;  // eslint-disable-line no-unused-expressions
           expect(parser.schema).to.equal(schema);
         }
         catch (err) {
diff --git a/test/specs/invalid/invalid.spec.js b/test/specs/invalid/invalid.spec.js
@@ -176,7 +176,7 @@ describe("Invalid syntax", () => {
       it("should not throw an error for an invalid YAML file with JSON and YAML disabled", async () => {
         const parser = new $RefParser();
         const result = await parser.dereference(path.rel("specs/invalid/invalid.yaml"), { continueOnError: true, parse: { yaml: false, json: false }});
-        expect(result).to.be.null;
+        expect(result).to.equal(null);
       });
     });
   });
diff --git a/test/specs/missing-pointers/missing-pointers.spec.js b/test/specs/missing-pointers/missing-pointers.spec.js
@@ -7,7 +7,6 @@ const { expect } = chai;
 const $RefParser = require("../../../lib");
 const { JSONParserErrorGroup, MissingPointerError } = require("../../../lib/util/errors");
 const helper = require("../../utils/helper");
-const path = require("../../utils/path");
 
 describe("Schema with missing pointers", () => {
   it("should throw an error for missing pointer", async () => {
diff --git a/test/specs/refs.spec.js b/test/specs/refs.spec.js
@@ -13,7 +13,7 @@ describe("$Refs object", () => {
   describe("paths", () => {
     it("should only contain the main file when calling `parse()`", async () => {
       let parser = new $RefParser();
-      const schema = await parser.parse(path.abs("specs/external/external.yaml"));
+      await parser.parse(path.abs("specs/external/external.yaml"));
       let paths = parser.$refs.paths();
       expect(paths).to.have.same.members([
         path.abs("specs/external/external.yaml")
@@ -125,7 +125,7 @@ describe("$Refs object", () => {
         expect(values).to.deep.equal(expected);
       }
       else {
-        expect(values).to.be.an("object").and.empty;
+        expect(values).to.be.an("object").and.empty;  // eslint-disable-line no-unused-expressions
       }
     });
 
@@ -143,7 +143,7 @@ describe("$Refs object", () => {
         expect(values).to.deep.equal(expected);
       }
       else {
-        expect(values).to.be.an("object").and.empty;
+        expect(values).to.be.an("object").and.empty;  // eslint-disable-line no-unused-expressions
       }
     });
   });
@@ -152,25 +152,25 @@ describe("$Refs object", () => {
     it("should work with absolute paths", async () => {
       const $refs = await $RefParser
         .resolve(path.abs("specs/external/external.yaml"));
-      expect($refs.exists(path.abs("specs/external/external.yaml"))).to.be.true;
-      expect($refs.exists(path.abs("specs/external/definitions/definitions.json"))).to.be.true;
-      expect($refs.exists(path.abs("specs/external/definitions/name.yaml"))).to.be.true;
-      expect($refs.exists(path.abs("specs/external/definitions/required-string.yaml"))).to.be.true;
+      expect($refs.exists(path.abs("specs/external/external.yaml"))).to.equal(true);
+      expect($refs.exists(path.abs("specs/external/definitions/definitions.json"))).to.equal(true);
+      expect($refs.exists(path.abs("specs/external/definitions/name.yaml"))).to.equal(true);
+      expect($refs.exists(path.abs("specs/external/definitions/required-string.yaml"))).to.equal(true);
     });
 
     it("should work with relative paths", async () => {
       const $refs = await $RefParser
         .resolve(path.abs("specs/external/external.yaml"));
-      expect($refs.exists("external.yaml")).to.be.true;
-      expect($refs.exists("definitions/definitions.json")).to.be.true;
-      expect($refs.exists("definitions/name.yaml")).to.be.true;
-      expect($refs.exists("definitions/required-string.yaml")).to.be.true;
+      expect($refs.exists("external.yaml")).to.equal(true);
+      expect($refs.exists("definitions/definitions.json")).to.equal(true);
+      expect($refs.exists("definitions/name.yaml")).to.equal(true);
+      expect($refs.exists("definitions/required-string.yaml")).to.equal(true);
     });
 
     it("should return false if the $ref does not exist", async () => {
       const $refs = await $RefParser
         .resolve(path.abs("specs/external/external.yaml"));
-      expect($refs.exists("foo bar")).to.be.false;
+      expect($refs.exists("foo bar")).to.equal(false);
     });
   });
 
diff --git a/test/specs/resolvers/resolvers.spec.js b/test/specs/resolvers/resolvers.spec.js
@@ -50,7 +50,7 @@ describe("options.resolve", () => {
           // A custom resolver for "foo://" URLs
           foo: {
             canRead: /^foo\:\/\//i,
-            read (file) {
+            read (_file) {
               return { bar: { baz: "hello world" }};
             }
           }
@@ -66,7 +66,7 @@ describe("options.resolve", () => {
           // A custom resolver for "foo://" URLs
           foo: {
             canRead: /^foo\:\/\//i,
-            read (file, callback) {
+            read (_file, callback) {
               callback(null, { bar: { baz: "hello world" }});
             }
           }
@@ -83,7 +83,7 @@ describe("options.resolve", () => {
             // A custom resolver for "foo://" URLs
             foo: {
               canRead: /^foo\:\/\//i,
-              read (file) {
+              read (_file) {
                 return Promise.resolve({ bar: { baz: "hello world" }});
               }
             }
@@ -101,7 +101,7 @@ describe("options.resolve", () => {
           badResolver: {
             order: 1,
             canRead: true,
-            read (file) {
+            read (_file) {
               throw new Error("BOMB!!!");
             }
           },
diff --git a/test/specs/typescript-definition.spec.ts b/test/specs/typescript-definition.spec.ts
@@ -1,13 +1,13 @@
-import $RefParser = require('../../lib');
-import assert = require("assert");
+import * as assert from "assert";
+import * as $RefParser from "../../lib";
 
 const baseUrl = "http://example.com/schema";
 const schemaPath = "my-schema.json";
 const schemaObject: $RefParser.JSONSchema = { title: "my-schema" };
 const options = {};
-const promiseResolve = (schema: object) => undefined;
-const promiseReject = (err: Error) => undefined;
-const callback = (err: Error | null, schema?: object) => undefined;
+const promiseResolve = (_: object) => undefined;
+const promiseReject = (_: Error) => undefined;
+const callback = (_err: Error | null, _schema?: object) => undefined;
 
 
 // $RefParser class instance

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+/* eslint-disable no-unused-vars */`
`1`	`2`	`"use strict";`
`2`	`3`
`3`	`4`	`const $Refs = require("./refs");`