Move import/order rule into shared eslint configuration

[nickpdemarco]

Fixes #4953. See issue description for more information.

[netlify]

✅ Deploy Preview for redwoodjs-docs canceled.

Name	Link
🔨 Latest commit	2ab6499
🔍 Latest deploy log	https://app.netlify.com/sites/redwoodjs-docs/deploys/62a17d65a3a52f0008e980d9

[thedavidprice]

@dac09 any chance you could take a look at this one? Easy patch if we get it in, just let me know.

[dac09]

Hey @nickpdemarco - thank you for this. I despise lint configuration, so grateful you are taking an interest in this!

So I think... what's actually happening is that this eslint configuration sits only in the framework and not in a users project - maybe this was by design - but I don't actually remember or know

I wonder if having such strict rules (erroring out for import order) is a good idea on a user's project? May be a little too opinionated?

Let me know what you think.

[nickpdemarco]

I hear you on the aggressiveness of erroring out. Personally, I’m more interested in this so I can modify App.js imports (see #4900) and then lint —fix it, so I know my changes are still RW compliant.

More generally, I do think sane import ordering is enough of a “best practice” to justify its enforcement in Redwood. As a relatively green web developer, I’d rather know someone wiser than me thought about import order and automatically enforced it, rather than having to rediscover that standard myself.

You can always disable or extend eslint, but I’d venture to guess most people using RW will welcome the constraint, so long as their editor automatically fixes it on save.

[jtoar]

I'd love to see this working out of the box as well. @dac09 as you said, erroring out may be too harsh. I'll queue it up for the next core team meeting to get everyone's thoughts.

[thedavidprice]

@jtoar and I discussed this one — error would result in a breaking change and need to coincide with a major version.

Next steps:

• use warn
• indicate (via @deprecation — I don't think it's possible?) we'll be moving to error in the next major version
• add to "upcoming breaking changes" in CHANGELOG

[jtoar]

Updated next steps to what @thedavidprice said: we won't be merging this till the next major. Having said that, we could still merge this into the next major branch, so that we could get that RC process going. We'll include guidance for how to lint files so that your commit history isn't littered with changes. Thanks @nickpdemarco!

[dac09]

@jtoar, @nickpdemarco - there's an error now introduced by this new lint order, where in my functions/graphql.ts it won't keen the glob imports together e.g.

It thinks this is the correct order:

import directives from 'src/directives/**/*.{js,ts}'
import sdls from 'src/graphql/**/*.sdl.{js,ts}'
import { getCurrentUser } from 'src/lib/auth'
import { db } from 'src/lib/db'
import { logger } from 'src/lib/logger'
import services from 'src/services/**/*.{js,ts}'

[jtoar]

@dac09 yeah that's how it's configured. Here's the create-redwood-app template:

redwood/packages/create-redwood-app/template/api/src/functions/graphql.ts

Lines 1 to 7 in 0e7bb63

	import { createGraphQLHandler } from '@redwoodjs/graphql-server'
	import directives from 'src/directives/**/*.{js,ts}'
	import sdls from 'src/graphql/**/*.sdl.{js,ts}'
	import { db } from 'src/lib/db'
	import { logger } from 'src/lib/logger'
	import services from 'src/services/**/*.{js,ts}'

We discussed this one as a team a few times. I'm down to make a change to the rule to keep the globs together, but that would be breaking of course. Not a big deal though; we can just make the change when the next major rolls around, and we already have release notes for it from the last one we can just copy and paste.

[dac09]

I find these lint rules a little too agressive - it makes no sense that I can't group globs together. It makes it harder for new comers to reason about the special glob import syntax too.

[jtoar]

@dac09 I agree that it makes more sense to keep the globs together, and am happy to change it, as I said in my last comment.

If there's other changes you'd like to make to it, let's get them in at the same time too.