[Breaking] Remove importOrderBuiltinModulesToTop (always true) (#60)

Reference: #22 This is the first step towards removing some options from this plugin, to make it a bit more opinionated and easy to configure (and maintain). This PR removes the option for `importOrderBuiltinModulesToTop`, and instead sorts builtins to the top always. We could potentially add a special flag for use in `importOrder` if someone wants to control the order of where the builtins appear, but I'd like to avoid doing that unless it becomes necessary.
IanVS · Apr 22, 2023 · 9d0f3a1 · 9d0f3a1
1 parent e247e1d
commit 9d0f3a1
Show file tree

Hide file tree

Showing 16 changed files with 58 additions and 135 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Since then more critical features & fixes have been added. As a result, this rep
 -   Do not re-order across side-effect imports
 -   Combine imports from the same source ([`importOrderMergeDuplicateImports`](#importordermergeduplicateimports))
 -   Combine type and value imports ([`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports))
--   Sort node.js builtin modules to top ([`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop))
+-   Sorts node.js builtin modules to top
 -   Custom import order separation ([`importOrderSeparation`](#importorderseparation))
 
 [We welcome contributions!](./CONTRIBUTING.md)
@@ -35,7 +35,6 @@ Since then more critical features & fixes have been added. As a result, this rep
         -   [`importOrderMergeDuplicateImports`](#importordermergeduplicateimports)
         -   [`importOrderCombineTypeAndValueImports`](#importordercombinetypeandvalueimports)
         -   [`importOrderParserPlugins`](#importorderparserplugins)
-        -   [`importOrderBuiltinModulesToTop`](#importorderbuiltinmodulestotop)
     -   [Prevent imports from being sorted](#prevent-imports-from-being-sorted)
 -   [FAQ / Troubleshooting](#faq--troubleshooting)
 -   [Compatibility](#compatibility)
@@ -131,7 +130,6 @@ module.exports = {
     singleQuote: true,
     semi: true,
     importOrder: ['^@core/(.*)$', '^@server/(.*)$', '^@ui/(.*)$', '^[./]'],
-    importOrderBuiltinModulesToTop: true,
     importOrderCaseInsensitive: true,
     importOrderParserPlugins: ['typescript', 'jsx', 'decorators-legacy'],
     importOrderMergeDuplicateImports: true,
@@ -352,14 +350,6 @@ with options as a JSON string of the plugin array:
 "importOrderParserPlugins": []
 ```
 
-#### `importOrderBuiltinModulesToTop`
-
-**type**: `boolean`
-
-**default value:** `false`
-
-A boolean value to enable sorting of [`node builtins`](https://nodejs.org/api/module.html#modulebuiltinmodules) to the top of all import groups.
-
 ### Prevent imports from being sorted
 
 This plugin supports standard prettier ignore comments. By default, side-effect imports (like

diff --git a/src/constants.ts b/src/constants.ts
@@ -1,6 +1,7 @@
+import { builtinModules } from 'module';
+
 import { ParserPlugin } from '@babel/parser';
 import { expressionStatement, stringLiteral } from '@babel/types';
-import { builtinModules } from 'module';
 
 export const flow: ParserPlugin = 'flow';
 export const typescript: ParserPlugin = 'typescript';

diff --git a/src/index.ts b/src/index.ts
@@ -62,12 +62,6 @@ export const options: Record<
         default: false,
         description: 'Should specifiers be sorted?',
     },
-    importOrderBuiltinModulesToTop: {
-        type: 'boolean',
-        category: 'Global',
-        default: false,
-        description: 'Should node-builtins be hoisted to the top?',
-    },
     importOrderMergeDuplicateImports: {
         type: 'boolean',
         category: 'Global',

diff --git a/src/preprocessors/preprocessor.ts b/src/preprocessors/preprocessor.ts
@@ -12,7 +12,6 @@ export function preprocessor(code: string, options: PrettierOptions): string {
     const {
         importOrderParserPlugins,
         importOrder,
-        importOrderBuiltinModulesToTop,
         importOrderCaseInsensitive,
         importOrderGroupNamespaceSpecifiers,
         importOrderMergeDuplicateImports,
@@ -70,7 +69,6 @@ export function preprocessor(code: string, options: PrettierOptions): string {
 
     const nodesToOutput = getSortedNodes(allOriginalImportNodes, {
         importOrder,
-        importOrderBuiltinModulesToTop,
         importOrderCaseInsensitive,
         importOrderGroupNamespaceSpecifiers,
         importOrderMergeDuplicateImports,

diff --git a/src/types.ts b/src/types.ts
@@ -35,7 +35,6 @@ export type GetSortedNodes = (
     options: Pick<
         PrettierOptions,
         | 'importOrder'
-        | 'importOrderBuiltinModulesToTop'
         | 'importOrderCaseInsensitive'
         | 'importOrderGroupNamespaceSpecifiers'
         | 'importOrderMergeDuplicateImports'

diff --git a/src/utils/__tests__/get-all-comments-from-nodes.spec.ts b/src/utils/__tests__/get-all-comments-from-nodes.spec.ts
@@ -11,7 +11,6 @@ const getSortedImportNodes = (code: string, options?: ParserOptions) => {
 
     return getSortedNodes(importNodes, {
         importOrder: [],
-        importOrderBuiltinModulesToTop: false,
         importOrderCaseInsensitive: false,
         importOrderGroupNamespaceSpecifiers: false,
         importOrderMergeDuplicateImports: false,

diff --git a/src/utils/__tests__/get-code-from-ast.spec.ts b/src/utils/__tests__/get-code-from-ast.spec.ts
@@ -18,7 +18,6 @@ import a from 'a';
     const importNodes = getImportNodes(code);
     const sortedNodes = getSortedNodes(importNodes, {
         importOrder: [],
-        importOrderBuiltinModulesToTop: false,
         importOrderCaseInsensitive: false,
         importOrderGroupNamespaceSpecifiers: false,
         importOrderMergeDuplicateImports: false,
@@ -60,7 +59,6 @@ import type {See} from 'c';
     const importNodes = getImportNodes(code, { plugins: ['typescript'] });
     const sortedNodes = getSortedNodes(importNodes, {
         importOrder: [],
-        importOrderBuiltinModulesToTop: false,
         importOrderCaseInsensitive: false,
         importOrderGroupNamespaceSpecifiers: false,
         importOrderMergeDuplicateImports: true,