Skip to content

Document and use defineConfig() helper in examples #276

@MikeMcC399

Description

@MikeMcC399

What would you like?

Migrate configurations, used in CI and documentation, to use the helper functions:

  • defineConfig()
  • globalIgnores()

Why is this needed?

The ESLint Configuration Files documentation and the ESLint README now include the use of the helper function defineConfig() as standard configuration suggestions. It may be confusing if the eslint-plugin-cypress continues to shows older example configurations, even if they still work.

The ESLint 9.22.0 release, from Mar 7, 2025, introduced the defineConfig() and globalIgnores() helpers for configuration files. The blog article Evolving flat config with extends provides background information, including a discussion on the reintroduction of extends in configurations.

Other

According to Evolving flat config with extends, current ESLint versions >=9.22.0 can import from eslint/config, whilst backwards compatibility with older versions is provided by adding and importing from the npm @eslint/config-helpers package.

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions