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

Fix filenames truncated by maxLength not keeping their extension #27

Merged
merged 2 commits into from Oct 17, 2021
Merged

Fix filenames truncated by maxLength not keeping their extension #27

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
8cd8124
filename extension preserved for long filenames
aakriti-kedia Oct 16, 2021
ab984de
review comment - improve readability
aakriti-kedia Oct 16, 2021
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
6 changes: 5 additions & 1 deletion filenamify.js
View file
Open in desktop
Expand Up @@ -31,7 +31,11 @@ export default function filenamify(string, options = {}) {
}

string = filenameReservedRegex.windowsNames().test(string) ? string + replacement : string;
string = string.slice(0, typeof options.maxLength === 'number' ? options.maxLength : MAX_FILENAME_LENGTH);
const allowedLength = typeof options.maxLength === 'number' ? options.maxLength : MAX_FILENAME_LENGTH;
if (allowedLength < string.length) {
Copy link
Owner

Choose a reason for hiding this comment

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

I think it reads better if string.length comes first in this conditional.

const extensionIndex = string.lastIndexOf('.');
string = string.slice(0, Math.min(allowedLength, extensionIndex)) + string.slice(extensionIndex);
}

return string;
}
4 changes: 3 additions & 1 deletion test.js
View file
Open in desktop
Expand Up @@ -29,11 +29,13 @@ 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');
});

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_');
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), {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');
});