import-js/eslint-plugin-import

What is the signifance of each group name? what do they mean?

Open

#1,930 opened on Oct 22, 2020

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (1,540 forks)batch import
docshelp wanted

Repository metrics

Stars
 (4,946 stars)
PR merge metrics
 (Avg merge 138d 22h) (3 merged PRs in 30d)

Description

Some of the words might be obvious to seasoned developers, but for others it's not so obvious.

Here's my understanding :

src/App/AppContainer.js where ~ is an alias to src/**

import fs from 'fs' // builtin
import path from 'path' // builtin

import React, { Component } from 'react' // external
import '@babel/register' // external

import { MagicalPonyContainer } from '~/unicorns/MagicalPonyContainer' // internal ?

import { TrollFaceContainer } from '../Components/TrollFaceContainer' // parent ?

import 'omgfacerolllmao' // unknown ?

import './something/index.js' // index ? 

import { App } from './App' // sibling ?
import './App.scss' // sibling ?

// no idea what object would be.

This could all be wrong, or it's completely right. In any case I feel it's worth illustrating this in the readme.

I'm happy to make a PR on this, but perhaps some guidance and input from others with a better understanding would be great.

Contributor guide