{"_id":"gulp-plugin-prettier","_rev":"442289","name":"gulp-plugin-prettier","description":"Gulp plugin to format code with Prettier","dist-tags":{"latest":"2.0.1"},"maintainers":[{"name":"ikatyang","email":"ikatyang@gmail.com"}],"time":{"modified":"2021-08-05T06:38:27.000Z","created":"2017-07-23T09:21:13.676Z","2.0.1":"2020-06-02T14:07:43.759Z","2.0.0":"2019-08-31T08:46:33.427Z","1.1.0":"2017-09-20T13:57:06.918Z","1.0.0":"2017-07-23T09:21:13.676Z"},"users":{},"author":{"name":"Ika","email":"ikatyang@gmail.com","url":"https://github.com/ikatyang"},"repository":{"type":"git","url":"git+https://github.com/ikatyang/gulp-plugin-prettier.git"},"versions":{"2.0.1":{"name":"gulp-plugin-prettier","version":"2.0.1","description":"Gulp plugin to format code with Prettier","keywords":["gulp","gulpplugin","prettier"],"main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/ikatyang/gulp-plugin-prettier.git"},"homepage":"https://github.com/ikatyang/gulp-plugin-prettier#readme","author":{"name":"Ika","email":"ikatyang@gmail.com","url":"https://github.com/ikatyang"},"license":"MIT","scripts":{"prepublish":"yarn run build","lint":"tslint -p ./tsconfig.json --type-check","test":"jest -c ./jest.json","prebuild":"rm -rf ./lib","build":"tsc -p tsconfig.build.json","format":"gulp format","format_check":"gulp format_check","release":"standard-version"},"dependencies":{"ansi-colors":"^4.1.1","fancy-log":"^1.3.3","plugin-error":"^1.0.1","through2":"^2.0.3","vinyl":"^2.2.0"},"devDependencies":{"@types/ansi-colors":"3.2.0","@types/fancy-log":"1.3.1","@types/gulp":"4.0.6","@types/jest":"21.1.10","@types/plugin-error":"0.1.1","@types/prettier":"1.18.3","@types/through2":"2.0.34","@types/vinyl":"2.0.4","gulp":"4.0.2","jest":"21.2.1","prettier":"1.19.1","prettier-config-ikatyang":"1.1.1","standard-version":"4.4.0","ts-jest":"21.2.4","ts-node":"4.1.0","tslint":"5.20.1","tslint-config-ikatyang":"2.5.1","tslint-config-prettier":"1.18.0","typescript":"2.9.2"},"peerDependencies":{"gulp":"^3.9.0 || ^4.0.0","prettier":"^1.4.0 || ^2.0.0"},"engines":{"node":">= 6"},"gitHead":"c89ba38296aae67fcf9ef974f46d01373ca40054","bugs":{"url":"https://github.com/ikatyang/gulp-plugin-prettier/issues"},"_id":"gulp-plugin-prettier@2.0.1","_nodeVersion":"13.11.0","_npmVersion":"6.13.7","dist":{"shasum":"9ccc3b09ae99d489d9206ba20e497eeff85549cf","size":5636,"noattachment":false,"key":"/gulp-plugin-prettier/-/gulp-plugin-prettier-2.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/gulp-plugin-prettier/download/gulp-plugin-prettier-2.0.1.tgz"},"maintainers":[{"name":"ikatyang","email":"ikatyang@gmail.com"}],"_npmUser":{"name":"ikatyang","email":"ikatyang@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gulp-plugin-prettier_2.0.1_1591106863636_0.5411384054825108"},"_hasShrinkwrap":false,"publish_time":1591106863759,"_cnpm_publish_time":1591106863759},"2.0.0":{"name":"gulp-plugin-prettier","version":"2.0.0","description":"Gulp plugin to format code with Prettier","keywords":["gulp","gulpplugin","prettier"],"main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/ikatyang/gulp-plugin-prettier.git"},"homepage":"https://github.com/ikatyang/gulp-plugin-prettier#readme","author":{"name":"Ika","email":"ikatyang@gmail.com","url":"https://github.com/ikatyang"},"license":"MIT","scripts":{"prepublish":"yarn run build","lint":"tslint -p ./tsconfig.json --type-check","test":"jest -c ./jest.json","prebuild":"rm -rf ./lib","build":"tsc -p tsconfig.build.json","format":"gulp format","format_check":"gulp format_check","release":"standard-version"},"dependencies":{"ansi-colors":"^4.1.1","fancy-log":"^1.3.3","plugin-error":"^1.0.1","through2":"^2.0.3","vinyl":"^2.2.0"},"devDependencies":{"@types/ansi-colors":"^3.2.0","@types/fancy-log":"^1.3.1","@types/gulp":"4.0.6","@types/jest":"21.1.10","@types/plugin-error":"^0.1.1","@types/prettier":"1.18.2","@types/through2":"2.0.34","@types/vinyl":"^2.0.3","gulp":"4.0.2","jest":"21.2.1","prettier":"1.18.2","prettier-config-ikatyang":"1.1.1","standard-version":"4.4.0","ts-jest":"21.2.4","ts-node":"4.1.0","tslint":"5.19.0","tslint-config-ikatyang":"2.5.1","tslint-config-prettier":"1.15.0","typescript":"2.9.2"},"peerDependencies":{"gulp":"^3.9.0 || ^4.0.0","prettier":"^1.4.0"},"engines":{"node":">= 6"},"gitHead":"7da50d78048c5fe0bcfbd85dc1dd70eb93a61dbc","bugs":{"url":"https://github.com/ikatyang/gulp-plugin-prettier/issues"},"_id":"gulp-plugin-prettier@2.0.0","_nodeVersion":"10.16.2","_npmVersion":"6.9.0","dist":{"shasum":"2e5ff87201f549f5901113362d1eb38761fe2c00","size":5561,"noattachment":false,"key":"/gulp-plugin-prettier/-/gulp-plugin-prettier-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/gulp-plugin-prettier/download/gulp-plugin-prettier-2.0.0.tgz"},"maintainers":[{"name":"ikatyang","email":"ikatyang@gmail.com"}],"_npmUser":{"name":"ikatyang","email":"ikatyang@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gulp-plugin-prettier_2.0.0_1567241193301_0.6724348026542941"},"_hasShrinkwrap":false,"publish_time":1567241193427,"_cnpm_publish_time":1567241193427},"1.1.0":{"name":"gulp-plugin-prettier","version":"1.1.0","description":"Gulp plugin to format code with Prettier","keywords":["gulp","gulpplugin","prettier"],"main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/ikatyang/gulp-plugin-prettier.git"},"homepage":"https://github.com/ikatyang/gulp-plugin-prettier#readme","author":{"name":"Ika","email":"ikatyang@gmail.com","url":"https://github.com/ikatyang"},"license":"MIT","scripts":{"prepublish":"yarn run build","lint":"tslint -p ./tsconfig.json --type-check","test":"jest -c ./jest.json","prebuild":"rm -rf ./lib","build":"tsc -p tsconfig.build.json","format":"gulp format","format-check":"gulp format-check","release":"standard-version"},"dependencies":{"gulp-util":"^3.0.8","through2":"^2.0.3"},"devDependencies":{"@types/gulp":"3.8.33","@types/gulp-util":"3.0.31","@types/jest":"20.0.8","@types/prettier":"1.6.1","@types/through2":"2.0.33","gulp":"3.9.1","jest":"21.1.0","prettier":"1.7.0","prettier-config-ikatyang":"1.1.1","standard-version":"4.2.0","ts-jest":"21.0.1","ts-node":"3.3.0","tslint":"5.7.0","tslint-config-ikatyang":"2.4.0","tslint-config-prettier-ext":"1.5.0","typescript":"2.5.2"},"peerDependencies":{"gulp":"^3.9.0","prettier":"^1.4.0"},"engines":{"node":">= 4"},"files":["/lib/**/*"],"gitHead":"88277d1a4292e842bf7f4542761b717b75fcad9a","bugs":{"url":"https://github.com/ikatyang/gulp-plugin-prettier/issues"},"_id":"gulp-plugin-prettier@1.1.0","_npmVersion":"5.3.0","_nodeVersion":"8.4.0","_npmUser":{"name":"ikatyang","email":"ikatyang@gmail.com"},"dist":{"shasum":"83ed9e8ef6549c273db18a1ef6446343191cf75c","size":5447,"noattachment":false,"key":"/gulp-plugin-prettier/-/gulp-plugin-prettier-1.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/gulp-plugin-prettier/download/gulp-plugin-prettier-1.1.0.tgz"},"maintainers":[{"name":"ikatyang","email":"ikatyang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gulp-plugin-prettier-1.1.0.tgz_1505915826851_0.9403965582605451"},"directories":{},"publish_time":1505915826918,"_cnpm_publish_time":1505915826918,"_hasShrinkwrap":false},"1.0.0":{"name":"gulp-plugin-prettier","version":"1.0.0","description":"Gulp plugin to format code with Prettier","keywords":["gulp","gulpplugin","prettier"],"main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/ikatyang/gulp-plugin-prettier.git"},"homepage":"https://github.com/ikatyang/gulp-plugin-prettier#readme","author":{"name":"Ika","email":"ikatyang@gmail.com","url":"https://github.com/ikatyang"},"license":"MIT","scripts":{"prepublish":"yarn run build","lint":"tslint -p ./tsconfig.json --type-check","test":"jest --config ./jest.json","prebuild":"rm -rf ./lib","build":"tsc -p tsconfig.build.json","format":"gulp format","format-check":"gulp format-check","release":"standard-version"},"dependencies":{"@types/gulp-util":"^3.0.31","@types/through2":"^2.0.33","gulp-util":"^3.0.8","through2":"^2.0.3"},"devDependencies":{"@types/gulp":"3.8.33","@types/jest":"20.0.4","@types/prettier":"1.5.0","gulp":"3.9.0","jest":"20.0.4","prettier":"1.4.0","standard-version":"4.2.0","ts-jest":"20.0.7","ts-node":"3.2.1","tslint":"5.5.0","tslint-config-ikatyang":"1.0.1","typescript":"2.4.2"},"peerDependencies":{"gulp":"^3.9.0","prettier":"^1.4.0"},"engines":{"node":">= 4"},"files":["/lib/**/*"],"gitHead":"5bcf139461453de5db4777484dd4cd8dfbaeb95a","bugs":{"url":"https://github.com/ikatyang/gulp-plugin-prettier/issues"},"_id":"gulp-plugin-prettier@1.0.0","_npmVersion":"5.1.0","_nodeVersion":"8.1.3","_npmUser":{"name":"ikatyang","email":"ikatyang@gmail.com"},"dist":{"shasum":"89f820419b3185389cb551a2fef30ac7f179e52a","size":4280,"noattachment":false,"key":"/gulp-plugin-prettier/-/gulp-plugin-prettier-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/gulp-plugin-prettier/download/gulp-plugin-prettier-1.0.0.tgz"},"maintainers":[{"name":"ikatyang","email":"ikatyang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gulp-plugin-prettier-1.0.0.tgz_1500801673493_0.8546273172833025"},"directories":{},"publish_time":1500801673676,"_hasShrinkwrap":false,"_cnpm_publish_time":1500801673676}},"readme":"# gulp-plugin-prettier\n\n[![npm](https://img.shields.io/npm/v/gulp-plugin-prettier.svg)](https://www.npmjs.com/package/gulp-plugin-prettier)\n[![build](https://img.shields.io/travis/ikatyang/gulp-plugin-prettier/master.svg)](https://travis-ci.org/ikatyang/gulp-plugin-prettier/builds)\n[![coverage](https://img.shields.io/codecov/c/github/ikatyang/gulp-plugin-prettier/master.svg)](https://codecov.io/gh/ikatyang/gulp-plugin-prettier)\n\nGulp plugin to format code with [Prettier](https://github.com/prettier/prettier)\n\n[Changelog](https://github.com/ikatyang/gulp-plugin-prettier/blob/master/CHANGELOG.md)\n\n## Install\n\n```sh\n# using npm\nnpm install --save-dev gulp-plugin-prettier gulp prettier\n\n# using yarn\nyarn add --dev gulp-plugin-prettier gulp prettier\n```\n\n**NOTE**: For TypeScript user, you have to install `@types/prettier` to get full types.\n\n## Usage\n\n(gulpfile.ts)\n\n```ts\nimport * as gulp from 'gulp';\nimport * as prettier from 'gulp-plugin-prettier';\n\n// replace unformatted with formatted\nfunction format() {\n  return gulp.src(['./src/**/*.ts', './gulpfile.ts'])\n    .pipe(prettier.format({ singleQuote: true }))\n    .pipe(gulp.dest(file => file.base));\n}\n\n// throw error if there is unformatted file\nfunction format_check() {\n  return gulp.src(['./src/**/*.ts', './gulpfile.ts'])\n    .pipe(\n      prettier.format({ singleQuote: true }, { reporter: prettier.Reporter.Error }),\n    );\n}\n```\n\n(gulpfile.js)\n\n```ts\nconst gulp = require('gulp');\nconst prettier = require('gulp-plugin-prettier');\n\n// replace unformatted with formatted\nfunction format() {\n  return gulp.src(['./src/**/*.js', './gulpfile.js'])\n    .pipe(prettier.format({ singleQuote: true }))\n    .pipe(gulp.dest(file => file.base));\n}\n\n// throw error if there is unformatted file\nfunction format_check() {\n  return gulp.src(['./src/**/*.js', './gulpfile.js'])\n    .pipe(prettier.format({ singleQuote: true }, { reporter: 'error' }));\n}\n```\n\n## API\n\n[Prettier Options](https://github.com/prettier/prettier#options)\n\n```ts\nexport function format(prettier_options?: PrettierOptions, plugin_options?: PluginOptions): stream.Transform;\n\nexport interface PluginOptions {\n  /**\n   * default: 'warning'\n   * report the filenames of files that are different from Prettier formatting\n   */\n  reporter?: Reporter | CustomReporter;\n  /**\n   * default: false\n   * omit formatted files\n   */\n  filter?: boolean;\n  /**\n   * default: true\n   * include rules from Prettier config files, e.g. .prettierrc\n   */\n  configFile?: boolean;\n}\n\nexport const enum Reporter {\n  /**\n   * do nothing\n   */\n  None = 'none',\n  /**\n   * throw error for the filenames of files that are different from Prettier formatting\n   */\n  Error = 'error',\n  /**\n   * print warning for the filenames of files that are different from Prettier formatting\n   */\n  Warning = 'warning'\n}\n\nexport type CustomReporter = (filename: string, different: boolean) => void;\n```\n\n## Development\n\n```sh\n# lint\nyarn run lint\n\n# format\nyarn run format\n\n# build\nyarn run build\n\n# test\nyarn run test\n```\n\n## Related\n\n- [gulp-prettier](https://github.com/bhargavrpatel/gulp-prettier)\n- [gulp-nf-prettier](https://github.com/btholt/gulp-nf-prettier)\n- [gulp-prettier-plugin](https://github.com/GAumala/gulp-prettier-plugin)\n- [@bdchauvette/gulp-prettier](https://github.com/bdchauvette/gulp-prettier)\n\n## License\n\nMIT © [Ika](https://github.com/ikatyang)\n","_attachments":{},"homepage":"https://github.com/ikatyang/gulp-plugin-prettier#readme","bugs":{"url":"https://github.com/ikatyang/gulp-plugin-prettier/issues"},"license":"MIT"}