{"id":15207362,"url":"https://github.com/zekth/gulp-image-process","last_synced_at":"2025-10-03T01:30:46.724Z","repository":{"id":57257838,"uuid":"142406372","full_name":"zekth/gulp-image-process","owner":"zekth","description":"Gulp task for processing images","archived":true,"fork":false,"pushed_at":"2020-09-02T15:29:25.000Z","size":6282,"stargazers_count":2,"open_issues_count":9,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-16T04:21:12.272Z","etag":null,"topics":["gulp","gulp-plugin","gulp-tasks","gulpjs","gulpplugin","image-manipulation","image-processing","sharp","sharp-library"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zekth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-26T07:40:15.000Z","updated_at":"2023-01-28T12:58:32.000Z","dependencies_parsed_at":"2022-08-25T21:22:44.842Z","dependency_job_id":null,"html_url":"https://github.com/zekth/gulp-image-process","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zekth%2Fgulp-image-process","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zekth%2Fgulp-image-process/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zekth%2Fgulp-image-process/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zekth%2Fgulp-image-process/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zekth","download_url":"https://codeload.github.com/zekth/gulp-image-process/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235059234,"owners_count":18929279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gulp","gulp-plugin","gulp-tasks","gulpjs","gulpplugin","image-manipulation","image-processing","sharp","sharp-library"],"created_at":"2024-09-28T06:42:04.203Z","updated_at":"2025-10-03T01:30:46.239Z","avatar_url":"https://github.com/zekth.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-image-process\n\nA Gulp task for processing images base on [sharp](https://github.com/lovell/sharp) for its speed, features and easiness of deployement.\n\n## Installation\n\n```\n  npm install gulp gulp-image-process --save-dev\n```\n\n## Usage\n\n```javascript\n'use strict'\nconst imageProcess = require('gulp-image-process')\nconst gulp = require('gulp')\nconst path = require('path')\n\ngulp.task('images', () =\u003e {\n  let imageFolder = path.resolve('test', 'ressources', 'src', '*.jpg')\n  return gulp\n    .src(imageFolder)\n    .pipe(\n      imageProcess({\n        verboseLogging: true,\n        progressive:true,\n        width:200,\n        heigth:200,\n        output: 'webp',\n        ignoreRatio:false,\n        multipleResize: [150,300],\n        watermark: {\n          filePath: 'test/ressources/src/watermark.png',\n          position: 'north',\n          maxSize: 20,\n          margin: 30\n        }\n      })\n    )\n    .pipe(gulp.dest(path.resolve('test', 'result')))\n})\n```\n\n## API\n\n### options\n\n##### options.output\nType: `String`\u003cbr\u003e\nDefault: `false`\u003cbr\u003e\n\nForce the output format. Possible values `jpeg|png|webp`\n\n##### options.quality\nType: `Number`\u003cbr\u003e\nDefault: `100`\u003cbr\u003e\n\nQuality of the output image. From 0 to 100.\n\n#### options.verboseLogging\nType: `Boolean`\u003cbr\u003e\nDefault: `false`\n\nEnable the verbose logging.\n\n#### options.multipleResize\nType: `Array\u003cNumber\u003e`\u003cbr\u003e\nDefault: `false`\n\nWill perform multiple resize of the values passed in parameter. Resizes are made on the rendered images, for example it will resize the image with the watermark.\n\n### options.keepMetadata\nType: `Boolean`\u003cbr\u003e\nDefault: `false`\n\nKeep the EXIF file on the output file.\n\n### options.progressive\nType: `Boolean`\u003cbr\u003e\nDefault: `false`\n\nOutput using progressive scan. Only available for jpeg output.\n\n### options.ignoreRatio\nType: `Boolean`\u003cbr\u003e\nDefault: `false`\n\nWhile resizing it will ignore the base ratio of the image with a crop.\n\n#### options.watermark\nType: `Object`\u003cbr\u003e\nDefault: `null`\n\n##### options.watermark.filePath\nType: `String`\u003cbr\u003e\nDefault: `''`\u003cbr\u003e\nIs Mandatory: `True`\n\nPath of the watermark file.\n\n##### options.watermark.position\nType: `String`\u003cbr\u003e\nDefault: `''`\u003cbr\u003e\nIs Mandatory: `True`\n\nPosition of the watermark on the image.\u003cbr\u003e\nPossible values:\n```\n  center\n  north\n  south\n  west\n  east\n  northwest\n  northeast\n  southwest\n  southeast\n```\n\nLittle reminder:\n```\nnorthwest   north     northeast\n        \\     |     /\n          \\   |   /\nwest   ---- center ----   east\n          /   |   \\\n        /     |     \\\nsouthwest   south     southeast\n\n```\n\n##### options.watermark.maxSize\nType: `Number`\u003cbr\u003e\nDefault: `-1`\u003cbr\u003e\n\nMax Size in Percent of the watermark on the image. If default value is used, the watermark will get its original size.\n\n##### options.watermark.margin\nType: `Number`\u003cbr\u003e\nDefault: `0`\u003cbr\u003e\n\nMargin of the watermark from the border of the image. Applied to all coordinates. Similar of css attribute `margin:\u003cvalue\u003epx;`\n\n\n## TODO\n\n- Unit tests :v\n- Optimization prompt (diff input / ouput size)\n\n## License\n\n[MIT License](http://en.wikipedia.org/wiki/MIT_License)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzekth%2Fgulp-image-process","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzekth%2Fgulp-image-process","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzekth%2Fgulp-image-process/lists"}