[v4] Remove GraphQLRuleTester from bundle (#1792)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.changeset/@graphql-eslint_eslint-plugin-1792-dependencies.md

@@ -0,0 +1,9 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+dependencies updates:
+
+- Removed dependency
+  [`@babel/code-frame@^7.18.6` ↗︎](https://www.npmjs.com/package/@babel/code-frame/v/7.18.6) (from
+  `dependencies`)

.changeset/strong-needles-compare.md

@@ -0,0 +1,15 @@
+---
+'@graphql-eslint/eslint-plugin': major
+---
+
+Remove `GraphQLRuleTester` from bundle, to test your rules use regular `RuleTester` from eslint
+
+> **Note**: with this change unnecessary dependency `@babel/code-frame` was removed too
+
+```js
+import { RuleTester } from 'eslint'
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('@graphql-eslint/eslint-plugin')
+})
+```

.github/workflows/pr.yaml

@@ -1,8 +1,7 @@
 name: pr
 on:
   pull_request:
-    branches:
-      - master
+    branches: [master]
 
 jobs:
   dependencies:

.github/workflows/release.yml

@@ -1,8 +1,7 @@
 name: release
 on:
   push:
-    branches:
-      - master
+    branches: [master]
 
 jobs:
   stable:

.github/workflows/tests.yml

@@ -2,9 +2,9 @@ name: test
 
 on:
   push:
-    branches: [master]
+    branches: [master, v4]
   pull_request:
-    branches: [master]
+    branches: [master, v4]
 
 jobs:
   lint:
@@ -44,12 +44,6 @@ jobs:
       - name: Build
         run: pnpm build
 
-      - name: Upload Build Artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: build-artifact
-          path: packages/plugin/dist
-
   test:
     name: Node.js v${{matrix.node_version}} / GraphQL v${{matrix.graphql_version}} / ESLint v8
     timeout-minutes: 60
@@ -78,14 +72,6 @@ jobs:
       - name: Install Dependencies
         run: pnpm i --no-frozen-lockfile
 
-      # We need build for examples.spec.ts test
-      # Otherwise we'll get error - Cannot find module 'node_modules/@graphql-eslint/eslint-plugin/dist/index.js'
-      - name: Download Build Artifact
-        uses: actions/download-artifact@v3
-        with:
-          name: build-artifact
-          path: packages/plugin/dist
-
       - name: Test
         run: pnpm test
         env:

.github/workflows/website-integrity.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Fetch
         run: git fetch origin master
 
-      - name: Setup env
+      - name: Setup ENV
         uses: the-guild-org/shared-config/setup@main
         with:
           nodeVersion: 18
@@ -28,15 +28,15 @@ jobs:
       - name: Compare
         run: git diff origin/${{ github.base_ref }}.. -- website/route-lockfile.txt
 
-      - name: Diff to file
+      - name: Diff to File
         if: always()
         id: diff_result
         run: |
           echo "result<<EOF" >> $GITHUB_OUTPUT
           echo "$(git diff origin/${{ github.base_ref }}.. -- website/route-lockfile.txt)" >> $GITHUB_OUTPUT
           echo EOF >> $GITHUB_OUTPUT
 
-      - name: Publish a message
+      - name: Publish a Message
         if: always() && contains(steps.diff_result.outputs.result, 'diff')
         uses: marocchino/sticky-pull-request-comment@v2
         with:

.github/workflows/website.yml

@@ -2,11 +2,9 @@ name: website
 
 on:
   push:
-    branches:
-      - master
+    branches: [master, v4]
   pull_request:
-    branches:
-      - master
+    branches: [master, v4]
 
 jobs:
   deployment:

examples/basic/package.json

@@ -14,6 +14,6 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0"
+    "eslint": "8.46.0"
   }
 }

examples/code-file/package.json

@@ -14,6 +14,6 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0"
+    "eslint": "8.46.0"
   }
 }

examples/graphql-config-code-file/package.json

@@ -15,6 +15,6 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0"
+    "eslint": "8.46.0"
   }
 }

examples/graphql-config/package.json

@@ -14,6 +14,6 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0"
+    "eslint": "8.46.0"
   }
 }

examples/monorepo/package.json

@@ -13,6 +13,6 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0"
+    "eslint": "8.46.0"
   }
 }

examples/multiple-projects-graphql-config/package.json

@@ -12,7 +12,7 @@
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "workspace:*",
     "cosmiconfig-typescript-loader": "5.0.0",
-    "eslint": "8.38.0",
+    "eslint": "8.46.0",
     "ts-node": "10.9.1",
     "typescript": "5.1.6"
   }

examples/prettier/package.json

