new docs (#2500)

* add new docs * more * more * add * more * more * more * more * more * fix generate docs prettier, incorrectly formatted _meta.ts * add baseUrl * update eslint patch * fix snapshots * fix lint
graphql-hive · Nov 13, 2024 · bfefad4 · bfefad4
1 parent 34b722a
commit bfefad4
Show file tree

Hide file tree

Showing 35 changed files with 1,486 additions and 354 deletions.
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 graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     files: ['**/*.js'],
-    processor: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     rules: {
       ...js.configs.recommended.rules,
       'no-console': 'error',
@@ -13,10 +13,12 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',

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 graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
@@ -9,10 +9,12 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',

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 graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin 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: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     languageOptions: {
       parserOptions: {
         ecmaFeatures: {
@@ -24,20 +24,22 @@ export default [
     // Setup GraphQL Parser
     files: ['**/*.{graphql,gql}'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
   },
   {
     // Setup recommended config for schema files
     files: [SCHEMA_PATH],
-    rules: graphql.configs['flat/schema-recommended'],
+    rules: graphqlPlugin.configs['flat/schema-recommended'].rules,
   },
   {
     // Setup recommended config for operations files
     files: ['client/**/*.{graphql,gql}'],
-    rules: graphql.configs['flat/operations-recommended'],
+    rules: graphqlPlugin.configs['flat/operations-recommended'].rules,
   },
 ];
diff --git a/examples/multiple-projects-graphql-config/eslint.config.js b/examples/multiple-projects-graphql-config/eslint.config.js
@@ -1,31 +1,33 @@
 import js from '@eslint/js';
-import * as graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     files: ['**/*.js'],
-    processor: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     rules: js.configs.recommended.rules,
   },
   {
     // Setup GraphQL Parser
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
   },
   {
     files: ['schema.*.graphql'],
     rules: {
-      ...graphql.configs['flat/schema-recommended'],
+      ...graphqlPlugin.configs['flat/schema-recommended'].rules,
       '@graphql-eslint/require-description': 'off',
     },
   },
   {
     files: ['**/*.js/*.graphql'],
-    rules: graphql.configs['flat/operations-recommended'],
+    rules: graphqlPlugin.configs['flat/operations-recommended'].rules,
   },
 ];
diff --git a/examples/prettier/eslint.config.js b/examples/prettier/eslint.config.js
@@ -1,7 +1,7 @@
 import prettierConfig from 'eslint-config-prettier';
 import prettierPlugin from 'eslint-plugin-prettier';
 import js from '@eslint/js';
-import * as graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
@@ -11,7 +11,7 @@ export default [
   },
   {
     files: ['**/*.js'],
-    processor: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     rules: {
       ...js.configs.recommended.rules,
       ...prettierConfig.rules,
@@ -21,10 +21,12 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       'prettier/prettier': 'error',

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 graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
@@ -9,7 +9,7 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
       parserOptions: {
         graphQLConfig: {
           schema: 'schema.graphql',
@@ -18,7 +18,9 @@ export default [
       },
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       '@graphql-eslint/require-selections': ['error', { fieldName: '_id' }],

diff --git a/examples/svelte-code-file/eslint.config.js b/examples/svelte-code-file/eslint.config.js
@@ -1,11 +1,11 @@
 import svelteParser from 'svelte-eslint-parser';
 import js from '@eslint/js';
-import * as graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     files: ['**/*.js', '**/*.svelte'],
-    processor: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     rules: js.configs.recommended.rules,
   },
   {
@@ -17,10 +17,12 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',

diff --git a/examples/vue-code-file/eslint.config.js b/examples/vue-code-file/eslint.config.js
@@ -1,11 +1,11 @@
 import vueParser from 'vue-eslint-parser';
 import js from '@eslint/js';
-import * as graphql from '@graphql-eslint/eslint-plugin';
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
 
 export default [
   {
     files: ['**/*.js', '**/*.vue'],
-    processor: graphql.processors.graphql,
+    processor: graphqlPlugin.processor,
     rules: js.configs.recommended.rules,
   },
   {
@@ -17,10 +17,12 @@ export default [
   {
     files: ['**/*.graphql'],
     languageOptions: {
-      parser: graphql.parser,
+      parser: graphqlPlugin.parser,
     },
     plugins: {
-      '@graphql-eslint': { rules: graphql.rules },
+      '@graphql-eslint': {
+        rules: graphqlPlugin.rules,
+      },
     },
     rules: {
       '@graphql-eslint/no-anonymous-operations': 'error',

diff --git a/package.json b/package.json
@@ -53,7 +53,7 @@
   },
   "pnpm": {
     "patchedDependencies": {
-      "eslint@9.9.0": "patches/eslint@8.46.0.patch",
+      "eslint": "patches/eslint.patch",
       "[email protected]": "patches/[email protected]"
     }
   }

diff --git a/packages/plugin/__tests__/__snapshots__/input-name.spec.md b/packages/plugin/__tests__/__snapshots__/input-name.spec.md
@@ -8,10 +8,7 @@ exports[`input-name > invalid > Invalid #1 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/2
@@ -41,10 +38,7 @@ exports[`input-name > invalid > Invalid #2 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error
@@ -65,10 +59,7 @@ exports[`input-name > invalid > Invalid #3 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error
@@ -89,10 +80,7 @@ exports[`input-name > invalid > Invalid #4 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/2
@@ -122,10 +110,7 @@ exports[`input-name > invalid > Invalid #5 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/2
@@ -155,10 +140,7 @@ exports[`input-name > invalid > Invalid #6 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/2
@@ -188,10 +170,7 @@ exports[`input-name > invalid > Invalid #7 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/2
@@ -221,10 +200,7 @@ exports[`input-name > invalid > Invalid #8 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": true
     }
 
 #### ❌ Error 1/4
@@ -272,10 +248,7 @@ exports[`input-name > invalid > Invalid #9 1`] = `
 #### ⚙️ Options
 
     {
-      "checkInputType": false,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "checkInputType": false
     }
 
 #### ❌ Error 1/2
@@ -306,9 +279,7 @@ exports[`input-name > invalid > Invalid #10 1`] = `
 
     {
       "checkInputType": true,
-      "caseSensitiveInputType": false,
-      "checkQueries": false,
-      "checkMutations": true
+      "caseSensitiveInputType": false
     }
 
 #### ❌ Error
@@ -330,9 +301,7 @@ exports[`input-name > invalid > Invalid #11 1`] = `
 
     {
       "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkQueries": false,
-      "checkMutations": true
+      "caseSensitiveInputType": true
     }
 
 #### ❌ Error
@@ -355,8 +324,7 @@ exports[`input-name > invalid > Invalid #12 1`] = `
     {
       "checkQueries": true,
       "checkInputType": true,
-      "caseSensitiveInputType": true,
-      "checkMutations": true
+      "caseSensitiveInputType": true
     }
 
 #### ❌ Error