feat: allow configuration of organizeImportsTypeOrder (#152)

Author: goege64

index.js

@@ -70,6 +70,25 @@ const plugin = {
 			category: 'OrganizeImports',
 			description: 'Skip destructive code actions like removing unused imports.',
 		},
+		organizeImportsTypeOrder: {
+			type: 'choice',
+			choices: [
+				{
+					value: 'last',
+					description: 'Places type imports last.',
+				},
+				{
+					value: 'first',
+					description: 'Places type imports first.',
+				},
+				{
+					value: 'inline',
+					description: 'Keeps type imports in place.',
+				},
+			],
+			category: 'OrganizeImports',
+			description: 'How to sort type imports when mixed in an import statement.',
+		},
 	},
 	parsers: {
 		babel: withOrganizeImportsPreprocess(babelParsers.babel),

lib/organize.js

@@ -10,7 +10,7 @@ const { getLanguageService } = require('./get-language-service');
  */
 module.exports.organize = (
 	code,
-	{ filepath = 'file.ts', organizeImportsSkipDestructiveCodeActions, parentParser, parser },
+	{ filepath = 'file.ts', organizeImportsSkipDestructiveCodeActions, parentParser, parser, organizeImportsTypeOrder },
 ) => {
 	if (parentParser === 'vue') {
 		// we already did the preprocessing in the parent parser, so we skip the child parsers
@@ -26,7 +26,7 @@ module.exports.organize = (
 	const fileChanges = languageService.organizeImports(
 		{ type: 'file', fileName: filepath, skipDestructiveCodeActions: organizeImportsSkipDestructiveCodeActions },
 		{},
-		{},
+		{ organizeImportsTypeOrder },
 	)[0];
 
 	return fileChanges ? applyTextChanges(code, fileChanges.textChanges) : code;

prettier.d.ts

@@ -1,9 +1,13 @@
+import ts = require('typescript');
+
 declare module 'prettier' {
 	interface Options {
 		organizeImportsSkipDestructiveCodeActions?: boolean;
+		organizeImportsTypeOrder?: ts.OrganizeImportsTypeOrder;
 	}
 	interface ParserOptions {
 		organizeImportsSkipDestructiveCodeActions?: boolean;
+		organizeImportsTypeOrder?: ts.OrganizeImportsTypeOrder;
 	}
 }
 

test/main.js

@@ -87,3 +87,15 @@ test('does not remove unused imports with `organizeImportsSkipDestructiveCodeAct
 
 	t.is(formattedCode, code);
 });
+
+test('sorts type imports according to the `organizeImportsTypeOrder` option', async (t) => {
+	const code = `import { foo, type baz, bar } from "./foobarbaz";\n\nexport const foobar: baz = foo + bar;\n`;
+
+	const formattedCode1 = await prettify(code, { parser: 'typescript', organizeImportsTypeOrder: 'last' });
+	const formattedCode2 = await prettify(code, { parser: 'typescript', organizeImportsTypeOrder: 'first' });
+	const formattedCode3 = await prettify(code, { parser: 'typescript', organizeImportsTypeOrder: 'inline' });
+
+	t.is(formattedCode1, `import { bar, foo, type baz } from "./foobarbaz";\n\nexport const foobar: baz = foo + bar;\n`);
+	t.is(formattedCode2, `import { type baz, bar, foo } from "./foobarbaz";\n\nexport const foobar: baz = foo + bar;\n`);
+	t.is(formattedCode3, `import { bar, type baz, foo } from "./foobarbaz";\n\nexport const foobar: baz = foo + bar;\n`);
+});