streamich/memfs

Support for case sensitivity settings

Open

#533 opened on May 6, 2020

View on GitHubContributor guide
 (8 comments) (1 reaction) (0 assignees)TypeScript (147 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (2,062 stars)
PR merge metrics
 (Avg merge 4d 8h) (8 merged PRs in 30d)

Description

Hi! As you probably know, there are 2 options for case sensitivity:

  • Windows use case sensitive paths,
  • other systems like macOS or Linux use case insensitive paths

I checked how memfs behave and it seems that it uses case sensitive approach:

const { fs } = require('memfs');

fs.writeFileSync('/my/Case/sensitive/Path.txt', 'content');

console.log(fs.readFileSync('/my/case/sensitive/path.txt'));
// logs undefined
// if I would use native fs on macOS or Linux, I would get "content" logged
// so it's kind of inconsistency between memfs and fs

It would be nice if:

  1. there would be an option to configure it
  2. the default behavior would be to use system settings

Contributor guide

Research direction
Examine the current file system implementation to identify where case sensitivity is handled and how to introduce a configurable option that mirrors the host OS behavior.
Tech stack
typescript
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70