karma-runner/karma

File serving should have case-insensitive option

Open

#1722 opened on Nov 24, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (11,918 stars) (1,703 forks)batch import
discusshelp wantedtype: feature

Description

When working on Windows, most files can be accessed in a case-insensitive fashion. This can result in builds working (files are found by the operating system, and compiled into assets), but tests not working unless every reference to the file is the same casing. This is a problem, especially using ES6 module syntax.

Can an option be inserted which would allow Karma to match file names with a custom resolver function? Right now, there's a === going on, to see if a file exists in Karma's directory. I have attempted to resolve this via proxies, but have not had much luck since it doesn't really seem to be the intended use case.

I imagine the change would be very small. This is the line of code which would be affected (https://github.com/karma-runner/karma/blob/master/lib/middleware/source_files.js#L9), I'd like to make that configurable. Is this aligned with the intent of how Karma should work?

Contributor guide

Tech stack
javascriptnodejs
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Karma's middlewareBasic Node.js knowledgeAccess to a Windows machine for testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the file lib/middleware/source files.js, specifically the line where file matching occurs (line 9). Implement an option in Karma's configuration to allow case insensitive matching, possibly by adding a custom resolver function. Look at existing configuration patterns in the codebase for adding new options. Test on Windows to ensure the fix works.