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 (4,946 stars) (1,540 forks)batch import
docshelp wanted

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

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Examine the current README.md in the repository to identify if any explanation of import group names exists. Review the source files, such as 'src/core/importType.js', to understand the logic behind group classification. Based on the examples provided in the issue, draft clear definitions for each group name (builtin, external, internal, parent, index, sibling, unknown, object) and submit a PR to update the documentation.
What is the signifance of each group name? what do they mean? · import-js/eslint-plugin-import#1930 | Good First Issue