Clean up generated files names to remove or replace invalid characters

[Spydarlee]

Hi there - thanks for making such a great plugin!

I was running into some issues when trying to create markdown files based on media with titles that contain invalid filename characters (such as ":" and other punctuation).

This small change strips out most invalid characters, but replaces colons with hyphens, and replaces double quotes with single quotes, to try and retain the original intention as much as possible.

The original, unaltered, title is/can still be added to the frontmatter as per usual.

[mProjectsCode]

For single characters, you don't need a regexp, e.g. .replaceAll(':', ' - ')

[Spydarlee]

Oh good spot, fixed, thanks!

[mProjectsCode]

On further thought, I would prefer something like the following:

// illegal characters in the form `[illegal_character, replacement][]`
const ILLEGAL_FILENAME_CHARACTERS = [["\/", ""], ["<", ""], [">", ""], [":", " - "], ["\"", "'"], ["\\", ""], ["|", " - "], ["?", ""], ["*", ""], ["[", "("], ["]", ")"], ["^", ""], ["#", ""]];

// ...

cleanFileName(fileName: string): string {
    const cleanedFileName = ILLEGAL_FILENAME_CHARACTERS.reduce((str, char) => str.replaceAll(char[0], char[1]), fileName);
    // remove all duplicate whitespace in the file name
    return cleaneFileName.replaceAll(/ +/g, " ");
}

(Not tested)

[Spydarlee]

Refactored! I tested against a bunch of movies and games with unusual characters in their titles:

[REC] 3: Genesis ➡ (REC) 3 - Genesis
Pokémon Ruby/Sapphire ➡ Pokémon Ruby-Sapphire
#Home ➡ Home

Seems to work well. 🙂