Rule: Enforce specific order of 3rd party and internal imports

[benjamincharity]

Currently we have a organization format that is not enforced by the linter. It would be nice to have a linter rule that marked out-of-place imports as warnings within an IDE and organized imports when the linter was run with the --fix flag.

import { Foo } from '@some/3rd/party';
// line break
import { Bar } from './../bar';
// line break
// line break
// project code

Rule details:

• Group 3rd party at top of file with no preceding line break
  • 3rd party import is
    • a relative URL containing node_modules
    • an @ path import not found in tsconfig
    • path beginning with ~
• Enforce single line break
• Group internal imports (defined by relative links or paths found in tsconfig)
  • Local import is determined by:
    • relative URL
    • exclude relative URLs containing node_modules in the path
    • path beginning with @ that matches a path in tsconfig.paths
• Enforce 2 line breaks

Note: ordering within groups still enforced by TSLint.

---

• Create rule
• Make the rule fixable
• Add rule to our default ruleset

---

Resources

It looks like Shopify created something like this: https://github.com/shopify-graveyard/tslint-config-shopify/pull/48/files

See https://blog.angularindepth.com/bending-tslint-to-your-needs-6ae0a51e633 for inspiration