quick note on caseSensitive no-unresolved param

import-js · Sep 29, 2016 · 2dec0a7 · 2dec0a7
1 parent a81d5bb
commit 2dec0a7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/rules/no-unresolved.md b/docs/rules/no-unresolved.md
@@ -67,6 +67,14 @@ import { x } from './mod' // may be reported, if not resolved to a module
 import coolImg from '../../img/coolImg.img' // will not be reported, even if not found
 ```
 
+#### `caseSensitive`
+
+By default, this rule will report paths whose case do not match the underlying filesystem path, if the FS is not case-sensitive. To disable this behavior, set the `caseSensitive` option to `false`.
+
+```js
+/*eslint import/no-unresolved: [2, { caseSensitive: true (default) | false }]*/
+const { default: x } = require('./foo') // reported if './foo' is actually './Foo' and caseSensitive: true
+```
 
 ## When Not To Use It