gulp-prettier 3.0.0 → 5.0.0

package/LICENSE

@@ -1,6 +1,7 @@
 The MIT License
 
-Copyright (c) 2016-2019 Patel, Bhargav R.
+Copyright (c) 2016-2020 Patel, Bhargav R.
+Copyright (c) 2020 Thomas Vantuycom
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,6 @@
-# Gulp Prettier [![Build Status](https://travis-ci.org/bhargavrpatel/gulp-prettier.svg?branch=master)](https://travis-ci.org/bhargavrpatel/gulp-prettier)
+# gulp-prettier ![GitHub Workflow Status](https://github.com/TheDancingCode/gulp-prettier/actions/workflows/ci.yml/badge.svg) [![npm version](https://img.shields.io/npm/v/gulp-prettier.svg)](https://www.npmjs.com/package/gulp-prettier) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-A [Gulp](http://gulpjs.com/) plugin which allows the users to use [Prettier](https://github.com/jlongster/prettier).
-
-> Prettier is an opinionated JavaScript formatter inspired by refmt with advanced support for language features from ES2017, JSX, and Flow. It removes all original styling and ensures that all outputted JavaScript conforms to a consistent style. (See this blog post)
-
-> _NOTE_: To ensure this plugin continues to serve its usefulness, I've added @TheDancingCode as the active collaborator. He will be the active maintainer - BRP (April 26, 2018)
+> Format files with [Prettier](https://github.com/prettier/prettier)
 
 ## Install
 
@@ -14,29 +10,31 @@ npm install gulp-prettier --save-dev
 
 ## Usage
 
-Simply pipe the input, and pass in arguments that you would to the regular format function.
-
 ```js
-const gulp = require('gulp');
+const { src, dest } = require('gulp');
 const prettier = require('gulp-prettier');
 
-gulp.task('default', () => {
-  return gulp.src('*.js')
+function format() {
+  return src('src/*.js')
     .pipe(prettier({ singleQuote: true }))
-    .pipe(gulp.dest('./dist'));
-});
+    .pipe(dest('dist'));
+}
+
+exports.default = format;
 ```
 
 To check whether or not your files adhere to Prettier's formatting, use `prettier.check`. This can be used as a validation step in CI scenarios.
 
 ```js
-const gulp = require('gulp');
+const { src, dest } = require('gulp');
 const prettier = require('gulp-prettier');
 
-gulp.task('validate', () => {
-  return gulp.src('*.js')
+function validate() {
+  return src('dist/*.js')
     .pipe(prettier.check({ singleQuote: true }));
-});
+}
+
+exports.default = validate;
 ```
 
 ## API
@@ -51,7 +49,7 @@ Type: `Object`
 
 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).
+`editorconfig: true` can also be passed to enable [EditorConfig support](https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options).
 
 ### prettier.check([options])
 
@@ -63,16 +61,8 @@ Type: `Object`
 
 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).
