Standardize imports

[RichDom2185]

Description

Motivation: Copied over from their own documentation

Moving a file to different folder, could result in changing all imports statement in that file. This will not happen is the import paths are absolute.

Also, the current way of importing leads to stuff like

import { a } from 'src/.../file'

import { b } from '../file'

Even though a and b are defined in the same file, which does not really look nice at best and potentially misleading at worst.

Changes:

• Migrated .eslintrc from JSON to a JS file to allow for greater readability when writing rules
• Added no-relative-import-paths plugin
• Enforced absolute imports for files that are not test files (reason being test files generally import their SUT from their siblings/cousins)

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Code quality improvements

How to test

Checklist

• I have tested this code
• I have updated the documentation

[RichDom2185]

Gonna leave this as draft for a while because the changes across the files might cause merge conflicts with other PRs; let us merge as many of them in as possible first.

[ianyong]

LGTM! Only checked the changes made by hand in detail; briefly scrolled through the linter/formatter changes and they seem to be correct.

Just one minor clarification.

[ianyong]

Motivation: Copied over from their own documentation

Moving a file to different folder, could result in changing all imports statement in that file. This will not happen is the import paths are absolute.

Also, the current way of importing leads to stuff like

import { a } from 'src/.../file'

import { b } from '../file'

Even though a and b are defined in the same file, which does not really look nice at best and potentially misleading at worst.

Hmm, given the motivation for this change, is there a reason why the allowSameFolder option is set to true? More specifically, why are relative import paths for imported files from the same folder allowed? Moving a file containing such relative import paths will result in these import statements changing.

[RichDom2185]

I was thinking that it might encourage better organisation of code (e.g perhaps splitting a 1000+ line component into multiple files in the same folder, where applicable). Since this makes the distinction clear (whether the files are closely related or not), this might improve readability.

What do you think?

[ianyong]

No strong preferences! Just wanted to know if there was a rationale (which you do have) because it would be good to state it somewhere for future reference.

[coveralls]

Pull Request Test Coverage Report for Build 5219070096

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 37.881%

---

Totals
Change from base Build 5219065445:	0.0%
Covered Lines:	5349
Relevant Lines:	13243

---

💛 - Coveralls

[chownces]

Refer to #1376

[RichDom2185]

Refer to #1376

Thanks! Is there a way to lint this, though? I tried searching for eslint plugins but couldn't find anything that offers this level of customisation