improvement: consolidate rules (#4)

### improvements
- use `RelayKnownArgumentNames` in both configs
- export `validationRules` from `generateConfig`

### tests
- add tests
- jest config for coverage
###  tooling updates
- use `main` for `baseBranch` in `changeset`, thats the issue!

Author: acao

.changeset/config.json

@@ -4,5 +4,6 @@
     { "repo": "relay-tools/relay-graphql-js" }
   ],
   "commit": false,
-  "access": "public"
+  "access": "public",
+  "baseBranch": "main"
 }

.changeset/honest-dots-decide.md

@@ -0,0 +1,10 @@
+---
+"@relay-graphql-js/generate-config": minor
+"@relay-graphql-js/graphql-config": minor
+"@relay-graphql-js/validation-rules": minor
+"vscode-apollo-relay": minor
+---
+## Improvements
+
+- use `RelayKnownArgumentNames` in both configs
+- export `validationRules` from core `generateConfig`

.github/workflows/ci.yml

@@ -9,9 +9,6 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@master
-        with:
-          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits 
-          fetch-depth: 0
 
 
       - name: Setup Node.js 12.x

jest.config.js

@@ -3,4 +3,14 @@ module.exports = {
   moduleFileExtensions: ["ts", "js", "json"],
   testMatch: ["**/tests/**/*.ts", "**/*.test.ts"],
   transform: { "\\.ts$": "ts-jest" },
+  collectCoverageFrom: [
+    '**/src/**/*.{js,jsx,ts,tsx}',
+    '!**/src/**/*.stories.js*',
+    '!**/{dist,build,esm}/**',
+    '!**/node_modules/**',
+    '!**/__tests__/**',
+    '!**/test/**',
+    '!**/*.d.ts',
+    '!**/typings',
+  ]
 }

packages/generate-config/package.json

@@ -15,5 +15,8 @@
   "peerDependencies": {
     "relay-compiler": ">=5.0.0",
     "relay-config": ">=5.0.0"
+  },
+  "dependencies": {
+    "@relay-graphql-js/validation-rules": "^0.0.1"
   }
 }

packages/generate-config/src/dependencies.ts

