feature request: FlatConfig support

[Leonardo-Vieira-Andela]

What

We want to start using eslint-import + eslint-import-resolver-typescript but there is no flatConfig support. It would be very beneficial for said support to be added.

Kind regards!

[JounQin]

https://github.com/un-ts/eslint-plugin-import-x#configuration-new-eslintconfigjs

https://github.com/import-js/eslint-plugin-import#config---flat-eslintconfigjs

Not sure what's your meaning.

[SukkaW]

If you want to import eslint-import-resolver-typescript directly in your eslint.config.js without using a path or string, plz check this proposal out: un-ts/eslint-plugin-import-x#40 (comment)

I am going to implement that this weekend.

[dbudwin]

This would be super helpful to have an example of how to use this package with the newer ESLint flat config (i.e. how do I use this package in an eslint.config.js file)

@JounQin The links you have reference the sister package of this one eslint-plugin-import. I've been able to use their flat config example. But I would like to see a flat config example for eslint-import-resolver-typescript too.

[SukkaW]

This would be super helpful to have an example of how to use this package with the newer ESLint flat config (i.e. how do I use this package in an eslint.config.js file)

For eslint-plugin-import-x, the proposed usage would be:

// eslint.config.js
import { createImportXTypeScriptResolver } from 'eslint-import-typescript-resolver';

// ...
settings: {
  'import-x/resolvers-next': [
     createImportXTypeScriptResolver(options)
  ]
}
/// ...

Note that this is still the proposal but we will be implementing this soon.

[melroy89]

https://github.com/import-js/eslint-plugin-import#config---flat-eslintconfigjs

Yes I want something like import importPlugin from 'eslint-import-resolver-typescript'; .. and then use it: importPlugin.flatConfigs.recommended or something within my eslint.config.mjs file.

[ljharb]

@melroy89 if you want the import plugin you'd need to import eslint-plugin-import; the resolver isn't same as the plugin.

[melroy89]

@melroy89 if you want the import plugin you'd need to import eslint-plugin-import; the resolver isn't same as the plugin.

Thanks for you response! I see, I'm using my typescript project with moduleResolution set to nodenext: "moduleResolution": "NodeNext", and I use ES6 modules "module": "NodeNext". Which works all great. But using eslint-plugin-import will result in that it can't find the imports.

Meaning the plugin has difficulties finding the ./somemodule.js file (since well in TypeScript that JS file is indeed not there yet). eslint-plugin-import will fail to find it and unable to deal with this module resolution, hence I was thinking I needed this resolver-typescript plugin would help me out, I believe you mentioned that somewhere in an issue ticket at the eslint-plugin-import repository.

ps. I'm also using SWC during fast development (and tsc for production builds).

[SukkaW]

@melroy89 You can vote up my proposal at un-ts/eslint-plugin-import-x#40 (comment) which will resolve your issue. You will be able to use eslint-import-resolver-typescript w/ eslint-plugin-import-x like this: #318 (comment)

[mcshaman]

The problem I have found ,as somebody who is not familiar with ESLint configs, is trying to wrap my head around two types of config at the same time because various plugins support, promote and document in different ways.

I am setting up an ESLint config from scratch using the init tool, so I presented with the new flat file format (which took a tone of reading to work out what the difference is). I need it to support my TS aliases so thats why I'm looking at slint-import-resolver-typescript.

I too, like the OP, thought it needed an exported flat config module because that how all the other plugins I have implemented so far work. Digging deeper and based on @ljharb comment I assume it needs to be added to a config object though I'm not sure how. It would be helpful, at the very least, if there was an example in the readme of implementing this plugin for flat config.

This is what I have so far but it doesn't seem to be working:

import pluginImportX from "eslint-plugin-import-x";

export default [
	{
		...pluginImportX.flatConfigs.recommended,
		settings: {
			"import-x/parsers": {
				"@typescript-eslint/parser": [".ts", ".tsx"],
			},
			"import-x/resolver": {
				typescript: {
					alwaysTryTypes: true,
				},
			},
		},
	},
]

So I am trying to extend the import-x flat config and add the eslint-import-resolver-typescript config from the readme. But yeah... Doesn't work and I don't know why or if I'm doing it right/wrong. Do I need to import eslint-import-resolver-typescript?

[SukkaW]

The flat config support for custom resolvers is implemented here at eslint-plugin-import-x: un-ts/eslint-plugin-import-x#192

This allows you to use require/import or any js objects as the import resolver. The new resolver design of eslint-plugin-import-x will also allow the creation of a reusable resolver instance across many resolve function invocations to improve performance.

The eslint-import-resolver-typescript will also adopt the new resolver design ASAP!

[devuxer]

https://github.com/un-ts/eslint-plugin-import-x#configuration-new-eslintconfigjs

https://github.com/import-js/eslint-plugin-import#config---flat-eslintconfigjs

Not sure what's your meaning.

@JounQin,

The documentation for this project (eslint-import-resolver-typescript) says:

Configuration: Add the following to your .eslintrc config:

The problem is that .eslintrc is deprecated. The new way is to use eslint.config.mjs. How do we configure eslint-plugin-import with the typescript resolver to work with the new flat eslint.config files?

Most people using TypeScript and ESLint will want to use the new typescript-eslint config, so examples for all of this together would be especially helpful.