Add `preserveDirectories` option #353

gijsroge · 2020-04-29T23:24:08Z

Fixes #191

If the preserveDirectories is set the output will match the directory structure from the input files.

Another possibility would be to introduce a breaking change and make this the default behaviour as that's what I would expect, but maybe i'm biased as I need this feature in a current project 😄

Given: assets/images/1.jpg, assets/images/nested/2.svg, assets/images/nested/nested/3.webp

It will detect that assets/images is the basePath and will not copy over these directories to the destination.

imagemin(['assets/images/**/*.{jpg,svg,webp}'], {
	plugins: [imageminJpegtran(), imageminWebp(), imageminSvgo()],
	destination: 'dest',
	preserveDirectories: true
});

Our output would be dest/1.jpg, dest/nested/assets/2.svg, dest/nested/nested/3.webp

cc/ #293 #262 #225 #213 #196 #192

gijsroge · 2020-04-29T23:56:04Z

removed

rolbr · 2020-06-17T12:07:15Z

@gijsroge
Sweet, exactly what I was looking for! 🥳

However, I encountered a bug that would not preserve directory structure for the first subdirectory.

Script:

(async () => {
	const files = await imagemin(['input_dir/**/*.{jpg,jpeg,png,svg}'], {
		destination: 'output_dir',
		preserveDirectories: true,
		...

Files/ directories:

⨽ input_dir
   ⊢ sub_dir_1
   ∣  ⨽ files 1…N
   ⨽ sub_dir_2
      ⨽ files 1…N

All files in input_dir/sub_dir_1 would be written to output_dir/ whereas
files in input_dir/sub_dir_2 would be written to output_dir/sub_dir_2.

Is this something you can reproduce?

glassdimlygr · 2020-07-20T18:59:38Z

I can't reproduce the skipping of the first directory as reported by @rolbr. For me it works great.

I can say that when I was on the master branch of gijsroge/imagemin, it did not function. It was necessary to check out the feature/preserve-directories branch for this to work.

yuceltoluyag · 2020-07-21T10:43:39Z

ty save my life <3 @gijsroge

sindresorhus · 2020-08-10T20:55:39Z

index.js

@@ -33,6 +33,10 @@ const handleFile = async (sourcePath, {destination, plugins = []}) => {
 		return returnValue;
 	}

+	if (preserveDirectories) {
+		returnValue.destinationPath = path.join(path.dirname(destinationPath), sourcePath.replace(baseDirectory, ''));


I don't think using .replace will work cross-platform. Use the path related methods for path manipulation.

Sourcepath is just a string generated from "globby" where I need to remove the baseDirectory from. I can't find anything path related to do this. So I assume this is just fine, if not, could you point me in the right direction?

sindresorhus · 2020-08-10T20:56:04Z

index.js

@@ -45,13 +49,14 @@ module.exports = async (input, {glob = true, ...options} = {}) => {
 	}

 	const filePaths = glob ? await globby(input, {onlyFiles: true}) : input;
+	const baseDirectory = path.dirname(filePaths[0]);


Why does the first file path decide the base directory? This should be documented.

Added clarification b3ce79c#diff-5a831ea67cf5cf8703b0de46901ab25bd191f56b320053be9332d9a3b0d01d15R114

readme.md

test.js

yellow1912 · 2020-09-29T06:12:16Z

What is the status with this PR? Can we have it merged soon?

gijsroge · 2020-09-29T10:54:12Z

@yellow1912 i'm picking this back up in the next few days.

Getting the build script to handle this was more trouble than it should have been. `imagemin` has a 4 year old merge request[1] to handle recursing into subdirectories... As a work around when images are batched, the script loops over all the files in the image dir, running them in parallel groups of 4 (to speed things up, but not lock up the CPU). 1: imagemin/imagemin#353

misaka00251 · 2021-03-07T07:00:15Z

Hey, just asking..What's the status of this PR?

illycz · 2021-03-07T21:52:30Z

Any news about PR?

kosssi · 2021-04-29T09:52:32Z

This feature is essential 🎉

I use this command while waiting:

find ./static -type f | xargs -I % sh -c 'imagemin % -o $(dirname %)'

Thanks for imagemin 👍

leesei · 2021-06-03T04:31:51Z

I've implemented something similar locally.

Concerning @sindresorhus's question on "Why does the first file path decide the base directory? This should be documented.", how about we only enable preserveDirectories for glob inputs?
Then we rather than passing baseDirectory, we just need to:

let destinationPath = destination ? path.join(destination, preserveDirectories? sourcePath: path.basename(sourcePath)) : undefined;

price84 · 2021-10-27T06:45:22Z

Any movement?

…magemin#191

* rebase with upstream * add clarification what basePath does * make basePath configurable

gijsroge · 2021-10-27T23:02:19Z

So yeah, days turned into weeks, weeks turned into months, months turned into years. Sorry about the delay :(

I addressed most of the issues + rebased with main, care to re-review? cc/ @1000ch @sindresorhus

gijsroge · 2021-10-27T23:04:05Z

I've implemented something similar locally.

Concerning @sindresorhus's question on "Why does the first file path decide the base directory? This should be documented.", how about we only enable preserveDirectories for glob inputs? Then we rather than passing baseDirectory, we just need to:
let destinationPath = destination ? path.join(destination, preserveDirectories? sourcePath: path.basename(sourcePath)) : undefined;

There is no solid way to detect if someone is using a glob or not even if glob:true they can still use ['image.jpg', 'assets/images/image.jpg']. So the most obvious thing to do was make it configurable imo.

sindresorhus · 2021-11-10T08:43:00Z

index.js

@@ -35,6 +35,10 @@ const handleFile = async (sourcePath, {destination, plugins = []}) => {
 		return returnValue;
 	}

+	if (preserveDirectories) {
+		returnValue.destinationPath = path.join(destination, path.parse(sourcePath).dir.replace(basePath, ''), path.basename(destinationPath));


Use path.dirname

sindresorhus · 2021-11-10T08:43:18Z

readme.md

+	preserveDirectories: true,
+});
+```
+- `assets/images/1.jpg` -> `dist/1.jpg`


Suggested change

- `assets/images/1.jpg` -> `dist/1.jpg`

- `assets/images/1.jpg` → `dist/1.jpg`

sindresorhus · 2021-11-10T08:43:38Z

Tests are failing on Windows.

pumano · 2021-11-23T15:07:50Z

@gijsroge thank you for that very important feature! Hope it will be merged soon!

eBaeza · 2022-03-25T17:43:10Z

Very important feature! Hope it will be merged soon!

rtatarinov · 2022-04-02T20:16:59Z

Any updates about it?

okinawaa · 2022-07-28T04:44:09Z

Very important feature! Hope it will be merged soon!!!

1ewiswarren · 2022-11-14T14:07:24Z

is this not being worked on anymore?

Shayan-To · 2023-03-07T16:32:54Z

Any progress? This is really necessary.

tofran · 2023-03-07T22:39:31Z

@Shayan-To @eBaeza, @rtatarinov, etc

Please refrain from making such comments. There are plenty of people subscribed to threads and this kind of comment just spams their inbox. Please only comment if you have something to add to the discussion.

If this is so "necessary" feel free to contribute with valuable help. This might even include making a PR to the fork, helping the original author.

Thank you.

saeidzebardast · 2023-08-03T15:07:45Z

Any progress on this?

imagemin/imagemin#353

sindresorhus · 2024-04-29T05:59:07Z

Closing for lack of activity from OP.

gijsroge force-pushed the feature/preserve-directories branch from 86ae9a1 to 8c9e24f Compare April 30, 2020 01:07

gijsroge marked this pull request as ready for review April 30, 2020 01:16

gijsroge force-pushed the feature/preserve-directories branch from 8c9e24f to bfd7c54 Compare April 30, 2020 10:19

1000ch requested a review from sindresorhus June 9, 2020 05:54

sindresorhus requested changes Aug 10, 2020

View reviewed changes

sindresorhus changed the title ~~Add ability to preserve your directory structure in the output.~~ Add preserveDirectories option Aug 10, 2020

vraravam mentioned this pull request Oct 8, 2020

preserve paths with imagemin-cli #348

Open

Base automatically changed from master to main January 25, 2021 21:10

coreymcollins mentioned this pull request Oct 5, 2021

Experimental: esbuild WebDevStudios/wd_s#751

Closed

gijsroge added 2 commits October 27, 2021 22:26

Add ability to preserve your directory structure in the output. fixes i…

422d18e

…magemin#191

rebase + clarfication & enhancements

b3ce79c

* rebase with upstream * add clarification what basePath does * make basePath configurable

gijsroge force-pushed the feature/preserve-directories branch from bfd7c54 to b3ce79c Compare October 27, 2021 22:57

typo

512e615

sindresorhus requested changes Nov 10, 2021

View reviewed changes

Kristinita added a commit to Kristinita/imagemin-cli that referenced this pull request Feb 11, 2024

feat(option): imagemin-cli with preserveDirectories option

5a00fcf

imagemin/imagemin#353

sindresorhus closed this Apr 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `preserveDirectories` option #353

Add `preserveDirectories` option #353

gijsroge commented Apr 29, 2020 •

edited

Loading

gijsroge commented Apr 29, 2020 •

edited

Loading

rolbr commented Jun 17, 2020

glassdimlygr commented Jul 20, 2020 •

edited

Loading

yuceltoluyag commented Jul 21, 2020

sindresorhus Aug 10, 2020

gijsroge Oct 27, 2021

sindresorhus Aug 10, 2020

gijsroge Oct 27, 2021

yellow1912 commented Sep 29, 2020

gijsroge commented Sep 29, 2020

misaka00251 commented Mar 7, 2021

illycz commented Mar 7, 2021

kosssi commented Apr 29, 2021 •

edited

Loading

leesei commented Jun 3, 2021

price84 commented Oct 27, 2021

gijsroge commented Oct 27, 2021 •

edited

Loading

gijsroge commented Oct 27, 2021 •

edited

Loading

sindresorhus Nov 10, 2021

sindresorhus Nov 10, 2021

sindresorhus commented Nov 10, 2021

pumano commented Nov 23, 2021

eBaeza commented Mar 25, 2022

rtatarinov commented Apr 2, 2022

okinawaa commented Jul 28, 2022

1ewiswarren commented Nov 14, 2022

Shayan-To commented Mar 7, 2023

tofran commented Mar 7, 2023

saeidzebardast commented Aug 3, 2023

sindresorhus commented Apr 29, 2024

	- `assets/images/1.jpg` -> `dist/1.jpg`
	- `assets/images/1.jpg` → `dist/1.jpg`

Add preserveDirectories option #353

Add preserveDirectories option #353

Conversation

gijsroge commented Apr 29, 2020 • edited Loading

gijsroge commented Apr 29, 2020 • edited Loading

rolbr commented Jun 17, 2020

glassdimlygr commented Jul 20, 2020 • edited Loading

yuceltoluyag commented Jul 21, 2020

sindresorhus Aug 10, 2020

Choose a reason for hiding this comment

gijsroge Oct 27, 2021

Choose a reason for hiding this comment

sindresorhus Aug 10, 2020

Choose a reason for hiding this comment

gijsroge Oct 27, 2021

Choose a reason for hiding this comment

yellow1912 commented Sep 29, 2020

gijsroge commented Sep 29, 2020

misaka00251 commented Mar 7, 2021

illycz commented Mar 7, 2021

kosssi commented Apr 29, 2021 • edited Loading

leesei commented Jun 3, 2021

price84 commented Oct 27, 2021

gijsroge commented Oct 27, 2021 • edited Loading

gijsroge commented Oct 27, 2021 • edited Loading

sindresorhus Nov 10, 2021

Choose a reason for hiding this comment

sindresorhus Nov 10, 2021

Choose a reason for hiding this comment

sindresorhus commented Nov 10, 2021

pumano commented Nov 23, 2021

eBaeza commented Mar 25, 2022

rtatarinov commented Apr 2, 2022

okinawaa commented Jul 28, 2022

1ewiswarren commented Nov 14, 2022

Shayan-To commented Mar 7, 2023

tofran commented Mar 7, 2023

saeidzebardast commented Aug 3, 2023

sindresorhus commented Apr 29, 2024

Add `preserveDirectories` option #353

Add `preserveDirectories` option #353

gijsroge commented Apr 29, 2020 •

edited

Loading

gijsroge commented Apr 29, 2020 •

edited

Loading

glassdimlygr commented Jul 20, 2020 •

edited

Loading

kosssi commented Apr 29, 2021 •

edited

Loading

gijsroge commented Oct 27, 2021 •

edited

Loading

gijsroge commented Oct 27, 2021 •

edited

Loading