Proposal: Provide a defineConfig function

[Shinigami92]

The version of ESLint you are using.
<= 7.22.0

The problem you want to solve.

When building up a .eslintrc.js I do not get provided inline help, autosuggestion, documentation or type-safety.
Also if a new major breaking change is introduced by eslint, I do not see directly if my config is still working or not by opening the file and trust the compiler.

Your take on the correct solution to problem.

Vite idea to the rescue 🚑

Provide a defineConfig function that can be require/import-ed in the configuration file. It is a bit like json-schema.

The defineConfig function itself does nothing at runtime, it's just

export function defineConfig(config: EslintConfig) {
  return config;
}

TypeScript Playground Example

Are you willing to submit a pull request to implement this change?

I think so, but someone needs to help me to find where and how I should add the functionality and TypeScript definitions.

Alternative approach

Provide a new package like eslint-define-config

[Shinigami92]

I already jumped ahead and published 😄

Repo: https://github.com/Shinigami92/eslint-define-config

Anyone who wants to help is welcome, I accept PRs now!

[nzakas]

It sounds like what you’re asking for is for ESLint to ship type definitions for config files?

We are in the middle of transitioning to a new config system (see #13481) so we aren’t making any further changes to the existing config system.

We also haven’t shipped type definitions for anything before, and I’m not sure that’s a direction we want to go in.

Given that you’ve already implemented a package that does what you want, it seems like using that package is the best option.