@@ -14,7 +14,7 @@
   "devDependencies": {
     "@eslint/js": "8.46.0",
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0",
+    "eslint": "8.46.0",
     "eslint-config-prettier": "8.9.0",
     "eslint-plugin-prettier": "4.2.1",
     "prettier": "2.8.8"

examples/svelte-code-file/package.json

@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "workspace:*",
-    "eslint": "8.38.0",
+    "eslint": "8.46.0",
     "svelte": "4.1.2",
     "svelte-eslint-parser": "0.32.2",
     "svelte2tsx": "0.6.19"

examples/vue-code-file/package.json

@@ -13,7 +13,7 @@
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "workspace:*",
     "@vue/compiler-sfc": "3.3.4",
-    "eslint": "8.38.0",
+    "eslint": "8.46.0",
     "vue-eslint-parser": "9.3.1"
   }
 }

package.json

@@ -10,7 +10,7 @@
     "pnpm": ">=8"
   },
   "scripts": {
-    "build": "pnpm --filter @graphql-eslint/eslint-plugin build && bob check",
+    "build": "turbo run build --filter=!website && bob check",
     "ci:lint": "eslint --ignore-path .gitignore --output-file eslint_report.json --format json .",
     "create-rule": "tsx scripts/create-rule.ts",
     "generate:configs": "tsx scripts/generate-configs.ts",
@@ -21,7 +21,7 @@
     "prerelease": "NODE_ENV=production pnpm build",
     "prettier": "pnpm lint:prettier --write",
     "release": "changeset publish",
-    "test": "vitest ."
+    "test": "turbo run test --filter=!website"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.4.8",
@@ -35,7 +35,7 @@
     "chalk": "4.1.2",
     "dedent": "1.5.1",
     "enquirer": "2.4.1",
-    "eslint": "8.44.0",
+    "eslint": "8.46.0",
     "eslint-plugin-eslint-plugin": "5.0.7",
     "eslint-plugin-tailwindcss": "3.13.0",
     "husky": "8.0.3",
@@ -46,6 +46,7 @@
     "rimraf": "5.0.1",
     "tsup": "^7.1.0",
     "tsx": "3.12.7",
+    "turbo": "^1.10.12",
     "typescript": "5.1.6",
     "vitest": "0.30.1"
   },
@@ -54,7 +55,7 @@
   },
   "pnpm": {
     "patchedDependencies": {
-      "eslint@8.44.0": "patches/eslint@8.31.0.patch",
+      "eslint@8.46.0": "patches/eslint@8.46.0.patch",
       "[email protected]": "patches/[email protected]",
       "[email protected]": "patches/[email protected]",
       "@vitest/[email protected]": "patches/@[email protected]"

packages/plugin/package.json

@@ -35,13 +35,13 @@
     "graphql"
   ],
   "scripts": {
-    "build": "tsup"
+    "build": "tsup",
+    "test": "vitest"
   },
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@babel/code-frame": "^7.18.6",
     "@graphql-tools/code-file-loader": "^7.3.6",
     "@graphql-tools/graphql-tag-pluck": "^7.3.6",
     "@graphql-tools/utils": "^9.0.0",
@@ -54,7 +54,7 @@
     "tslib": "^2.4.1"
   },
   "devDependencies": {
-    "@types/babel__code-frame": "7.0.3",
+    "@theguild/eslint-rule-tester": "workspace:*",
     "@types/debug": "4.1.8",
     "@types/eslint": "8.37.0",
     "@types/estree": "1.0.1",

packages/plugin/src/index.ts

@@ -2,7 +2,6 @@ import { processor } from './processor.js';
 
 export { parseForESLint } from './parser.js';
 export { rules } from './rules/index.js';
-export * from './testkit.js';
 export * from './types.js';
 export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils.js';
 

packages/plugin/src/rules/alphabetize.ts

@@ -21,8 +21,7 @@ import {
 import { FromSchema } from 'json-schema-to-ts';
 import lowerCase from 'lodash.lowercase';
 import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRuleListener } from '../testkit.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../types.js';
 import { ARRAY_DEFAULT_OPTIONS, displayNodeName, truthy } from '../utils.js';
 
 const RULE_ID = 'alphabetize';

packages/plugin/src/rules/input-name.ts

@@ -10,8 +10,7 @@ import {
 } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
 import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRuleListener } from '../testkit.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../types.js';
 
 const schema = {
   type: 'array',

packages/plugin/src/rules/naming-convention.ts

@@ -1,8 +1,7 @@
 import { ASTKindToNode, Kind, NameNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
 import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRuleListener } from '../testkit.js';
-import { GraphQLESLintRule, ValueOf } from '../types.js';
+import { GraphQLESLintRule, ValueOf, GraphQLESLintRuleListener } from '../types.js';
 import {
   ARRAY_DEFAULT_OPTIONS,
   convertCase,

packages/plugin/src/rules/relay-edge-types.ts

@@ -12,8 +12,7 @@ import {
 } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
 import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRuleListener } from '../testkit.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../types.js';
 import { getTypeName, requireGraphQLSchemaFromContext } from '../utils.js';
 
 const RULE_ID = 'relay-edge-types';