Require cross-platform compatibility of sketch names in specification #2069
Labels
topic: documentation
Related to documentation for the project
type: enhancement
Proposed improvement
Milestone
Describe the request
Tighten the sketch folder and file name requirements in the Arduino Sketch Specification to ensure compliant names are compatible with all operating systems.
🙂 Shared Arduino sketches will be usable by anyone, regardless of which supported operating system they use.
Describe the current behavior
The Arduino Sketch Specification includes requirements for the names of the sketch folder and code files:
https://arduino.github.io/arduino-cli/dev/sketch-specification/#sketch-folders-and-files
🙁 Names that are compliant with the current specification are incompatible with the Windows operating system:
Ending With
.
https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#:~:text=Do%20not%20end%20a%20file%20or%20directory%20name%20with%20a%20space%20or%20a%20period
Reserved Names
https://learn.microsoft.com/en-ca/windows/win32/fileio/naming-a-file?redirectedfrom=MSDN#win32-file-namespaces:~:text=Do%20not%20use%20the%20following%20reserved%20names
Arduino CLI version
N/A
Operating system
N/A
Operating system version
N/A
Additional context
I did not find any instances of specification-compliant names that would be incompatible with Linux or macOS.
Example of problem caused by specification-compliant sketch name:
arduino/arduino-ide#1833 (review)
Additional requests
Issue checklist
The text was updated successfully, but these errors were encountered: