fix - Config types don't satisfy FlatConfig.Config (#2752)

* fix - Config types don't satisfy `FlatConfig.Config`

* fix - Config types don't satisfy `FlatConfig.Config`

* ignore type errors for now

Author: dimaMachina

.changeset/fast-fishes-shake.md

@@ -2,4 +2,6 @@
 '@graphql-eslint/eslint-plugin': patch
 ---
 
-fix reporting lint issues not on first char of file for `.vue` and support ESLint fixes and suggestions for them. Use [new official example](https://github.com/dimaMachina/graphql-eslint/blob/master/examples/vue-code-file/eslint.config.js)
+fix reporting lint issues not on first char of file for `.vue` and support ESLint fixes and
+suggestions for them. Use
+[new official example](https://github.com/dimaMachina/graphql-eslint/blob/master/examples/vue-code-file/eslint.config.js)

.changeset/popular-ads-help.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix - Config types don't satisfy `FlatConfig.Config`

examples/multiple-projects-graphql-config/graphql.config.ts

@@ -1,5 +1,4 @@
-import type { IGraphQLConfig } from 'graphql-config';
-import type { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
+import type { IGraphQLConfig, GraphQLTagPluckOptions } from '@graphql-eslint/eslint-plugin';
 
 const config: IGraphQLConfig = {
   projects: {

packages/plugin/src/configs/index.ts

@@ -1,13 +1,9 @@
+import type { Linter } from 'eslint';
 import { ConfigName } from '../types.js';
-// @ts-expect-error -- complains about no default export
 import operationsAllConfig from './operations-all.js';
-// @ts-expect-error -- complains about no default export
 import operationsRecommendedConfig from './operations-recommended.js';
-// @ts-expect-error -- complains about no default export
 import schemaAllConfig from './schema-all.js';
-// @ts-expect-error -- complains about no default export
 import schemaRecommendedConfig from './schema-recommended.js';
-// @ts-expect-error -- complains about no default export
 import relayConfig from './schema-relay.js';
 
 export const configs = {
@@ -37,4 +33,4 @@ export const configs = {
       ...operationsAllConfig.rules,
     },
   },
-} satisfies Record<ConfigName | `flat/${ConfigName}`, unknown>;
+} satisfies Record<ConfigName, Linter.LegacyConfig> & Record<`flat/${ConfigName}`, Linter.Config>;

packages/plugin/src/configs/operations-all.ts

@@ -1,9 +1,10 @@
 /*
- * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
+ * 🚨 IMPORTANT! Do not manually modify this file. Run: `pnpm generate:configs`
  */
 
-// @ts-expect-error -- for cjs
-export = {
+import type { Linter } from 'eslint';
+
+export default {
   extends: './configs/operations-recommended',
   rules: {
     '@graphql-eslint/alphabetize': [
@@ -29,4 +30,4 @@ export = {
     '@graphql-eslint/no-one-place-fragments': 'error',
     '@graphql-eslint/require-import-fragment': 'error',
   },
-};
+} satisfies Linter.LegacyConfig;

packages/plugin/src/configs/operations-recommended.ts

@@ -1,9 +1,10 @@
 /*
- * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
+ * 🚨 IMPORTANT! Do not manually modify this file. Run: `pnpm generate:configs`
  */
 
-// @ts-expect-error -- for cjs
-export = {
+import type { Linter } from 'eslint';
+
+export default {
   parser: '@graphql-eslint/eslint-plugin',
   plugins: ['@graphql-eslint'],
   rules: {
@@ -55,4 +56,4 @@ export = {
     '@graphql-eslint/variables-are-input-types': 'error',
     '@graphql-eslint/variables-in-allowed-position': 'error',
   },
-};
+} satisfies Linter.LegacyConfig;

packages/plugin/src/configs/schema-all.ts

@@ -1,9 +1,10 @@
 /*
- * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
+ * 🚨 IMPORTANT! Do not manually modify this file. Run: `pnpm generate:configs`
  */
 
-// @ts-expect-error -- for cjs
-export = {
+import type { Linter } from 'eslint';
+
+export default {
   extends: './configs/schema-recommended',
   rules: {
     '@graphql-eslint/alphabetize': [
@@ -25,4 +26,4 @@ export = {
     '@graphql-eslint/require-nullable-result-in-root': 'error',
     '@graphql-eslint/require-type-pattern-with-oneof': 'error',
   },
-};
+} satisfies Linter.LegacyConfig;

packages/plugin/src/configs/schema-recommended.ts

@@ -1,9 +1,10 @@
 /*
- * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
+ * 🚨 IMPORTANT! Do not manually modify this file. Run: `pnpm generate:configs`
  */
 
-// @ts-expect-error -- for cjs
-export = {
+import type { Linter } from 'eslint';
+
+export default {
   parser: '@graphql-eslint/eslint-plugin',
   plugins: ['@graphql-eslint'],
   rules: {
@@ -69,4 +70,4 @@ export = {
     '@graphql-eslint/unique-operation-types': 'error',
     '@graphql-eslint/unique-type-names': 'error',
   },
-};
+} satisfies Linter.LegacyConfig;

packages/plugin/src/configs/schema-relay.ts

@@ -1,5 +1,6 @@
-// @ts-expect-error -- for cjs
-export = {
+import type { Linter } from 'eslint';
+
+export default {
   parser: '@graphql-eslint/eslint-plugin',
   plugins: ['@graphql-eslint'],
   rules: {
@@ -8,4 +9,4 @@ export = {
     '@graphql-eslint/relay-edge-types': 'error',
     '@graphql-eslint/relay-page-info': 'error',
   },
-};
+} satisfies Linter.LegacyConfig;

packages/plugin/src/index.ts

@@ -4,6 +4,9 @@ import { processor } from './processor.js';
 import { rules } from './rules/index.js';
 
 export * from './types.js';
+export type { IGraphQLConfig } from 'graphql-config';
+export type { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
+
 export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils.js';
 
 export const processors = { graphql: processor };