prettier-plugin-organize-imports/index.js

Make prettier organize your imports using the TypeScript language service API.

/**
 * @todo change these to their new locations (`prettier/plugins/<parser>`) with
 * the next major release. (requires dropping Prettier 2.x support)
 */
// @ts-expect-error
const { parsers: babelParsers } = require('prettier/parser-babel');
// @ts-expect-error
const { parsers: htmlParsers } = require('prettier/parser-html');
// @ts-expect-error
const { parsers: typescriptParsers } = require('prettier/parser-typescript');

const { organize } = require('./lib/organize');

/**
 * Organize the code's imports using the `organizeImports` feature of the TypeScript language service API.
 *
 * @param {string} code
 * @param {import('prettier').ParserOptions} options
 */
const organizeImports = (code, options) => {
	if (code.includes('// organize-imports-ignore') || code.includes('// tslint:disable:ordered-imports')) {
		return code;
	}

	const isRange =
		Boolean(options.originalText) ||
		options.rangeStart !== 0 ||
		(options.rangeEnd !== Infinity && options.rangeEnd !== code.length);

	if (isRange) {
		return code; // processing a range doesn't make sense
	}

	try {
		return organize(code, options);
	} catch (error) {
		if (process.env.DEBUG) {
			console.error(error);
		}

		return code;
	}
};

/**
 * Set `organizeImports` as the given parser's `preprocess` hook, or merge it with the existing one.
 *
 * @param {import('prettier').Parser} parser prettier parser
 */
const withOrganizeImportsPreprocess = (parser) => {
	return {
		...parser,
		/**
		 * @param {string} code
		 * @param {import('prettier').ParserOptions} options
		 */
		preprocess: (code, options) =>
			organizeImports(parser.preprocess ? parser.preprocess(code, options) : code, options),
	};
};

/**
 * @type {import('prettier').Plugin}
 */
const plugin = {
	options: {
		organizeImportsSkipDestructiveCodeActions: {
			type: 'boolean',
			default: false,
			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),
		'babel-ts': withOrganizeImportsPreprocess(babelParsers['babel-ts']),
		typescript: withOrganizeImportsPreprocess(typescriptParsers.typescript),
		vue: withOrganizeImportsPreprocess(htmlParsers.vue),
	},
};

module.exports = plugin;