Case Sensitivity

[drewyoungren]

This is a small thing, but when I initially tried to build the app locally it failed for a very specific reason. I'm on macOS and the APFS is by default case insensitive so some, but only very few, import statements failed. Specifically, it was those looking at either of

packages/doenetml/src/Viewer/renderers/utils/description.ts
packages/doenetml/src/Viewer/renderers/utils/Description.tsx

that caused the issue.
At first I just renamed them and got it to work, but as that is not ideal, I just made a case-sensitive volume on my hard drive (which I should probably use for all dev repos), and it worked fine. Anyway, it might be good to change the names to avoid this or make a note in the README for those on platforms with a case-insensitive file system.

[dqnykamp]

I think we should add a test to our CI that will fail if we have case-insensitive collisions.

We could add a CI test that attempts to build or test in a MacOS environment, e.g., with runs-on: macos-latest. However, given how long our CI currently takes, that seems like it would add a lot.

What about adding a test to directly search for case-insensitive collisions? This one was created by Gemini.

- name: Check for case-insensitive file collisions
        run: |
          # 1. Find all tracked JS/TS files
          # 2. Strip the extensions
          # 3. Convert to lowercase
          # 4. Find duplicates
          COLLISIONS=$(git ls-files | grep -Ei '\.(ts|tsx|js|jsx)$' | sed -E 's/\.(ts|tsx|js|jsx)$//i' | tr '[:upper:]' '[:lower:]' | sort | uniq -d)
          
          if [ -n "$COLLISIONS" ]; then
            echo "❌ Error: Found files that will collide on case-insensitive file systems (like macOS/Windows):"
            echo ""
            for collision in $COLLISIONS; do
              echo "Collision base path: $collision"
              # Print the actual files that are conflicting
              git ls-files | grep -iE "^${collision}\.(ts|tsx|js|jsx)$" | sed 's/^/  - /'
            done
            exit 1
          else
            echo "✅ No case-insensitive collisions found."
          fi

If I run the script in bash, it does find the two description files that collide.

[siefkenj]

That seems like something reasonable to add to the lint tests.

[dqnykamp]

PR #1309 adds the case-insensitive collision check to the CI and then fixes the collision with the description files.