trivago/ prettier-plugin-sort-imports

(v1.4.3) 12 days ago

TypeScript

JavaScript

import

View on GitHub

Need help with prettier-plugin-sort-imports?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

trivago

162 Stars

4 Forks

Apache License 2.0

62 Commits

11 Opened issues

Description

A prettier plugin to sort imports in typescript and javascript files by the provided RegEx order.

Services available

Need anything else?

Contributors list

No Data

Readme

Prettier plugin sort imports

Name: prettier-plugin-sort-imports
Brand: prettier-plugin-sort-imports
SKU: //trivago/prettier-plugin-sort-imports
Rating: 2.155 (162 reviews)

A prettier plugin to sort import declarations by provided RegEx order.

Install

npm

shell script
npm install --save-dev @trivago/prettier-plugin-sort-imports

or, using yarn

shell script
yarn add --dev @trivago/prettier-plugin-sort-imports

Usage

Add an order in prettier config file.

ecmascript 6
module.exports = {
  "printWidth": 80,
  "tabWidth": 4,
  "trailingComma": "all",
  "singleQuote": true,
  "jsxBracketSameLine": true,
  "semi": true,
  "importOrder": ["^@core/(.*)$", "^@server/(.*)$", "^@ui/(.*)$", "^[./]"],
  "importOrderSeparation": true,
}

APIs

importOrder

A collection of regular expressions in string format. The plugin uses

new RegExp

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

How does import sort work ?

The plugin extracts the imports which are defined in

importOrder

. These imports are local imports. The imports which are not part of the

importOrder

is considered as 3rd party imports.

After, the plugin sorts the local imports and 3rd party imports using natural sort algorithm. In the end, the plugin returns final imports with 3rd party imports on top and local imports at the end.

FAQ / Troubleshooting

Q. How can I add the RegEx imports in the

importOrder

list ?

You can define the RegEx in the

importOrder

. For example if you want to sort the following imports:

ecmascript 6
import React from 'react';
import classnames from 'classnames';
import z from '@server/z';
import a from '@server/a';
import s from './';
import p from '@ui/p';
import q from '@ui/q';

then the

importOrder

would be

["^@ui/(.*)$","^@server/(.*)$", '^[./]']

. Now, the final output would be as follows:

ecmascript 6
import classnames from 'classnames';
import React from 'react';
import p from '@ui/p';
import q from '@ui/q';
import a from '@server/a';
import z from '@server/z';
import s from './';

Q. How can I run examples in this project ?

There is a examples directory. The examples file can be formatted by using

npm run example

command.

shell script
npm run example examples/example.tsx

Maintainers

| Ayush Sharma | Behrang Yarahmadi |---|---| | | | @ayusharma_ | @behrang_y