--list and --only-errors options (#6)

README.md

@@ -75,7 +75,7 @@ Scanned 3 documents consisting of 3 operations (and 3 fragments). Visited 16
 fields, 0 arguments, 3 named fragment spreads and 0 inline fragment spreads.
 
 Errors: 0
-Infractions: 0 (baseline removed: 3)
+Infractions: 0 (ignored: 3)
 ```
 
 Passing all these flags is a chore; instead, let's create a configuration file
@@ -101,7 +101,7 @@ Scanned 3 documents consisting of 3 operations (and 3 fragments). Visited 16
 fields, 0 arguments, 3 named fragment spreads and 0 inline fragment spreads.
 
 Errors: 0
-Infractions: 0 (baseline removed: 3)
+Infractions: 0 (ignored: 3)
 ```
 
 ## Exit status
@@ -338,6 +338,56 @@ schema SDL is.
 You can also pass `-b baseline.json5` to identify your baseline file; and use
 `-u` to update the baseline such that all current documents are allowed.
 
+### Full usage
+
+```
+Usage:
+
+  gqlcheck [-s schema.graphqls] [-b baseline.json5] [-u] [-l] [-e] doc1.graphql doc2.graphql
+
+Flags:
+
+--help
+-h
+
+    Output available CLI flags
+
+--version
+-v
+
+    Output the version
+
+--config <configPath>
+-C <configPath>
+
+    The path to the config file
+
+--schema <sdlPath>
+-s <sdlPath>
+
+    Path to the GraphQL schema SDL file
+
+--baseline <jsonPath>
+-b <jsonPath>
+
+    Path to the baseline file (.json or .json5)
+
+--update-baseline
+-u
+
+    Update the baseline.json file to allow all passed documents even if they break the rules.
+
+--list
+-l
+
+    Don't output any details, just list the affected source names.
+
+--only-errors
+-e
+
+    Only output details about errors (not infractions); combine with `-l` to list only the files with errors.
+```
+
 ## FAQ
 
 ### Do I have to use the `.graphqls` extension for my schema?

__tests__/depth-limit-basics/output.custom-baseline.ansi

@@ -53,4 +53,4 @@ SelfOtherSelf5.graphql:
 Scanned 14 documents consisting of 14 operations (and 35 fragments). Visited 113 fields, 0 arguments, 36 named fragment spreads and 0 inline fragment spreads.
 
 Errors: 4
-Infractions: 8 (baseline removed: 1)
+Infractions: 8 (ignored: 1)

__tests__/depth-limit-basics/output.full-baseline.ansi

@@ -13,4 +13,4 @@ Invalid_FoFoFoFoF_wide_cycle.graphql:
 Scanned 14 documents consisting of 14 operations (and 35 fragments). Visited 113 fields, 0 arguments, 36 named fragment spreads and 0 inline fragment spreads.
 
 Errors: 4
-Infractions: 0 (baseline removed: 9)
+Infractions: 0 (ignored: 9)

path/to/operations/doc1.graphql

@@ -0,0 +1,7 @@
+query F {
+  currentUser {
+    friends {
+      name
+    }
+  }
+}

path/to/operations/doc2.graphql

@@ -0,0 +1,20 @@
+query FoFoF {
+  currentUser {
+    ...F1
+  }
+}
+fragment F1 on User {
+  friends {
+    ...F2
+  }
+}
+fragment F2 on User {
+  friends {
+    ...F3
+  }
+}
+fragment F3 on User {
+  friends {
+    name
+  }
+}

path/to/operations/doc3.graphql

@@ -0,0 +1,17 @@
+query FoFoFoFoFoF {
+  currentUser {
+    friends {
+      friends {
+        friends {
+          friends {
+            friends {
+              friends {
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

path/to/schema.graphqls

@@ -0,0 +1,23 @@
+type Query {
+  currentUser: User
+}
+type User {
+  name: String
+  "Same object again"
+  self: User
+  otherSelf: User
+  friends: [User!]!
+  friendsConnection: UserConnection!
+}
+type UserConnection {
+  edges: [FriendEdge]!
+  pageInfo: PageInfo
+}
+type PageInfo {
+  hasNextPage: Boolean
+}
+type FriendEdge {
+  cursor: String!
+  node: User
+}
+

src/baseline.ts

@@ -74,14 +74,14 @@ function filterOutput(
             );
             if (operationCoordinates.length === 0) {
               // Fully ignored
-              filtered++;
               return null;
             }
             op.operationCoordinates = operationCoordinates;
             return op;
           })
           .filter((o) => o != null);
         if (operations.length === 0) {
+          filtered++;
           return null;
         } else {
           e.operations = operations;
@@ -100,6 +100,30 @@ function filterOutput(
   };
 }
 
+function filterOutputOnlyErrors(
+  output: CheckDocumentOutput,
+): CheckDocumentOutput {
+  const { errors: rawErrors } = output;
+  let filtered = 0;
+
+  const errors = rawErrors
+    .map((e) => {
+      if ("infraction" in e) {
+        filtered++;
+        return null;
+      } else {
+        return e;
+      }
+    })
+    .filter((e) => e != null);
+
+  return {
+    ...output,
+    errors,
+    filtered,
+  };
+}
+
 export function filterBaseline(
   baseline: Baseline,
   result: CheckOperationsResult,
@@ -120,3 +144,22 @@ export function filterBaseline(
     filtered,
   };
 }
+
+export function filterOnlyErrors(
+  result: CheckOperationsResult,
+): CheckOperationsResult {
+  let filtered = 0;
+  const entries = Object.entries(result.rawResultsBySourceName)
+    .map(([sourceName, { output: rawOutput, sourceString }]) => {
+      const output = filterOutputOnlyErrors(rawOutput);
+      filtered += output.filtered;
+      return [sourceName, { output, sourceString }];
+    })
+    .filter((e) => e != null);
+  const resultsBySourceName = Object.fromEntries(entries);
+  return {
+    ...result,
+    resultsBySourceName,
+    filtered,
+  };
+}

src/cli.ts

@@ -6,7 +6,11 @@ import { parseArgs } from "node:util";
 import JSON5 from "json5";
 import { kjsonlLines } from "kjsonl";
 
-import { filterBaseline, generateBaseline } from "./baseline.js";
+import {
+  filterBaseline,
+  filterOnlyErrors,
+  generateBaseline,
+} from "./baseline.js";
 import type { SourceLike } from "./interfaces.js";
 import { checkOperations } from "./main.js";
 import { generateOutputAndCounts } from "./print.js";
@@ -51,6 +55,20 @@ const parseArgsConfig = {
       description:
         "Update the baseline.json file to allow all passed documents even if they break the rules.",
     },
+    list: {
+      short: "l",
+      type: "boolean",
+      placeholder: undefined,
+      description:
+        "Don't output any details, just list the affected source names.",
+    },
+    "only-errors": {
+      short: "e",
+      type: "boolean",
+      placeholder: undefined,
+      description:
+        "Only output details about errors (not infractions); combine with `-l` to list only the files with errors.",
+    },
   },
   allowPositionals: true,
   strict: true,
@@ -133,7 +151,7 @@ async function main() {
       `
 Usage:
 
-  gqlcheck [-s schema.graphqls] [-b baseline.json5] [-u] doc1.graphql doc2.graphql
+  gqlcheck [-s schema.graphqls] [-b baseline.json5] [-u] [-l] [-e] doc1.graphql doc2.graphql
 
 Flags:
 
@@ -151,7 +169,14 @@ ${(Object.entries(parseArgsConfig.options) as Array<[key: keyof (typeof parseArg
     ...(values.baseline ? { baselinePath: values.baseline } : null),
   };
   let result = await checkOperations(getOperations, values.config, conf);
-  if (values["update-baseline"]) {
+  if (values["only-errors"]) {
+    if (values["update-baseline"]) {
+      throw new Error(
+        `--update-baseline cannot be combined with --only-errors`,
+      );
+    }
+    result = filterOnlyErrors(result);
+  } else if (values["update-baseline"]) {
     const baselinePath = result.resolvedPreset.gqlcheck?.baselinePath;
     if (!baselinePath) {
       throw new Error(
@@ -168,7 +193,17 @@ ${(Object.entries(parseArgsConfig.options) as Array<[key: keyof (typeof parseArg
     console.log();
   }
   const { output, errors, infractions } = generateOutputAndCounts(result);
-  console.log(output);
+  if (values["list"]) {
+    for (const [sourceName, { output }] of Object.entries(
+      result.resultsBySourceName,
+    )) {
+      if (output.errors.length > 0) {
+        console.log(sourceName);
+      }
+    }
+  } else {
+    console.log(output);
+  }
   if (errors > 0) {
     process.exitCode = 1;
   }

src/index.ts

@@ -9,7 +9,11 @@ import type {
   VisitorsEvent,
 } from "./interfaces.js";
 
-export { filterBaseline, generateBaseline } from "./baseline.js";
+export {
+  filterBaseline,
+  filterOnlyErrors,
+  generateBaseline,
+} from "./baseline.js";
 export {
   Baseline,
   CheckOperationsResult,

src/print.ts

@@ -85,7 +85,7 @@ ${parts.join("\n\n")}
 ${printCounts(result)}
 
 Errors: ${errors}
-Infractions: ${infractions}${result.filtered > 0 ? ` (baseline removed: ${result.filtered})` : ``}
+Infractions: ${infractions}${result.filtered > 0 ? ` (ignored: ${result.filtered})` : ``}
 `.trim(),
     errors,
     infractions,