feat(modules.constructFiles): auto-sanitize .key value to always be valid

[BirdeeHub]

Is this a good idea? Thumbs up or thumbs down to vote I suppose?

[zenoli]

Will we ever have to look at the sanitized keys?
If no, why not generate a hash or youse some encoding function that ensures we will never have collisions (base64 wouldnt work but there might be something that encodes to just [A-Za-z0-9_].

If it's important that the sanitize function results in something human-readable and there is the possibility for collisions, I would at the very least want a safety hatch where we could override things in case of collisions.

[BirdeeHub]

They are in config.drv

But, you don't actually need to use those values, you would modify them via the constructFiles options for them anyway

You just need to not overwrite them on accident.

where we could override things in case of collisions

When a collision occurs, it adds _0, _1, etc...

And if you set the value to a valid shell variable name, it will not modify it, unless it collides with something

[zenoli]

When a collision occurs, it adds _0, _1, etc...

And if you set the value to a valid shell variable name, it will not modify it, unless it collides with something

If no collisions can occur, then thumbs up by me :-)

[zenoli]

Maybe we can keep "_" as the only separator and make it become FOO_BAR (same for FOO.BAR, FOO+BAR etc)
This would certainly avoid a whole class of collisions where your workaround with _0, _1,... would be needed otherwise.

[BirdeeHub]

This would certainly avoid a whole class of collisions where your workaround with _0, _1,... would be needed otherwise.

It would not, although there would be fewer instances

I can do this though, just substitute all invalid characters with _, that is fine with me.

[zenoli]

I'm nitpicking.
I was just thinking this might reduce clashes like dotdir vs dot-dir but in the end its up to you.

In the end it doesn't really matter as it is hidden away from the user anyway.

[BirdeeHub]

It actually simplified the sanitizeEnvVarName function to do it that way

[zenoli]

@BirdeeHub can you ping me at #378 once this is merged s.t. I can clean things up using this?

[BirdeeHub]

Ill clean up the existing modules I maintain where I needed to work around this eventually, but they are fine for now. But going forward this should be nicer. @zenoli Im merging this.