Merge pull request #510 from Fdawgs/test/coverage

.eslintrc.js

@@ -1,32 +1,44 @@
 module.exports = {
 	env: {
-		es2017: true,
+		es2019: true,
 		node: true,
 	},
 	extends: [
 		"airbnb-base",
 		"plugin:promise/recommended",
-		"plugin:jest/recommended",
-		"plugin:jest/style",
 		"plugin:jsdoc/recommended",
 		"plugin:security/recommended",
 		"plugin:security-node/recommended",
 		"prettier",
 	],
+	overrides: [
+		{
+			extends: ["plugin:jest/recommended", "plugin:jest/style"],
+			files: ["src/**/*.test.js"],
+			plugins: ["jest"],
+			rules: {
+				"jest/no-duplicate-hooks": "error",
+				"jest/no-test-return-statement": "error",
+				"jest/prefer-comparison-matcher": "error",
+				"jest/prefer-each": "warn",
+				"jest/prefer-equality-matcher": "error",
+				"jest/prefer-expect-resolves": "error",
+				"jest/prefer-hooks-in-order": "error",
+				"jest/prefer-hooks-on-top": "error",
+				"jest/prefer-mock-promise-shorthand": "error",
+				"jest/prefer-spy-on": "error",
+				"jest/require-top-level-describe": "error",
+			},
+		},
+	],
 	parserOptions: {
 		ecmaVersion: 2019,
 	},
-	plugins: [
-		"import",
-		"jest",
-		"jsdoc",
-		"promise",
-		"security",
-		"security-node",
-	],
+	plugins: ["import", "jsdoc", "promise", "security", "security-node"],
 	root: true,
 	rules: {
 		"import/no-extraneous-dependencies": "error",
+		"jsdoc/require-hyphen-before-param-description": "error",
 		"no-console": "off",
 		"no-multiple-empty-lines": ["error", { max: 1 }],
 		"prefer-destructuring": ["error", { object: true, array: false }],

src/index.js

@@ -554,7 +554,7 @@ class Poppler {
 	 *
 	 * If not set then the output filename will be derived from the PDF file name.
 	 * @param {object=} options - Object containing options to pass to binary.
-	 * @param {('default'|'none'|'gray'|'subpixel'|'fast'|'good'|'best')=} options.antialias Set the cairo
+	 * @param {('default'|'none'|'gray'|'subpixel'|'fast'|'good'|'best')=} options.antialias - Set the cairo
 	 * antialias option used for text and drawing in image files (or rasterized regions in vector output).
 	 * @param {boolean=} options.cropBox - Uses the crop box rather than media box when
 	 * generating the files (PNG/JPEG/TIFF only).
@@ -1359,7 +1359,7 @@ class Poppler {
 	 * @param {number=} options.firstPageToConvert - Specifies the first page to convert.
 	 * @param {number=} options.fixedWidthLayout - Assume fixed-pitch (or tabular) text, with the
 	 * specified character width (in points). This forces physical layout mode.
-	 * @param {boolean=} options.generateHtmlMetaFile Generate simple HTML file, including the
+	 * @param {boolean=} options.generateHtmlMetaFile - Generate simple HTML file, including the
 	 * meta information. This simply wraps the text in `<pre>` and `</pre>` and prepends the meta headers.
 	 * @param {boolean=} options.generateTsvFile - Generate a TSV file containing the bounding box
 	 * information for each block, line, and word in the file.