Sort modules (#72)

* Update configuration parameters and add sortModules

Co-authored-by: byara <[email protected]>

README.md

@@ -49,10 +49,6 @@ uses [`new RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
 to evaluate regular expression. E.g. `node.source.value.match(new RegExp(val))` Here, `val` 
 is the string provided in import order.
 
-#### `importOrderSeparation`
-A boolean value to enable or disable the new line separation 
-between sorted import declarations. The separation takes place according to `importOrder`.
-
 #### `importOrderCaseInsensitive`
 A boolean value to enable case-insensitivity in the sorting algorithm 
 used to order imports within each match group.
@@ -71,6 +67,14 @@ import ExamplesList from './ExamplesList';
 import ExampleView from './ExampleView';
 ```
 
+#### `importOrderSeparation`
+A boolean value to enable or disable the new line separation 
+between sorted import declarations. The separation takes place according to `importOrder`.
+
+#### `sortModules`
+A boolean value to enable or disable sorting of the imports module declarations.
+It is disabled by default
+
 #### `experimentalBabelParserPluginsList`
 A collection of parser names for babel parser. The plugin passes this list to babel parser so it can understand the syntaxes used in the file being formatted. The plugin uses prettier itself to figure out the parser it needs to use but if that fails, you can use this field to enforce the usage of the plugins babel needs.
 

src/index.ts

@@ -4,6 +4,13 @@ import { parsers as typescriptParsers } from 'prettier/parser-typescript';
 import { preprocessor } from './preprocessor';
 
 const options = {
+    experimentalBabelParserPluginsList: {
+        type: 'path',
+        category: 'Global',
+        array: true,
+        default: [{ value: [] }],
+        description: 'Provide a list of plugins for special syntax',
+    },
     importOrder: {
         type: 'path',
         category: 'Global',
@@ -17,13 +24,12 @@ const options = {
         default: false,
         description: 'Should imports be separated by new line ?',
     },
-    experimentalBabelParserPluginsList: {
-        type: 'path',
+    sortModules: {
+        type: 'boolean',
         category: 'Global',
-        array: true,
-        default: [{ value: [] }],
-        description: 'Provide a list of plugins for special syntax',
-    }
+        default: false,
+        description: 'Should modules be sorted ?',
+    },
 };
 
 module.exports = {

src/preprocessor.ts

@@ -10,11 +10,12 @@ import { getExperimentalParserPlugins } from './utils/get-experimental-parser-pl
 
 export function preprocessor(code: string, options: PrettierOptions) {
     const {
+        experimentalBabelParserPluginsList = [],
         importOrder,
-        importOrderSeparation,
         importOrderCaseInsensitive,
+        importOrderSeparation,
         parser: prettierParser,
-        experimentalBabelParserPluginsList = [],
+        sortModules,
     } = options;
 
     const plugins = getParserPlugins(prettierParser);
@@ -44,12 +45,12 @@ export function preprocessor(code: string, options: PrettierOptions) {
     // short-circuit if there are no import declaration
     if (importNodes.length === 0) return code;
 
-    const allImports = getSortedNodes(
-        importNodes,
+    const allImports = getSortedNodes(importNodes, {
         importOrder,
-        importOrderSeparation,
         importOrderCaseInsensitive,
-    );
+        importOrderSeparation,
+        sortModules,
+    });
 
     return getCodeFromAst(allImports, code, interpreter);
 }

src/types.ts

@@ -1,8 +1,9 @@
 import { RequiredOptions } from 'prettier';
 
 export interface PrettierOptions extends RequiredOptions {
+    experimentalBabelParserPluginsList: string[]; // should be of type ParserPlugin from '@babel/parser' but prettier does not support nested arrays in options
     importOrder: string[];
-    importOrderSeparation: boolean;
     importOrderCaseInsensitive: boolean;
-    experimentalBabelParserPluginsList: string[]; // should be of type ParserPlugin from '@babel/parser' but prettier does not support nested arrays in options
+    importOrderSeparation: boolean;
+    sortModules: boolean;
 }