https://github.com/willhoney7/eslint-plugin-import-helpers

ESLint plugin to help enforce a configurable order for import statements
https://github.com/willhoney7/eslint-plugin-import-helpers

eslint eslint-rules eslintrc import imports

Last synced: 5 days ago
JSON representation

ESLint plugin to help enforce a configurable order for import statements

• Host: GitHub
• URL: https://github.com/willhoney7/eslint-plugin-import-helpers
• Owner: willhoney7
• Created: 2019-03-21T21:26:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T02:24:22.000Z (almost 2 years ago)
• Last Synced: 2024-04-09T16:21:18.840Z (9 months ago)
• Topics: eslint, eslint-rules, eslintrc, import, imports
• Language: JavaScript
• Homepage:
• Size: 659 KB
• Stars: 286
• Watchers: 5
• Forks: 19
• Open Issues: 10
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# eslint-plugin-import-helpers

> Originally forked/inspired by [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) and [this fork](https://github.com/dannysindra/eslint-plugin-import)

[![npm version](https://badge.fury.io/js/eslint-plugin-import-helpers.svg)](https://badge.fury.io/js/eslint-plugin-import-helpers)

This package was created to supplement the rules provided by [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import). There are a lot of great rules in there, but we found it missing a few key use cases.

# Rules

#### [`order-imports`]

Enforce a _configurable_ convention in module import order. See the [`order-imports`] page for configuration details.

```javascript

// Given ESLint Config

rules: {

  'import-helpers/order-imports': [

      'warn',

      {

          newlinesBetween: 'always', // new line between groups

          groups: [

              'module',

              '/^@shared/',

              ['parent', 'sibling', 'index'],

          ],

          alphabetize: { order: 'asc', ignoreCase: true },

      },

  ],

}

// will fix

import SiblingComponent from './SiblingComponent';

import lodash from 'lodash';

import SharedComponent from '@shared/components/SharedComponent';

import React from 'react';

// into

import lodash from 'lodash';

import React from 'react';

import SharedComponent from '@shared/components/SharedComponent';

import SiblingComponent from './SiblingComponent';

```

[`order-imports`]: ./docs/rules/order-imports.md

# Installation

```sh

npm install eslint-plugin-import-helpers -g

```

or if you manage ESLint as a dev dependency:

```sh

# inside your project's working tree

npm install eslint-plugin-import-helpers --save-dev

```

To add a rule, update your `.eslintrc.(yml|json|js)`:

```js

{

    // .eslintrc.js

    plugins: ['eslint-plugin-import-helpers'],

    rules: {

        'import-helpers/order-imports': [

            'warn',

            { // example configuration

                newlinesBetween: 'always',

                groups: [

                    'module',

                    '/^@shared/',

                    ['parent', 'sibling', 'index'],

                ],

                alphabetize: { order: 'asc', ignoreCase: true },

            },

        ],

    }

}

```

# TypeScript

To use this plugin with TypeScript, you must use the TypeScript parser for ESLint. See [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser) for more details.

# Working with This Repo

## Dependencies

| Name                          | Version |

| ----------------------------- | ------- |

| [node.js](https://nodejs.org) | 16.x    |

## Running Tests

First, `npm install`

Then, `npm test`