add meta object with name and version to parser and processor to be compatible with ESLint 9 (#2458)

dimaMachina · web-flow · commit 909645893d41 · 2024-08-01T00:45:43.000+02:00
* fix lint

* aa

* aa

* more

* more

* more

* more

* more

* more

* format

* fix examples test

* fix website

* fix

* aa

* try

* okk

* nowww
diff --git a/.changeset/lovely-laws-hide.md b/.changeset/lovely-laws-hide.md
@@ -0,0 +1,6 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+add `meta` object with `name` and `version` to `parser` and `processor` to be compatible with ESLint
+9
diff --git a/examples/code-file/eslint.config.js b/examples/code-file/eslint.config.js
@@ -1,10 +1,10 @@
 import js from '@eslint/js';
-import * as graphqlESLint from '@graphql-eslint/eslint-plugin';
+import * as graphql from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     files: ['**/*.js'],
-    processor: graphqlESLint.processors.graphql,
+    processor: graphql.processors.graphql,
     rules: {
       ...js.configs.recommended.rules,
       'no-console': 'error',
@@ -13,10 +13,10 @@ export default [
   {
     files: ['**/*.graphql'],
     plugins: {
-      '@graphql-eslint': graphqlESLint,
+      '@graphql-eslint': { rules: graphql.rules },
     },
     languageOptions: {
-      parser: graphqlESLint,
+      parser: graphql.parser,
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',
diff --git a/examples/code-file/package.json b/examples/code-file/package.json
@@ -6,7 +6,7 @@
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "private": true,
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/graphql-config/eslint.config.js b/examples/graphql-config/eslint.config.js
@@ -1,5 +1,5 @@
 import js from '@eslint/js';
-import * as graphqlESLint from '@graphql-eslint/eslint-plugin';
+import * as graphql from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
@@ -9,10 +9,10 @@ export default [
   {
     files: ['**/*.graphql'],
     plugins: {
-      '@graphql-eslint': graphqlESLint,
+      '@graphql-eslint': { rules: graphql.rules },
     },
     languageOptions: {
-      parser: graphqlESLint,
+      parser: graphql.parser,
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',
diff --git a/examples/graphql-config/package.json b/examples/graphql-config/package.json
@@ -6,7 +6,7 @@
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "private": true,
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/monorepo/eslint.config.js b/examples/monorepo/eslint.config.js
@@ -1,5 +1,5 @@
 import js from '@eslint/js';
-import * as graphqlESLint from '@graphql-eslint/eslint-plugin';
+import * as graphql from '@graphql-eslint/eslint-plugin';
 
 const SCHEMA_PATH = 'server/**/*.gql';
 
@@ -11,7 +11,7 @@ export default [
   {
     files: ['client/**/*.tsx'],
     // Setup processor for operations/fragments definitions on code-files
-    processor: graphqlESLint.processors.graphql,
+    processor: graphql.processors.graphql,
     languageOptions: {
       parserOptions: {
         sourceType: 'module',
@@ -25,20 +25,20 @@ export default [
     // Setup GraphQL Parser
     files: ['**/*.{graphql,gql}'],
     plugins: {
-      '@graphql-eslint': graphqlESLint,
+      '@graphql-eslint': { rules: graphql.rules },
     },
     languageOptions: {
-      parser: graphqlESLint,
+      parser: graphql.parser,
     },
   },
   {
     // Setup recommended config for schema files
     files: [SCHEMA_PATH],
-    ...graphqlESLint.flatConfigs['schema-recommended'],
+    ...graphql.flatConfigs['schema-recommended'],
   },
   {
     // Setup recommended config for operations files
     files: ['client/**/*.{graphql,gql}'],
-    ...graphqlESLint.flatConfigs['operations-recommended'],
+    ...graphql.flatConfigs['operations-recommended'],
   },
 ];
diff --git a/examples/monorepo/package.json b/examples/monorepo/package.json
@@ -5,7 +5,7 @@
   "author": "Dimitri POSTOLOV",
   "private": true,
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/multiple-projects-graphql-config/package.json b/examples/multiple-projects-graphql-config/package.json
@@ -4,7 +4,7 @@
   "author": "Dimitri POSTOLOV",
   "private": true,
   "scripts": {
-    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint ."
+    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/prettier/eslint.config.js b/examples/prettier/eslint.config.js
@@ -1,17 +1,17 @@
 import prettierConfig from 'eslint-config-prettier';
 import prettierPlugin from 'eslint-plugin-prettier';
 import js from '@eslint/js';
-import * as graphqlESLint from '@graphql-eslint/eslint-plugin';
+import * as graphql from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     plugins: {
-      prettier: prettierPlugin,
+      prettier: { rules: prettierPlugin.rules },
     },
   },
   {
     files: ['**/*.js'],
-    processor: graphqlESLint.processors.graphql,
+    processor: graphql.processors.graphql,
     rules: {
       ...js.configs.recommended.rules,
       ...prettierConfig.rules,
@@ -21,10 +21,10 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphqlESLint,
+      parser: graphql.parser,
     },
     plugins: {
-      '@graphql-eslint': graphqlESLint,
+      '@graphql-eslint': { rules: graphql.rules },
     },
     rules: {
       'prettier/prettier': 'error',
diff --git a/examples/prettier/package.json b/examples/prettier/package.json
@@ -6,7 +6,7 @@
   "author": "JounQin <admin@1stg.me>",
   "private": true,
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/programmatic/eslint.config.js b/examples/programmatic/eslint.config.js
@@ -1,5 +1,5 @@
 import js from '@eslint/js';
-import * as graphqlESLint from '@graphql-eslint/eslint-plugin';
+import * as graphql from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
@@ -9,10 +9,10 @@ export default [
   {
     files: ['**/*.graphql'],
     plugins: {
-      '@graphql-eslint': graphqlESLint,
+      '@graphql-eslint': { rules: graphql.rules },
     },
     languageOptions: {
-      parser: graphqlESLint,
+      parser: graphql.parser,
       parserOptions: {
         graphQLConfig: {
           schema: 'schema.graphql',
diff --git a/examples/programmatic/package.json b/examples/programmatic/package.json
@@ -6,7 +6,7 @@
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "private": true,
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/svelte-code-file/package.json b/examples/svelte-code-file/package.json
@@ -5,7 +5,7 @@
   "author": "Dimitri POSTOLOV",
   "private": true,
   "scripts": {
-    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint ."
+    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/examples/vue-code-file/package.json b/examples/vue-code-file/package.json
@@ -5,7 +5,7 @@
   "author": "Dimitri POSTOLOV",
   "private": true,
   "scripts": {
-    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint ."
+    "lint": "ESLINT_USE_FLAT_CONFIG=false eslint --cache ."
   },
   "dependencies": {
     "graphql": "16.9.0"
diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
     "@changesets/cli": "2.27.7",
     "@graphql-tools/utils": "10.3.2",
     "@theguild/eslint-config": "0.11.10",
-    "@theguild/prettier-config": "2.0.6",
+    "@theguild/prettier-config": "2.0.7",
     "@types/dedent": "0.7.2",
     "@types/node": "20.14.13",
     "bob-the-bundler": "7.0.1",
diff --git a/packages/plugin/__tests__/examples.spec.ts b/packages/plugin/__tests__/examples.spec.ts
@@ -19,7 +19,18 @@ ${results.map(result => result.messages.map(m => m.message)).join('\n\n')}
 
 function getESLintOutput(cwd: string): ESLint.LintResult[] {
   const { stdout, stderr } = spawnSync('eslint', ['.', '--format', 'json'], { cwd });
-  const errorOutput = stderr.toString();
+  const errorOutput = stderr
+    .toString()
+    .replace(
+      /\(node:\d{4,5}\) ExperimentalWarning: Importing JSON modules is an experimental feature and might change at any time/,
+      '',
+    )
+    .replace(
+      /\(node:\d{4}\) ExperimentalWarning: Import assertions are not a stable feature of the JavaScript language. Avoid relying on their current behavior and syntax as those might change in a future version of Node.js./,
+      '',
+    )
+    .replace('(Use `node --trace-warnings ...` to show where the warning was created)', '')
+    .trimEnd();
   if (errorOutput) {
     throw new Error(errorOutput);
   }
diff --git a/packages/plugin/__tests__/rules.spec.ts b/packages/plugin/__tests__/rules.spec.ts
@@ -1,5 +1,5 @@
 import { FlatESLint } from 'eslint/use-at-your-own-risk';
-import { configs, parseForESLint, rules } from '@graphql-eslint/eslint-plugin';
+import { configs, parser, rules } from '@graphql-eslint/eslint-plugin';
 import { ParserOptionsForTests } from './test-utils.js';
 
 export function getESLintWithConfig(
@@ -12,7 +12,7 @@ export function getESLintWithConfig(
       {
         files: ['*.graphql'],
         languageOptions: {
-          parser: { parseForESLint },
+          parser,
           parserOptions: {
             graphQLConfig: {
               schema: 'type Query { foo: Int }',
diff --git a/packages/plugin/src/flat-configs.ts b/packages/plugin/src/flat-configs.ts
@@ -1,10 +1,8 @@
 import { configs } from './configs/index.js';
-import { parseForESLint } from './parser.js';
+import { parser } from './parser.js';
 import { ConfigName } from './types.js';
 
-const languageOptions = {
-  parser: { parseForESLint },
-};
+const languageOptions = { parser };
 
 export const flatConfigs = {
   'operations-all': {
diff --git a/packages/plugin/src/index.browser.ts b/packages/plugin/src/index.browser.ts
@@ -1,8 +1,6 @@
 // rewrite exports because we don't need `processors` export that has fs related dependencies
 
-export { parseForESLint } from './parser.js';
+export { parser } from './parser.js';
 export { rules } from './rules/index.js';
 export * from './types.js';
-export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils.js';
-export { configs } from './configs/index.js';
 export { flatConfigs } from './flat-configs.js';
diff --git a/packages/plugin/src/index.ts b/packages/plugin/src/index.ts
@@ -1,6 +1,6 @@
 import { processor } from './processor.js';
 
-export { parseForESLint } from './parser.js';
+export { parser, parseForESLint } from './parser.js';
 export { rules } from './rules/index.js';
 export * from './types.js';
 export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils.js';
diff --git a/packages/plugin/src/meta.ts b/packages/plugin/src/meta.ts
@@ -0,0 +1,3 @@
+import packageJson from '../package.json' assert { type: 'json' };
+
+export const { name, version } = packageJson;
diff --git a/packages/plugin/src/parser.ts b/packages/plugin/src/parser.ts
@@ -5,6 +5,7 @@ import { parseGraphQLSDL, Source } from '@graphql-tools/utils';
 import { getDocuments } from './documents.js';
 import { convertToESTree, extractComments, extractTokens } from './estree-converter/index.js';
 import { loadGraphQLConfig } from './graphql-config.js';
+import { version } from './meta.js';
 import { getSchema } from './schema.js';
 import { getSiblings } from './siblings.js';
 import { GraphQLESLintParseResult, ParserOptions, Schema } from './types.js';
@@ -110,3 +111,11 @@ export function parseForESLint(code: string, options: ParserOptions): GraphQLESL
     throw error;
   }
 }
+
+export const parser = {
+  parseForESLint,
+  meta: {
+    name: '@graphql-eslint/parser',
+    version,
+  },
+};
diff --git a/packages/plugin/src/processor.ts b/packages/plugin/src/processor.ts
@@ -7,6 +7,7 @@ import {
 } from '@graphql-tools/graphql-tag-pluck';
 import { asArray } from '@graphql-tools/utils';
 import { loadOnDiskGraphQLConfig } from './graphql-config.js';
+import { version } from './meta.js';
 import { CWD, REPORT_ON_FIRST_CHARACTER, truthy } from './utils.js';
 
 export type Block = Linter.ProcessorFile & {
@@ -22,6 +23,10 @@ let onDiskConfigLoaded = false;
 const RELEVANT_KEYWORDS = ['gql', 'graphql', 'GraphQL'] as const;
 
 export const processor = {
+  meta: {
+    name: '@graphql-eslint/processor',
+    version,
+  },
   supportsAutofix: true,
   preprocess(code, filePath) {
     if (!onDiskConfigLoaded) {
diff --git a/packages/plugin/tsconfig.json b/packages/plugin/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "es2022",
-    "module": "Node16",
+    "module": "nodenext",
     "moduleResolution": "node16",
     "declaration": false,
     "noEmit": true,
diff --git a/packages/plugin/tsup.config.ts b/packages/plugin/tsup.config.ts
@@ -24,6 +24,7 @@ export default defineConfig([
   {
     ...opts,
     outDir: 'dist/esm',
+    target: 'esnext',
   },
   {
     ...opts,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/next.config.js b/website/next.config.js
diff --git a/website/src/components/graphql-editor.tsx b/website/src/components/graphql-editor.tsx
diff --git a/website/src/components/play-page.tsx b/website/src/components/play-page.tsx

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': patch
 +---
++
 +add `meta` object with `name` and `version` to `parser` and `processor` to be compatible with ESLint
 +9