airbnb / airbnb/javascript

Misleading documentation 10.8

Open
#2,206 6 comments 2 reactions 0 assignees View on GitHub
needs eslint rule change/addition
Dominant language
JavaScript
Stars
148k
Forks
26.6k
PR merge metrics
No merged PRs in 30d

Description

The documentation for [10.8](https://github.com/airbnb/javascript#modules--multiline-imports-over-newlines) references [`object-curly-newline`](https://github.com/airbnb/javascript#modules--multiline-imports-over-newlines) however object-curly-newline does not catch this rule. Furthermore airbnb's set of rules also doesn't catch this rule.

See [Example](https://eslint.org/demo#eyJ0ZXh0IjoiaW1wb3J0IHtmb28sIFxuICAgICAgICBiYXIsIGJheiwgYmFuZ30gZnJvbSAnZm9vLWJhcic7XG5cbmNvbnN0IHRoaW5nID0ge1xuICBmaXJzdCA6IGZvbyxcbiAgc2Vjb25kIDogYmFyLCBcbiAgdGhpcmQgOiBiYXosIGZvdXJ0aCA6IGJhbmdcbn1cblxuY29uc3QgbGlzdCA9IFtcbiAgZm9vLFxuICBiYXIsXG4gIGJheiwgYmFuZ1xuXTtcblxuKGxpc3QhPT10aGluZykiLCJvcHRpb25zIjp7InBhcnNlck9wdGlvbnMiOnsiZWNtYVZlcnNpb24iOjExLCJzb3VyY2VUeXBlIjoibW9kdWxlIiwiZWNtYUZlYXR1cmVzIjp7fX0sInJ1bGVzIjp7ImNvbnN0cnVjdG9yLXN1cGVyIjoyLCJmb3ItZGlyZWN0aW9uIjoyLCJnZXR0ZXItcmV0dXJuIjoyLCJuby1hc3luYy1wcm9taXNlLWV4ZWN1dG9yIjoyLCJuby1jYXNlLWRlY2xhcmF0aW9ucyI6Miwibm8tY2xhc3MtYXNzaWduIjoyLCJuby1jb21wYXJlLW5lZy16ZXJvIjoyLCJuby1jb25kLWFzc2lnbiI6Miwibm8tY29uc3QtYXNzaWduIjoyLCJuby1jb25zdGFudC1jb25kaXRpb24iOjIsIm5vLWNvbnRyb2wtcmVnZXgiOjIsIm5vLWRlYnVnZ2VyIjoyLCJuby1kZWxldGUtdmFyIjoyLCJuby1kdXBlLWFyZ3MiOjIsIm5vLWR1cGUtY2xhc3MtbWVtYmVycyI6Miwibm8tZHVwZS1rZXlzIjoyLCJuby1kdXBsaWNhdGUtY2FzZSI6Miwibm8tZW1wdHkiOjIsIm5vLWVtcHR5LWNoYXJhY3Rlci1jbGFzcyI6Miwibm8tZW1wdHktcGF0dGVybiI6Miwibm8tZXgtYXNzaWduIjoyLCJuby1leHRyYS1ib29sZWFuLWNhc3QiOjIsIm5vLWV4dHJhLXNlbWkiOjIsIm5vLWZhbGx0aHJvdWdoIjoyLCJuby1mdW5jLWFzc2lnbiI6Miwibm8tZ2xvYmFsLWFzc2lnbiI6Miwibm8taW5uZXItZGVjbGFyYXRpb25zIjoyLCJuby1pbnZhbGlkLXJlZ2V4cCI6Miwibm8taXJyZWd1bGFyLXdoaXRlc3BhY2UiOjIsIm5vLW1pc2xlYWRpbmctY2hhcmFjdGVyLWNsYXNzIjoyLCJuby1taXhlZC1zcGFjZXMtYW5kLXRhYnMiOjIsIm5vLW5ldy1zeW1ib2wiOjIsIm5vLW9iai1jYWxscyI6Miwibm8tb2N0YWwiOjIsIm5vLXByb3RvdHlwZS1idWlsdGlucyI6Miwibm8tcmVkZWNsYXJlIjoyLCJuby1yZWdleC1zcGFjZXMiOjIsIm5vLXNlbGYtYXNzaWduIjoyLCJuby1zaGFkb3ctcmVzdHJpY3RlZC1uYW1lcyI6Miwibm8tc3BhcnNlLWFycmF5cyI6Miwibm8tdGhpcy1iZWZvcmUtc3VwZXIiOjIsIm5vLXVuZGVmIjoyLCJuby11bmV4cGVjdGVkLW11bHRpbGluZSI6Miwibm8tdW5yZWFjaGFibGUiOjIsIm5vLXVuc2FmZS1maW5hbGx5IjoyLCJuby11bnNhZmUtbmVnYXRpb24iOjIsIm5vLXVudXNlZC1sYWJlbHMiOjIsIm5vLXVudXNlZC12YXJzIjoyLCJuby11c2VsZXNzLWNhdGNoIjoyLCJuby11c2VsZXNzLWVzY2FwZSI6Miwibm8td2l0aCI6MiwicmVxdWlyZS15aWVsZCI6MiwidXNlLWlzbmFuIjoyLCJ2YWxpZC10eXBlb2YiOjIsIm9iamVjdC1jdXJseS1uZXdsaW5lIjoyLCJvYmplY3QtY3VybHktc3BhY2luZyI6Miwib2JqZWN0LXByb3BlcnR5LW5ld2xpbmUiOjIsImFycmF5LWJyYWNrZXQtbmV3bGluZSI6MiwiYXJyYXktYnJhY2tldC1zcGFjaW5nIjoyLCJhcnJheS1lbGVtZW50LW5ld2xpbmUiOjJ9LCJlbnYiOnt9fX0=)

The guidance is good, however the documentation leads you to believe the linter will catch you if you put imports on the same line, which it doesn't.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the documentation for rule 10.8 and its linked `object-curly-newline` rule, then compare that guidance with the ESLint example linked in the issue. Determine how the text should explain that the linter does not enforce the import formatting; done means the documentation no longer implies that it does.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, javascript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.