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.

Sign up for GitHub

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

Jump to bottom

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
204b218
Account for extension length when truncating file
tomasklaen Apr 17, 2022
43d5a3d
Suggestions
tomasklaen Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 7 additions & 3 deletions filenamify.js
View file
Open in desktop
Expand Up @@ -35,9 +35,13 @@ export default function filenamify(string, options = {}) {
const allowedLength = typeof options.maxLength === 'number' ? options.maxLength : MAX_FILENAME_LENGTH;
if (string.length > allowedLength) {
const extensionIndex = string.lastIndexOf('.');
const filename = extensionIndex === -1 ? string : string.slice(0, extensionIndex);
const extension = extensionIndex === -1 ? '' : string.slice(extensionIndex);
string = filename.slice(0, Math.min(allowedLength, filename.length)) + extension;
if (extensionIndex === -1) {
string = string.slice(0, allowedLength);
} else {
const filename = string.slice(0, extensionIndex);
const extension = string.slice(extensionIndex);
string = filename.slice(0, Math.max(1, allowedLength - extension.length)) + extension;
}
}

return string;
Expand Down
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Expand Up @@ -59,6 +59,8 @@ Default: `100`

Truncate the filename to the given length.
sindresorhus marked this conversation as resolved.
Show resolved Hide resolved

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.


sindresorhus marked this conversation as resolved.
Show resolved Hide resolved
Systems generally allow up to 255 characters, but we default to 100 for usability reasons.

## Browser-only import
Expand Down
7 changes: 5 additions & 2 deletions test.js
View file
Open in desktop
Expand Up @@ -30,15 +30,18 @@ test('filnamify()', t => {
test('filenamifyPath()', t => {
t.is(path.basename(filenamifyPath(path.join(directoryName, 'foo:bar'))), 'foo!bar');
t.is(path.basename(filenamifyPath(path.join(directoryName, 'This? This is very long filename that will lose its extension when passed into filenamify, which could cause issues.csv'))),
'This! This is very long filename that will lose its extension when passed into filenamify, which cou.csv');
'This! This is very long filename that will lose its extension when passed into filenamify, which.csv');
});

test('filenamify length', t => {
// Basename length: 152
const filename = 'this/is/a/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';
t.is(filenamify(path.basename(filename)), 'very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_.txt');
t.is(filenamify(path.basename(filename)), 'very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_v.txt');
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`

t.is(filenamify('foo.asdfghjkl', {maxLength: 5}), 'f.asdfghjkl');

// Basename length: 148
const filenameNoExt = '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';
t.is(filenamify(filenameNoExt), 'very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_very_');
Expand Down