add new rules to recommended configs, rename relay config to `schem…

…a-relay` (#1794)

* add

* more

* more

* more

* more

* rename

* rename

* fix tests

.changeset/dull-scissors-destroy.md

@@ -0,0 +1,17 @@
+---
+'@graphql-eslint/eslint-plugin': major
+---
+
+- bring back `possible-type-extension` rule to `schema-recommended` config
+
+- add `unique-operation-name` and `unique-fragment-name` rules to `operations-recommended` config
+
+The concept of sibling operations provided by graphql-config's `documents` fields is based on
+uniquely named operations and fragments, for omitting false-positive/negative cases when operations
+and fragments are located in separate files. For this reason, these rules must be included in the
+recommended config
+
+- rename `relay` config to `schema-relay`
+
+> To avoid confusing when users extend this config for executable definitions (operations and
+> fragments)

.eslintrc.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  ignorePatterns: ['examples', 'packages/plugin/tests/__snapshots__'],
+  ignorePatterns: ['examples', 'packages/plugin/__tests__/__snapshots__'],
   extends: [
     '@theguild',
     '@theguild/eslint-config/json',
@@ -55,7 +55,7 @@ module.exports = {
       },
     },
     {
-      files: ['**/tests/mocks/**/*.{ts,js}'],
+      files: ['**/__tests__/mocks/**/*.{ts,js}'],
       rules: {
         '@typescript-eslint/no-unused-vars': 'off',
       },

.prettierignore

@@ -1,5 +1,5 @@
 dist/
-packages/plugin/tests/__snapshots__/
+packages/plugin/__tests__/__snapshots__/
 examples/prettier/invalid.graphql
 examples/prettier/invalid.js
 pnpm-lock.yaml

packages/plugin/tests/rules.spec.ts → packages/plugin/__tests__/rules.spec.ts

@@ -44,7 +44,7 @@ describe('Rules', () => {
   });
 
   it('should load all rules properly from `relay` config', async () => {
-    const eslint = getESLintWithConfig(configs.relay, { documents: '{ foo }' });
+    const eslint = getESLintWithConfig(configs['schema-relay'], { documents: '{ foo }' });
     const results = await eslint.lintText('{ foo }', { filePath: 'foo.graphql' });
     expect(results).toHaveLength(1);
   });

packages/plugin/package.json

@@ -9,7 +9,6 @@
     "node": ">=18"
   },
   "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -27,7 +26,6 @@
       }
     }
   },
-  "typings": "dist/esm/index.d.mts",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -39,6 +37,7 @@
     "test": "vitest"
   },
   "peerDependencies": {
+    "eslint": "^8",
     "graphql": "^16"
   },
   "dependencies": {
@@ -68,8 +67,5 @@
     "directory": "dist",
     "access": "public"
   },
-  "sideEffects": false,
-  "typescript": {
-    "definition": "dist/cjs/index.d.ts"
-  }
+  "sideEffects": false
 }

packages/plugin/src/configs/index.ts

@@ -1,13 +1,14 @@
 import operationsAllConfig from './operations-all.js';
 import operationsRecommendedConfig from './operations-recommended.js';
-import relayConfig from './relay.js';
 import schemaAllConfig from './schema-all.js';
 import schemaRecommendedConfig from './schema-recommended.js';
+import relayConfig from './schema-relay.js';
+import { ConfigName } from '../types.js';
 
 export const configs = {
   'schema-recommended': schemaRecommendedConfig,
   'schema-all': schemaAllConfig,
+  'schema-relay': relayConfig,
   'operations-recommended': operationsRecommendedConfig,
   'operations-all': operationsAllConfig,
-  relay: relayConfig,
-};
+} satisfies Record<ConfigName, unknown>;

packages/plugin/src/flat-configs.ts

@@ -1,5 +1,6 @@
 import { configs } from './configs/index.js';
 import { parseForESLint } from './parser.js';
