https://github.com/bfncs/codemod-imports-sort

Sort ES6 imports by type
https://github.com/bfncs/codemod-imports-sort

codemod esnext import

Last synced: 6 days ago
JSON representation

Sort ES6 imports by type

• Host: GitHub
• URL: https://github.com/bfncs/codemod-imports-sort
• Owner: bfncs
• Created: 2017-04-07T21:17:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-07T16:37:23.000Z (over 6 years ago)
• Last Synced: 2024-10-17T02:41:18.436Z (23 days ago)
• Topics: codemod, esnext, import
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/codemod-imports-sort
• Size: 91.8 KB
• Stars: 38
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-codemods - codemod-imports-sort - Sort ES6 imports by type. (JavaScript)

README

        
[![Build Status](https://travis-ci.org/bfncs/codemod-imports-sort.svg?branch=master)](https://travis-ci.org/bfncs/codemod-imports-sort)

# CodeMod to sort ES6 imports by type

Use this codemod to sort ES6 imports by type in this order:

* internal Node.js modules before

* external module imports before

* local imports from parent folders before

* local imports from sibling folders.

Imports of the same type are sorted alphabetically.

## Install

```bash

yarn global add codemod-imports-sort

```

## Use

```bash

codemod-imports-sort path/to/file.js

```

## Example

Before:

```js

import './index.css';

import Beta from 'Beta';

import fs from 'fs';

import bar from '../bar';

import './';

import baz from './baz';

import Alpha from 'alpha';

import foo from '../../foo';

import App from './App';

```

After:

```js

import fs from 'fs';

import Alpha from 'alpha';

import Beta from 'Beta';

import foo from '../../foo';

import bar from '../bar';

import './';

import App from './App';

import baz from './baz';

import './index.css';

```

### Options

#### `--sortConfig FILE.json`

Optionally you can pass the path to a JSON file with a config to define the desired order of imports. The config should resemble the config for the [`import/order`](https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md) plugin of eslint. `groups` must be an array of `string` or [`string`]. The only allowed `string`s are: `"builtin"`, `"external"`, `"scoped-external"`, `"internal"`, `"parent"`, `"sibling"`, `"index"`.

For example to define to sort index imports first, then internal and external modules in a alphabetically sorted group and then sibling, parent and builtin modules together in a group, use this configuration:

```json

{

  "groups": [

    "index",

    ["internal", "external"],

    ["sibling", "parent", "builtin"]

  ]

}

```

Omitted types are implicitly grouped together as the last element

_Built with [jscodeshift](https://github.com/facebook/jscodeshift)._