filename-padder

filename-padder module

Use this module to rename files on a directory that follows a numeric pattern as logs files, enumerated images or tracks.

For example, if we have the following music tracks on a directory, the files will not be properly sorted for most of devices as well as for any read directory function, because they only perform a simple alphabetic sorting.

This module allows renaming files adding padding to a specific variable sector, in order to achieve a valid string sorting. Let's take the following example having some mp3 track. As we may see the files are not sorted as we could expect.

track-1-music.mp3
track-101-music.mp3
track-11-music.mp3
track-2-music.mp3
track-9-music.mp3
track-90-music.mp3
wao-other-file-no-match.txt

How to use it:

To describe the pattern just add (?var) on the sector that we want to pad, in this case:

track-(?var)-music.mp3

const fPadder = require("filename-padder");

//on a windows path, please use \\, for example D:\\Development\\my-files-to-rename\\files
let path = "/data/myTracks/";

  let pattern = "track-(?var)-music.mp3",
      chartPad = '0',
      lengthPad = 4;
  
  let result = fPadder.padRenameSync(path, pattern, lengthPad, chartPad);

Output for the above example:

1-All files are renamed on the target directory. 2-result variable = to [array with renamed filenames] or null in case of error.

track-0001-music.mp3
track-0002-music.mp3
track-0009-music.mp3
track-0011-music.mp3
track-0090-music.mp3
track-0101-music.mp3
wao-other-file-no-match.txt

Test

git clone https://github.com/osvaldo2627/filename-padder.git 
cd filename-padder
npm install 
npm run test

note: This implementation is sync, you should avoid using it on a big amount of files if your server must handler other operations. Async implementation coming soon for that case.