-
-## Collaborators
-
-I'd like to take this oppertunity to thank all of the contributors to this project:
-
-\- @akella
-\- @trusktr
-\- @TheDancingCode
+`editorconfig: true` can also be passed to enable [EditorConfig support](https://prettier.io/docs/en/api.html#prettierresolveconfigfilepath--options).
 
 ## License
 
-[MIT License](https://raw.githubusercontent.com/bhargavrpatel/gulp-prettier/master/LICENSE)
+MIT © [Bhargav R. Patel](https://github.com/bhargavrpatel), [Thomas Vantuycom](https://github.com/TheDancingCode)

package/index.js

@@ -9,7 +9,7 @@ const PLUGIN_NAME = 'gulp-prettier';
 module.exports = function (options) {
   options = options || {};
 
-  return through.obj(function (file, encoding, callback) {
+  return through.obj(async function (file, encoding, callback) {
     if (file.isNull()) {
       return callback(null, file);
     }
@@ -18,13 +18,13 @@ module.exports = function (options) {
       return callback(new PluginError(PLUGIN_NAME, 'Streaming not supported'));
     }
 
-    const config = prettier.resolveConfig.sync(file.path, options);
+    const config = await prettier.resolveConfig(file.path, options);
     const fileOptions = { ...config, ...options, filepath: file.path };
 
     const unformattedCode = file.contents.toString('utf8');
 
     try {
-      const formattedCode = prettier.format(unformattedCode, fileOptions);
+      const formattedCode = await prettier.format(unformattedCode, fileOptions);
 
       if (formattedCode !== unformattedCode) {
         file.isPrettier = true;
@@ -49,7 +49,7 @@ module.exports.check = function (options) {
   const unformattedFiles = [];
 
   return through.obj(
-    function (file, encoding, callback) {
+    async function (file, encoding, callback) {
       if (file.isNull()) {
         return callback(null, file);
       }
@@ -60,13 +60,13 @@ module.exports.check = function (options) {
         );
       }
 
-      const config = prettier.resolveConfig.sync(file.path, options);
+      const config = await prettier.resolveConfig(file.path, options);
       const fileOptions = { ...config, ...options, filepath: file.path };
 
       const unformattedCode = file.contents.toString('utf8');
 
       try {
-        const isFormatted = prettier.check(unformattedCode, fileOptions);
+        const isFormatted = await prettier.check(unformattedCode, fileOptions);
 
         if (!isFormatted) {
           const filename = path

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "gulp-prettier",
-  "description": "Create vinyl streams to pipe to prettier",
-  "version": "3.0.0",
+  "description": "Format files with Prettier",
+  "version": "5.0.0",
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bhargavrpatel/gulp-prettier.git"
+    "url": "https://github.com/TheDancingCode/gulp-prettier.git"
   },
   "scripts": {
-    "lint": "prettier --single-quote --write **/*.js && eslint .",
-    "pretest": "npm run lint",
-    "test": "mocha"
+    "test": "ava"
   },
   "files": [
     "index.js"
@@ -22,18 +20,36 @@
     "gulpplugin"
   ],
   "engines": {
-    "node": ">=10"
+    "node": ">=16"
   },
-  "author": "Bhargav R. Patel",
+  "author": "Thomas Vantuycom",
   "license": "MIT",
   "dependencies": {
-    "plugin-error": "^1.0.1",
-    "prettier": "^2.0.0",
-    "through2": "^3.0.0"
+    "plugin-error": "^2.0.0",
+    "prettier": "^3.0.0",
+    "through2": "^4.0.2"
   },
   "devDependencies": {
-    "eslint": "^6.8.0",
-    "mocha": "^7.1.1",
-    "vinyl": "^2.1.0"
+    "@semantic-release/changelog": "^5.0.0",
+    "@semantic-release/git": "^9.0.0",
+    "ava": "^5.1.0",
+    "p-event": "4.2.0",
+    "semantic-release": "^17.2.3",
+    "vinyl": "^3.0.0"
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/git",
+        {
+          "message": "release: ${nextRelease.version}"
+        }
+      ],
+      "@semantic-release/github"
+    ]
   }
 }

package/CHANGELOG.md

@@ -1,65 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## [3.0.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v2.3.0...v3.0.0) (2019-03-21)
-
-### Features
-
-* upgrade Prettier to v2.0.0 ([`af1a07c](https://github.com/bhargavrpatel/gulp-prettier/commit/af1a07c))
-
-### BREAKING CHANGES
-
-* drop support for Node versions 4, 6 and 8
-* [breaking changes in Prettier](https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes)
-
-
-## [2.3.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v2.2.0...v2.3.0) (2019-11-11)
-
-### Features
-
-* show filename on formatting error ([`565f3d3`](https://github.com/bhargavrpatel/gulp-prettier/commit/565f3d3))
-
-## [2.2.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v2.1.0...v2.2.0) (2019-10-21)
-
-### Features
-
-* support editorconfig ([`4047a03`](https://github.com/bhargavrpatel/gulp-prettier/commit/4047a03))
-
-## [2.1.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v2.0.0...v2.1.0) (2019-02-01)
-
-### Bug Fixes
-
-* upgrade through2 to v3.0.0 ([`7b16a27`](https://github.com/bhargavrpatel/gulp-prettier/commit/7b16a27))
-
-### Features
-
-* add `check` method for CI ([`5f67343`](https://github.com/bhargavrpatel/gulp-prettier/commit/5f67343))
-
-## [2.0.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v1.1.0...v2.0.0) (2018-05-01)
-
-### Bug Fixes
-
-* avoid deprecated new Buffer() ([`d007ff9`](https://github.com/bhargavrpatel/gulp-prettier/commit/d007ff9))
-* correct undeclared variable ([`c9abbbe`](https://github.com/bhargavrpatel/gulp-prettier/commit/c9abbbe))
-* use strict mode ([`cf7bec7`](https://github.com/bhargavrpatel/gulp-prettier/commit/cf7bec7))
-
-### Features
-
-* add support for languages other than js ([`2eb0ed9`](https://github.com/bhargavrpatel/gulp-prettier/commit/2eb0ed9))
-* adhere to .prettierrc ([`d44a6b0`](https://github.com/bhargavrpatel/gulp-prettier/commit/d44a6b0))
-* add `isPrettier` flag ([`7d790fd`](https://github.com/bhargavrpatel/gulp-prettier/commit/7d790fd))
-
-### BREAKING CHANGES
-
-* Upgrade Prettier to `^1.5.3` ([`7d790fd`](https://github.com/bhargavrpatel/gulp-prettier/commit/7d790fd))
-
-## [1.1.0](https://github.com/bhargavrpatel/gulp-prettier/compare/v1.0.0...v1.1.0) (2017-01-16)
-
-### Bug fixes
-
-* Add dependencies ([`0e4c3f5`](https://github.com/bhargavrpatel/gulp-prettier/commit/0e4c3f5))
-
-## [1.0.0](https://github.com/bhargavrpatel/gulp-prettier/compare/86f02f9cdf4bc840624c21e1679dc75fad525de5...v1.0.0) (2017-01-15)
-
-Initial release