gulp-eslint-new 1.4.1 → 1.4.2

package/index.d.ts

@@ -87,7 +87,7 @@ declare const gulpESLintNew: {
 	/**
 	 * Append ESLint result to each file.
 	 *
-	 * @param options Options for gulp-eslint-new.
+	 * @param options - Options for gulp-eslint-new.
 	 * @returns gulp file stream.
 	 */
 	(options?: GulpESLintOptions): NodeJS.ReadWriteStream;
@@ -95,7 +95,7 @@ declare const gulpESLintNew: {
 	/**
 	 * Append ESLint result to each file.
 	 *
-	 * @param overrideConfigFile The path to a configuration file.
+	 * @param overrideConfigFile - The path to a configuration file.
 	 * @returns gulp file stream.
 	 */
 	(overrideConfigFile?: string): NodeJS.ReadWriteStream;
@@ -133,10 +133,10 @@ declare const gulpESLintNew: {
 	/**
 	 * Format the results of each file individually.
 	 *
-	 * @param formatter
+	 * @param formatter -
 	 * A name or path of a formatter, a formatter object or a formatter function.
 	 * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
-	 * @param writer
+	 * @param writer -
 	 * A funtion or stream to write the formatted ESLint results.
 	 * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
 	 * @returns gulp file stream.
@@ -149,10 +149,10 @@ declare const gulpESLintNew: {
 	/**
 	 * Wait until all files have been linted and format all results at once.
 	 *
-	 * @param formatter
+	 * @param formatter -
 	 * A name or path of a formatter, a formatter object or a formatter function.
 	 * Defaults to the [stylish](https://eslint.org/docs/user-guide/formatters/#stylish) formatter.
-	 * @param writer
+	 * @param writer -
 	 * A funtion or stream to write the formatted ESLint results.
 	 * Defaults to gulp's [fancy-log](https://github.com/gulpjs/fancy-log#readme).
 	 * @returns gulp file stream.
@@ -161,5 +161,12 @@ declare const gulpESLintNew: {
 		formatter?: string | ESLint.Formatter | FormatterFunction,
 		writer?: GulpESLintWriter | NodeJS.WritableStream
 	): NodeJS.ReadWriteStream;
+
+	/**
+	 * Overwrite source files with the fixed content provided by ESLint if present.
+	 *
+	 * @returns gulp file stream.
+	 */
+	fix(): NodeJS.ReadWriteStream;
 };
 export default gulpESLintNew;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "gulp-eslint-new",
-	"version": "1.4.1",
+	"version": "1.4.2",
 	"description": "A gulp plugin to lint code with ESLint 8",
 	"keywords": [
 		"gulpplugin",
@@ -52,6 +52,7 @@
 		"@typescript-eslint/parser": "^5.12.1",
 		"c8": "^7.11.0",
 		"eslint-plugin-eslint-comments": "^3.2.0",
+		"eslint-plugin-tsdoc": "^0.2.14",
 		"gulp": "^4.0.2",
 		"mocha": "^9.2.1",
 		"typescript": "^4.5.5",

package/util.js

@@ -285,9 +285,9 @@ function throwInvalidOptionError(message) {
 /**
  * Convert a string array to a boolean map.
  *
- * @param {string[]|null} keys The keys to assign true.
- * @param {boolean} defaultValue The default value for each property.
- * @param {string} displayName The property name which is used in error message.
+ * @param {string[]|null} keys - The keys to assign true.
+ * @param {boolean} defaultValue - The default value for each property.
+ * @param {string} displayName - The property name which is used in error message.
  * @returns {Record<string,boolean>} The boolean map.
  */
 function toBooleanMap(keys, defaultValue, displayName) {