Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Account for extension length when truncating filename #31

Merged
merged 2 commits into from Apr 23, 2022
Merged

Account for extension length when truncating filename #31

merged 2 commits into from Apr 23, 2022

Conversation

tomasklaen
Copy link
Contributor

I wasn't sure what to do with the filename when extension is loner than maxLength, as removing it completely would create a dotfile which might have unintended consequences, so I decided to keep at least 1 character of the filename in place.


Also found another bug: filenamify doesn't account for dotfiles, so this test:

t.is(filenamify('.asdfghjkl', {maxLength: 2}), '.asdfghjkl');

Can't pass as other parts of filenamify remove the leading dot as they consider it a relative path, and than truncation later on treats it as a filename.

Separate PR? :)

@tomasklaen tomasklaen changed the title Account for extension length when truncating file Account for extension length when truncating filename Apr 17, 2022
@sindresorhus
Copy link
Owner

Separate PR? :)

👍

readme.md Outdated
@@ -59,6 +59,8 @@ Default: `100`

Truncate the filename to the given length.

Only filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you'll get a string that is longer than requested, so you need to check for that.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Only filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you'll get a string that is longer than requested, so you need to check for that.
Only the filename is truncated, preserving the extension. If the extension itself is longer than `maxLength`, you will get a string that is longer than `maxLength`, so you need to check for that if you allow arbitrary extensions.

test.js Outdated
t.is(filenamify(path.basename(filename), {maxLength: 180}), 'very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_long_filename.txt');

// Extension longer than maxLength
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Extension longer than maxLength
// File extension longer than `maxLength`

@sindresorhus sindresorhus merged commit a16c224 into sindresorhus:main Apr 23, 2022
@tomasklaen tomasklaen mentioned this pull request Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants