gulp-prettier 6.0.0 → 7.0.0

package/README.md

@@ -6,7 +6,7 @@
 
 ## Install
 
-```
+```sh
 npm install gulp-prettier --save-dev
 ```
 
@@ -41,7 +41,7 @@ export default validate;
 
 ## API
 
-### prettier([options])
+### prettier(?options)
 
 Formats your files using Prettier.
 
@@ -53,7 +53,7 @@ Consult the Prettier [options](https://prettier.io/docs/en/options.html).
 
 `editorconfig: true` can also be passed to enable [EditorConfig support](https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options).
 
-### prettier.check([options])
+### prettier.check(?options)
 
 Checks if your files have been formatted with Prettier and, if not, throws an error with a list of unformatted files. This is useful for running Prettier in CI scenarios.
 

package/index.js

@@ -8,21 +8,25 @@ import prettier from 'prettier';
 export default function plugin(options = {}) {
 	return new Transform({
 		objectMode: true,
-		async transform(file, encoding, callback) {
+
+		async transform(file, _, callback) {
 			if (file.isNull()) {
-				return callback(null, file);
-			}
+				callback(null, file);
 
-			if (file.isStream()) {
-				return callback(new PluginError('gulp-prettier', 'Streaming not supported'));
+				return;
 			}
 
-			const config = await prettier.resolveConfig(file.path, options);
-			const fileOptions = {...config, ...options, filepath: file.path};
+			if (file.isStream()) {
+				callback(new PluginError('gulp-prettier', 'Streaming not supported'));
 
-			const unformattedCode = file.contents.toString('utf8');
+				return;
+			}
 
 			try {
+				const config = await prettier.resolveConfig(file.path, options);
+				const fileOptions = {...config, ...options, filepath: file.path};
+
+				const unformattedCode = file.contents.toString('utf8');
 				const formattedCode = await prettier.format(unformattedCode, fileOptions);
 
 				if (formattedCode !== unformattedCode) {
@@ -30,69 +34,68 @@ export default function plugin(options = {}) {
 					file.contents = Buffer.from(formattedCode);
 				}
 
-				this.push(file);
+				callback(null, file);
 			} catch (error) {
-				this.emit(
-					'error',
-					new PluginError('gulp-prettier', error, {fileName: file.path}),
-				);
+				callback(new PluginError('gulp-prettier', error, {fileName: file.path}));
 			}
-
-			callback();
 		},
 	});
 }
 
 plugin.check = function (options = {}) {
-	const unformattedFiles = [];
-
 	return new Transform({
 		objectMode: true,
-		async transform(file, encoding, callback) {
+
+		construct(callback) {
+			this.unformattedFiles = [];
+
+			callback();
+		},
+
+		async transform(file, _, callback) {
 			if (file.isNull()) {
-				return callback(null, file);
-			}
+				callback(null, file);
 
-			if (file.isStream()) {
-				return callback(
-					new PluginError('gulp-prettier', 'Streaming not supported'),
-				);
+				return;
 			}
 
-			const config = await prettier.resolveConfig(file.path, options);
-			const fileOptions = {...config, ...options, filepath: file.path};
+			if (file.isStream()) {
+				callback(new PluginError('gulp-prettier', 'Streaming not supported'));
 
-			const unformattedCode = file.contents.toString('utf8');
+				return;
+			}
 
 			try {
+				const config = await prettier.resolveConfig(file.path, options);
+				const fileOptions = {...config, ...options, filepath: file.path};
+
+				const unformattedCode = file.contents.toString('utf8');
 				const isFormatted = await prettier.check(unformattedCode, fileOptions);
 
 				if (!isFormatted) {
 					const filename = path
 						.relative(process.cwd(), file.path)
 						.replaceAll('\\', '/');
-					unformattedFiles.push(filename);
+					this.unformattedFiles.push(filename);
 				}
 
-				this.push(file);
+				callback(null, file);
 			} catch (error) {
-				this.emit(
-					'error',
-					new PluginError('gulp-prettier', error, {fileName: file.path}),
-				);
+				callback(new PluginError('gulp-prettier', error, {fileName: file.path}));
 			}
-
-			callback();
 		},
+
 		flush(callback) {
-			if (unformattedFiles.length > 0) {
+			if (this.unformattedFiles.length > 0) {
 				const header
-          = 'Code style issues found in the following file(s). Forgot to run Prettier?';
-				const body = unformattedFiles.join('\n');
+					= 'Code style issues found in the following file(s). Forgot to run Prettier?';
+				const body = this.unformattedFiles.join('\n');
 
 				const message = `${header}\n${body}`;
 
-				this.emit('error', new PluginError('gulp-prettier', message));
+				callback(new PluginError('gulp-prettier', message));
+
+				return;
 			}
 
 			callback();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-prettier",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Format files with Prettier",
   "license": "MIT",
   "repository": "thomasvantuycom/gulp-prettier",
@@ -12,7 +12,7 @@
   "type": "module",
   "exports": "./index.js",
   "engines": {
-    "node": ">=18"
+    "node": ">=24"
   },
   "scripts": {
     "test": "xo && ava"
@@ -27,17 +27,17 @@
     "gulpplugin"
   ],
   "dependencies": {
-    "plugin-error": "^2.0.0",
-    "prettier": "^3.0.0"
+    "plugin-error": "^2.0.1",
+    "prettier": "^3.9.5"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.0",
-    "@semantic-release/git": "^10.0.0",
-    "ava": "^5.1.0",
-    "p-event": "^6.0.0",
-    "semantic-release": "^22.0.0",
-    "vinyl": "^3.0.0",
-    "xo": "^0.56.0"
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "ava": "^8.0.1",
+    "p-event": "^7.1.0",
+    "semantic-release": "^25.0.7",
+    "vinyl": "^3.0.1",
+    "xo": "^4.0.0"
   },
   "release": {
     "plugins": [
@@ -53,5 +53,10 @@
       ],
       "@semantic-release/github"
     ]
+  },
+  "xo": {
+    "rules": {
+      "markdown/no-multiple-h1": "off"
+    }
   }
 }