Default tsconfig.json option forceConsistentCasingInFileNames to True to create case consistency between filesystems

[dsilbergleithcu-godaddy]

🚀 Feature Request

Affected Languages

• TypeScript or Javascript
• Python
• Java
• .NET (C#, F#, ...)
• Go

General Information

• JSII Version: 6.14.14
• Platform: MacOS Big Sur

• I may be able to implement this feature request

• This feature might incur a breaking change

Description

Typescript relies on the case sensitivity of the filesystem when it checks the paths for imports. This creates issues when developing on a Win/Mac box but running CICD on Linux. It is possible to get an "all clear" from the local build, and then fail in the CICD system if a filename doesn't match the casing of the import.

Proposed Solution

By default, set the forceConsistentCasingInFileNames to true in the default options of the generated tsconfig.json file

There appear to be 2 places where the compiler options for tsc are set:

• https://github.com/aws/jsii/blob/main/packages/jsii/lib/compiler.ts
• https://github.com/aws/jsii/blob/main/packages/jsii-rosetta/lib/typescript/ts-compiler.ts

I believe the first one will impact the compiler and generate the desired output. I'm not sure what the function of the second one is. It is likely a good idea to update both.

[RomainMuller]

I'm in favour of this feature, however this can probably be considered a breaking change (not sure). We might need to make this an opt-in setting?

The jsii-rosetta compiler is unlikely to need updating - it runs against files that it generates by itself, and typically should operate in "quirks" mode (i.e: maximising chances of getting an AST out of the files, as opposed to optimising for correctness overall).

[dsilbergleithcu-godaddy]

I had a similar thought about this being a breaking change. Let me see about making this opt-in.

I'll back out the changes to jsii-rosetta. Thanks for the feedback.

[dsilbergleithcu-godaddy]

@RomainMuller I've updated my PR to reflect your comments. Please take a look when you get a chance.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.