case-sensitive-paths-webpack-plugin

Case Sensitive Paths - Webpack Plugin

This Webpack plugin enforces the entire path of all required modules match the exact case of the actual path on disk. Using this plugin helps alleviate cases where developers working on OSX, which does not follow strict path case sensitivity, will cause conflicts with other developers or build boxes running other operating systems which require correctly cased paths.

Previous iterations on this same idea provide the basis for this plugin, but unfortunately do not properly check case on the entire path. This plugin fixes that. Example output:

ERROR in ./src/containers/SearchProducts.js Module not found: Error: [CaseSensitivePathsPlugin] /Users/example/yourproject/src/components/searchProducts/searchproducts.js does not match the corresponding path on disk /Users/example/yourproject/src/components/searchproducts @ ./src/containers/SearchProducts.js 9:22-84

Install

npm install --save-dev case-sensitive-paths-webpack-plugin

Usage

var CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin');

var webpackConfig = {
    plugins: [
        new CaseSensitivePathsPlugin()
        // other plugins ...
    ]
    // other webpack config ...
}

Want more information? Pass {debug: true} to the plugin like so:

new CaseSensitivePathsPlugin({debug: true})

It will output every directory it reads, as well as a sum total of filesystem operations. This is mostly useful for internal debugging of the plugin, but if you find it useful, more power to you.

Demo

Check the /demo directory for a working example of the plugin in action, with tests demonstrating the effect of the plugin. See /demo/README.md for more.

Thanks & Credit

• Daniel Cousineau who wrote an earlier version of this case-sensitivity plugin
• Alexandre Kirszenberg who's gist formed the basis of both these plugins.
• Cameron Brewer and Ben Collins who added Windows support.
• Christian Lilley who added a demo/test package.
• Lance Eastgate who added some internationalization support
• Jonathan Kim and Dan Abramov who investigated, fixed, and added some tests for a crashing bug.
• Jason Quense who switched it to properly use the webpack-provided fs object.
• Cesare Soldini who added a test
• Kirill Konshin who helped update to Webpack 5

License

Changelog

v2.4.0

• Updating versions & tests for development 1d11967
• Update dependencies, travis targets. 31491e0
• Run prettier on test index. 3bf9fa2
• Run prettier across index. f12aa57
• Automatically generate changelog dc7765e
• Add test case ensuring deeply nested folder case problems are caught 198c7e1
• [#54] Unescape # in paths 7d05a0a
• Change the pathCache to be a Map. 737dadd
• Changelog c662bc4
• Bump lodash from 4.17.15 to 4.17.19 08dec5d
• Credit 30dcfc1

Similar packages

Other packages similar to case-sensitive-paths-webpack-plugin

force-case-sensitivity-webpack-plugin

This is another Webpack plugin that serves a similar purpose to case-sensitive-paths-webpack-plugin. It forces the resolution of modules to be case-sensitive. It is very similar in functionality but might differ slightly in implementation details or additional options provided.