feat: add overrideBuiltinModules option (default to true)

fix #5

Author: Fernando Maia

README.md

@@ -1,87 +1,98 @@
 # import-sort-style-module-alias
 
 A style for [import-sort](https://github.com/renke/import-sort) that is focused
-on modules with relative aliases support.
+on modules with relative modules alias support.
+
+## Options
+
+| Name                   | Type     | Description                                                       | Default value |
+| ---------------------- | -------- | ----------------------------------------------------------------- | ------------- |
+| alias                  | string[] | List of resolver aliases                                          | []            |
+| overrideBuiltInModules | boolean  | Whether an alias should override a Node built-in module (e.g. fs) | true          |
 
 ## Configuration
+
 package.json:
+
 ```json
 {
-    "importSort": {
-        ".js, .jsx, .es6, .es": {
-            "parser": "babylon",
-            "style": "module-alias",
-            "options": {
-                "alias": ["components", "modules"]
-            }
-        },
-        ".ts, .tsx": {
-            "parser": "typescript",
-            "style": "module-alias",
-            "options": {
-                "alias": ["components", "modules"]
-            }
-        }
+  "importSort": {
+    ".js, .jsx, .es6, .es": {
+      "parser": "babylon",
+      "style": "module-alias",
+      "options": {
+        "alias": ["components", "modules"],
+        "overrideBuiltinModules": true
+      }
+    },
+    ".ts, .tsx": {
+      "parser": "typescript",
+      "style": "module-alias",
+      "options": {
+        "alias": ["components", "modules"]
+      }
     }
+  }
 }
 ```
 
 or .sortimportrc:
+
 ```json
 {
-    ".js, .jsx, .es6, .es": {
-        "parser": "babylon",
-        "style": "module-alias",
-        "options": {
-            "alias": ["components", "modules"]
-        }
-    },
-    ".ts, .tsx": {
-        "parser": "typescript",
-        "style": "module-alias",
-        "options": {
-            "alias": ["components", "modules"]
-        }
+  ".js, .jsx, .es6, .es": {
+    "parser": "babylon",
+    "style": "module-alias",
+    "options": {
+      "alias": ["components", "modules"]
+    }
+  },
+  ".ts, .tsx": {
+    "parser": "typescript",
+    "style": "module-alias",
+    "options": {
+      "alias": ["components", "modules"]
     }
+  }
 }
 ```
 
 ## Result
 
 ```js
 // Third-party modules with side effects (not sorted because order may matter)
-import "a";
-import "c";
-import "b";
+import 'a';
+import 'c';
+import 'b';
 
 // First-party alias modules with side effects (not sorted because order may matter)
-import "{aliasA}";
-import "{aliasC}";
-import "{aliasB}";
+import '{aliasA}';
+import '{aliasC}';
+import '{aliasB}';
 
 // First-party relative modules with side effects (not sorted because order may matter)
-import "./a";
-import "./c";
-import "./b";
+import './a';
+import './c';
+import './b';
 
 // Modules from the Node.js "standard" library sorted by name
-import {readFile, writeFile} from "fs";
-import * as path from "path";
+import { readFile, writeFile } from 'fs';
+import * as path from 'path';
 
 // Third-party modules sorted by name
-import aa from "aa";
-import bb from "bb";
-import cc from "cc";
+import aa from 'aa';
+import bb from 'bb';
+import cc from 'cc';
 
 // First-party alias modules sorted by name
-import aaa from "{aliasAAA}";
-import bbb from "{aliasBBB}";
+import aaa from '{aliasAAA}';
+import bbb from '{aliasBBB}';
 
 // First-party relative modules sorted by "relative depth" and then by name
-import aaa from "../../aaa";
-import bbb from "../../bbb";
-import aaaa from "../aaaa";
-import bbbb from "../bbbb";
-import aaaaa from "./aaaaa";
-import bbbbb from "./bbbbb";
+import aaa from '../../aaa';
+import bbb from '../../bbb';
+import aaaa from '../aaaa';
+import bbbb from '../bbbb';
+import aaaaa from './aaaaa';
+import bbbbb from './bbbbb';
 ```

src/index.ts

@@ -3,6 +3,7 @@ import { IStyleAPI, IStyleItem } from 'import-sort-style';
 
 export interface Options {
   alias: string[];
+  overrideBuiltinModules: boolean;
 }
 
 const hasAlias = (aliases: string[]) => (imported: IImport): boolean =>
@@ -15,7 +16,7 @@ const hasAlias = (aliases: string[]) => (imported: IImport): boolean =>
 export default (
   styleApi: IStyleAPI,
   _file?: string,
-  options?: Options
+  { alias: aliases = [], overrideBuiltinModules = true } = {} as Options
 ): IStyleItem[] => {
   const {
     alias,
@@ -31,7 +32,7 @@ export default (
     unicode,
   } = styleApi;
 
-  const isAliasModule = hasAlias((options && options.alias) || []);
+  const isAliasModule = hasAlias(aliases || []);
 
   return [
     // import "foo"
@@ -48,7 +49,9 @@ export default (
 
     // import … from "fs";
     {
-      match: isNodeModule,
+      match: overrideBuiltinModules
+        ? and(isNodeModule, not(isAliasModule))
+        : isNodeModule,
       sort: moduleName(naturally),
       sortNamedMembers: alias(unicode),
     },