import-name rule documentation is not intuitive

[massimonewsuk]

import gql from "graphql-tag";

with override

{
  "rules": {
    "import-name": [true, { "graphql-tag": "gql" }]
  }
}

doesn't work

However it works when you do this:

{
  "rules": {
    "import-name": [true, { "graphqlTag": "gql" }]
  }
}

That took me a long time to work out, I think it should be documented or both forms allowed?

[levithomason]

Yep, this should probably just be a map of import string to identifier names.

Proposed

import _ from 'lodash'
import _ from 'lodash/fp'
import ReactDOMServer from 'react-dom/server'

"import-name": [true, {
  "lodash": "_",
  "lodash/fp": "_",
  "react-dom/server": "ReactDOMServer"
}]

Current

This is currently required 😕

"import-name": [true, {
  "lodash": "_",
  "fp": "_",
  "server": "ReactDOMServer"
}]

This is also going to conflict if some other import ends in /server, since the entire path is not considered. There is no way to allow this, for instance:

import FooServer from 'foo/server'
import BarServer from 'bar/server'

This would require two server keys in the config given the current implementation.

[JoshuaKGoldberg]

Yeah this is confusing 😂 +1 to clarifying in documentation what is or isn't allowed as a first step. Later on, allowing both might be a good change as well. I'll file a separate issue for that.

@levithomason you raise a couple interesting points on the rule's configuration. I'll file a separate issue as changing that would be a breaking change.

[taozhi8833998]

confused by graphql-tag +1