+import { ConfigName } from './types.js';
 
 const languageOptions = {
   parser: { parseForESLint },
@@ -17,9 +18,9 @@ export const flatConfigs = {
     languageOptions,
     rules: configs['operations-recommended'].rules,
   },
-  relay: {
+  'schema-relay': {
     languageOptions,
-    rules: configs.relay.rules,
+    rules: configs['schema-relay'].rules,
   },
   'schema-all': {
     languageOptions,
@@ -32,4 +33,4 @@ export const flatConfigs = {
     languageOptions,
     rules: configs['schema-recommended'].rules,
   },
-};
+} satisfies Record<ConfigName, unknown>;

packages/plugin/src/rules/graphql-js-validation.ts

@@ -568,8 +568,7 @@ export const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule> = Object.
     {
       category: 'Schema',
       description: 'A type extension is only valid if the type is defined and has the same kind.',
-      // TODO: add in graphql-eslint v4
-      recommended: false,
+      recommended: true,
       requiresSchema: true,
       isDisabledForAllConfig: true,
     },

packages/plugin/src/rules/unique-fragment-name.ts

@@ -49,6 +49,7 @@ export const rule: GraphQLESLintRule = {
       description: 'Enforce unique fragment names across your project.',
       url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
       requiresSiblings: true,
+      recommended: true,
       examples: [
         {
           title: 'Incorrect',

packages/plugin/src/rules/unique-operation-name.ts

@@ -13,6 +13,7 @@ export const rule: GraphQLESLintRule = {
       description: 'Enforce unique operation names across your project.',
       url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
       requiresSiblings: true,
+      recommended: true,
       examples: [
         {
           title: 'Incorrect',

packages/plugin/src/types.ts

@@ -100,3 +100,10 @@ export type OmitRecursively<T extends object, K extends PropertyKey> = Omit<
   { [P in keyof T]: OmitDistributive<T[P], K> },
   K
 >;
+
+export type ConfigName =
+  | 'operations-all'
+  | 'operations-recommended'
+  | 'schema-all'
+  | 'schema-recommended'
+  | 'schema-relay';

packages/plugin/vite.config.ts

@@ -4,7 +4,7 @@ export default defineConfig({
   test: {
     globals: true,
     resolveSnapshotPath: testPath =>
-      testPath.replace('tests/', 'tests/__snapshots__/').replace(/\.ts$/, '.md'),
+      testPath.replace('__tests__/', '__tests__/__snapshots__/').replace(/\.ts$/, '.md'),
     setupFiles: ['./serializer.ts'],
     alias: {
       '@graphql-eslint/eslint-plugin': 'src/index.ts',

packages/rule-tester/src/index.ts

@@ -26,7 +26,7 @@ function applyFix(code: string, { range, text }: Rule.Fix): string {
 
 export class RuleTester<ParserOptions> extends ESLintRuleTester {
   fromMockFile(path: string): string {
-    return readFileSync(resolve(__dirname, `../../plugin/tests/mocks/${path}`), 'utf-8');
+    return readFileSync(resolve(__dirname, `../../plugin/__tests__/mocks/${path}`), 'utf-8');
   }
 
   // @ts-expect-error -- fix later

scripts/create-rule.ts

@@ -99,7 +99,7 @@ export const rule: GraphQLESLintRule = {
 
 await writeFile(RULE_PATH, RULE_CONTENT.trimStart());
 
-const TEST_PATH = join(CWD, `packages/plugin/tests/${ruleId}.spec.ts`);
+const TEST_PATH = join(CWD, `packages/plugin/__tests__/${ruleId}.spec.ts`);
 const TEST_CONTENT = `
 import { GraphQLRuleTester, ParserOptions } from '../src';
 import { rule } from '../src/rules/${ruleId}';

scripts/generate-docs.ts

@@ -141,7 +141,7 @@ async function generateDocs(): Promise<void> {
     } else {
       blocks.push(
         `- [Rule source](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/rules/${ruleName}.ts)`,
-        `- [Test source](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/tests/${ruleName}.spec.ts)`,
+        `- [Test source](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/__tests__/${ruleName}.spec.ts)`,
       );
     }
     return {
@@ -194,7 +194,8 @@ async function generateDocs(): Promise<void> {
       `- ${Icon.FIXABLE} if some problems reported by the rule are automatically fixable by the \`--fix\` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option`,
       `- ${Icon.HAS_SUGGESTIONS} if some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)`,
       BR,
-      // '<!-- 🚨 IMPORTANT! Do not manually modify this table. Run: `yarn generate:docs` -->',
+      '<!-- 🚨 IMPORTANT! Do not manually modify this table. Run: `yarn generate:docs` -->',
+      '<!-- prettier-ignore -->',
       printMarkdownTable(
         [
           `Name${NBSP.repeat(20)}`,

tsconfig.eslint.json

@@ -6,6 +6,6 @@
     // ensure that nobody can accidentally use this config for a build
     "noEmit": true
   },
-  "include": ["scripts/*.ts", "packages/plugin/tests/**/*.ts", "vite.config.ts", "serializer.ts"],
+  "include": ["scripts/*.ts", "packages/plugin/__tests__/**/*.ts", "vite.config.ts", "serializer.ts"],
   "exclude": []
 }

website/src/components/play-page.tsx

@@ -1,5 +1,5 @@
 import { ReactElement, useRef } from 'react';
-import { flatConfigs, rules } from '@graphql-eslint/eslint-plugin';
+import { flatConfigs, rules, ConfigName } from '@graphql-eslint/eslint-plugin';
 import graphqlESLintPkgJson from '@graphql-eslint/eslint-plugin/package.json';
 import { asArray } from '@graphql-tools/utils';
 import { clsx } from 'clsx';
@@ -9,8 +9,15 @@ import { StringParam, useQueryParam, withDefault } from 'use-query-params';
 import { GraphQLEditor } from './graphql-editor';
 import { Select } from './select';
 
-const schemaConfigs = ['schema-recommended', 'schema-all', 'relay'] as const;
-const operationsConfigs = ['operations-recommended', 'operations-all'] as const;
+const schemaConfigs: ReadonlyArray<ConfigName> = [
+  'schema-recommended',
+  'schema-all',
+  'schema-relay',
+] as const;
+const operationsConfigs: ReadonlyArray<ConfigName> = [
+  'operations-recommended',
+  'operations-all',
+] as const;
 
 const schemaRulesOptions = Object.entries(rules)
   .filter(([, rule]) => asArray(rule.meta.docs!.category).includes('Schema'))

website/src/pages/docs/configs.mdx

@@ -9,7 +9,7 @@ import { Callout } from '@theguild/components'
 |[`schema-all`](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/configs/schema-all.ts)|enables all rules for schema (SDL) development, except for those that require `parserOptions.operations` option|
 |[`operations-recommended`](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/configs/operations-recommended.ts) |enables recommended rules for consuming GraphQL (operations) development|
 |[`operations-all`](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/configs/operations-all.ts)|enables all rules for consuming GraphQL (operations) development|
-|[`relay`](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/configs/relay.ts)|enables rules from Relay specification for schema (SDL) development|
+|[`schema-relay`](https://github.com/B2o5T/graphql-eslint/tree/master/packages/plugin/src/configs/schema-relay.ts)|enables rules from Relay specification for schema (SDL) development|
 {/* prettier-ignore-end */}
 
 <Callout type="warning">