@@ -4,7 +4,6 @@
  * e.g. graphql-js parts come from different modules (i.e. the user's node_modules).
  */
 
-import * as _ApolloValidation from "apollo-language-server/lib/errors/validation";
 import * as _GraphQL from "graphql";
 import * as _RelayCompilerMain from "relay-compiler/lib/bin/RelayCompilerMain";
 import * as _RelayConfig from "relay-config";
@@ -54,13 +53,6 @@ export const loadDependencies = (moduleFilter: ModuleFilter, loadAdditional?: (m
     TypeInfo,
   } = mod.require("graphql") as typeof _GraphQL;
 
-  const didYouMean = mod.require("graphql/jsutils/didYouMean").default as (suggestions: string[]) => string;
-
-  const suggestionList = mod.require("graphql/jsutils/suggestionList").default as (
-    input: string,
-    options: string[]
-  ) => string[];
-
   let relayConfigMod: typeof _RelayConfig | null = null;
   try {
     // tslint:disable-next-line: no-var-requires
@@ -87,8 +79,6 @@ export const loadDependencies = (moduleFilter: ModuleFilter, loadAdditional?: (m
   const RelayCompilerMain = relayCompilerMainMod;
   return {
     ...(loadAdditional ? loadAdditional(mod) : {}),
-    didYouMean,
-    suggestionList,
     RelayConfig,
     RelayCompilerMain,
     BREAK,

packages/generate-config/src/generateConfig.ts

@@ -1,5 +1,18 @@
 import * as path from "path";
 
+import type { loadConfig } from "relay-config";
+
+import {
+  RelayArgumentsOfCorrectType,
+  RelayCompatMissingConnectionDirective,
+  RelayCompatRequiredPageInfoFields,
+  RelayDefaultValueOfCorrectType,
+  RelayKnownArgumentNames,
+  RelayKnownVariableNames,
+  RelayNoUnusedArguments,
+  RelayVariablesInAllowedPosition,
+} from "@relay-graphql-js/validation-rules";
+
 import { loadDependencies, ModuleFilter } from "./dependencies";
 import { generateDirectivesFile } from "./generateDirectivesFile";
 
@@ -8,9 +21,11 @@ const DEFAULTS = {
   src: "./src",
 };
 
-export function generateConfig(moduleFilter: ModuleFilter) {
+type TRelayConfig = ReturnType<typeof loadConfig>;
+
+export function generateConfig(moduleFilter: ModuleFilter, compat: boolean = false) {
   const { RelayCompilerMain, RelayConfig } = loadDependencies(moduleFilter);
-  function loadRelayConfig() {
+  function loadRelayConfig(): typeof RelayConfig {
     if (!RelayConfig) {
       console.log("User has not installed relay-config, so needs manual configuration.");
       return null;
@@ -31,10 +46,10 @@ export function generateConfig(moduleFilter: ModuleFilter) {
       RelayCompilerMain && RelayCompilerMain.getLanguagePlugin((relayConfig && relayConfig.language) || "javascript");
     return languagePlugin ? languagePlugin.inputExtensions : ["js", "jsx"];
   }
-  const relayConfig = loadRelayConfig();
+  const relayConfig: TRelayConfig = loadRelayConfig();
   const extensions = getInputExtensions(relayConfig);
   const directivesFile = generateDirectivesFile();
-  // const compatOnlyRules = compat ? [RelayCompatRequiredPageInfoFields, RelayCompatMissingConnectionDirective] : []
+  const compatOnlyRules = compat ? [RelayCompatRequiredPageInfoFields, RelayCompatMissingConnectionDirective] : [];
 
   const includesGlobPattern = (inputExtensions: string[]) => `**/*.{graphql,${inputExtensions.join(",")}}`;
 
@@ -43,9 +58,20 @@ export function generateConfig(moduleFilter: ModuleFilter) {
     directivesFile,
     extensions,
     includesGlobPattern,
-    includes: [directivesFile, path.join((relayConfig || DEFAULTS).src, includesGlobPattern(extensions))],
-    excludes: relayConfig ? relayConfig.exclude : [],
+    include: [path.join((relayConfig || DEFAULTS).src, includesGlobPattern(extensions))],
+    exclude: relayConfig ? relayConfig.exclude : [],
     relayConfig,
     DEFAULTS,
+    validationRules: [
+      ...compatOnlyRules,
+      RelayArgumentsOfCorrectType,
+      RelayCompatMissingConnectionDirective,
+      RelayCompatRequiredPageInfoFields,
+      RelayDefaultValueOfCorrectType,
+      RelayKnownVariableNames,
+      RelayNoUnusedArguments,
+      RelayVariablesInAllowedPosition,
+      RelayKnownArgumentNames,
+    ],
   };
 }

packages/generate-config/tests/generateConfig-test.ts

@@ -0,0 +1,60 @@
+import type { ValidationRule } from "graphql";
+import { Config } from "relay-compiler/lib/bin/RelayCompilerMain";
+import { generateConfig } from "../src/index";
+
+jest.mock("cosmiconfig", () => () => ({
+  searchSync: () => ({
+    config: {
+      schema: "path/to/schema.graphql",
+      src: "path/to/src-root",
+      exclude: ["path/to/exclude"],
+    } as Config,
+  }),
+}));
+
+const moduleId = "graphql.vscode-graphql";
+
+describe(generateConfig, () => {
+  xdescribe("when user does not use relay-config", () => {
+    it("uses a default schema file", () => {
+      jest.mock("relay-config", () => ({ loadConfig: () => null }));
+      const config = generateConfig(moduleId);
+      expect(config.schema).toEqual("./data/schema.graphql");
+    });
+
+    it("uses a default source root", () => {
+      jest.mock("relay-config", () => ({ loadConfig: () => null }));
+      const config = generateConfig(moduleId);
+      expect(config.include).toEqual("./src/**/*.{graphql,js,jsx}");
+    });
+  });
+
+  it("specifies the schema file", () => {
+    const config = generateConfig(moduleId);
+    expect(config.schema).toEqual("path/to/schema.graphql");
+  });
+
+  it("specifies the source files to include", () => {
+    const config = generateConfig(moduleId);
+    expect(config.include).toContain("path/to/src-root/**/*.{graphql,js,jsx}");
+  });
+
+  it("specifies the source files to exclude", () => {
+    const config = generateConfig(moduleId);
+    expect(config.exclude).toContain("path/to/exclude");
+  });
+
+  it("excludes validation rules that are incompatible with Relay", () => {
+    const config = generateConfig(moduleId);
+    const rules = config.validationRules as ValidationRule[];
+    expect(rules.map(({ name }) => name)).not.toContain("NoUndefinedVariablesRule");
+  });
+
+  it("includes the RelayUnknownArgumentNames validation rule", () => {
+    const config = generateConfig(moduleId);
+    const rules = config.validationRules as ValidationRule[];
+    expect(rules.map(({ name }) => name)).toContain("RelayKnownArgumentNames");
+  });
+
+  it.todo("specifies the source files to include with a different language plugin");
+});

packages/generate-config/tsconfig.json

@@ -5,5 +5,10 @@
     "rootDir": "./src",
     "outDir": "./dist",
     "composite": true
-  }
+  },
+  "references": [
+    {
+      "path": "../validation-rules"
+    }
+  ]
 }

packages/graphql-config/src/generateConfig.ts

@@ -1,40 +1,23 @@
 import { ValidationRule } from "graphql";
-import type { GraphQLProjectConfig } from "graphql-config";
+import type { IGraphQLProject } from "graphql-config";
 
 import { generateConfig as generateConfigFromRelay } from "@relay-graphql-js/generate-config";
-import {
-  RelayArgumentsOfCorrectType,
-  RelayCompatMissingConnectionDirective,
-  RelayCompatRequiredPageInfoFields,
-  RelayDefaultValueOfCorrectType,
-  RelayKnownVariableNames,
-  RelayNoUnusedArguments,
-  RelayVariablesInAllowedPosition,
-} from "@relay-graphql-js/validation-rules";
 
-export function generateConfig(compat: boolean = false, customValidationRules: ValidationRule[] = []) {
-  const { schema, includes, excludes, includesGlobPattern, directivesFile } = generateConfigFromRelay(
-    "graphql.vscode-graphql"
+export function generateConfig(compat?: boolean, customValidationRules: ValidationRule[] = []) {
+  const { schema, include, exclude, includesGlobPattern, directivesFile, validationRules } = generateConfigFromRelay(
+    "graphql.vscode-graphql",
+    compat
   );
-  const compatOnlyRules = compat ? [RelayCompatRequiredPageInfoFields, RelayCompatMissingConnectionDirective] : [];
 
-  const config = {
+  const config: IGraphQLProject = {
     schema: [schema, directivesFile],
-    includes,
-    excludes,
-    documents: includes,
+    include,
+    exclude,
+    documents: [...include],
     extensions: {
-      customValidationRules: [
-        RelayKnownVariableNames,
-        RelayVariablesInAllowedPosition,
-        RelayArgumentsOfCorrectType,
-        RelayDefaultValueOfCorrectType,
-        RelayNoUnusedArguments,
-        ...compatOnlyRules,
-        ...customValidationRules,
-      ],
+      customValidationRules: [...validationRules, ...customValidationRules],
     },
-  } as Partial<GraphQLProjectConfig>;
+  };
 
   return { config, directivesFile, includesGlobPattern };
 }