Add CLI option to generate-persisted-query-manifest that lists all …

…matched files using the `documents` pattern (#344)

.changeset/poor-flowers-sin.md

@@ -0,0 +1,5 @@
+---
+"@apollo/generate-persisted-query-manifest": minor
+---
+
+Add a `--list-files` option that lists the set of matched files against the `documents` pattern.

packages/generate-persisted-query-manifest/cli.js

@@ -2,7 +2,11 @@
 
 const { Command } = require("commander");
 const { cosmiconfig } = require("cosmiconfig");
-const { generatePersistedQueryManifest, defaults } = require("./dist/index.js");
+const {
+ generatePersistedQueryManifest,
+ getFilepaths,
+ defaults,
+} = require("./dist/index.js");
 const { TypeScriptLoader } = require("cosmiconfig-typescript-loader");
 const { version } = require("./package.json");
 const { writeFileSync } = require("node:fs");
@@ -28,13 +32,31 @@ async function getUserConfig({ config: configPath }) {
  return configPath ? explorer.load(configPath) : explorer.search();
 }
 
+async function listFiles(config) {
+ const filepaths = await getFilepaths(config?.documents ?? defaults.documents);
+
+ if (filepaths.length > 0) {
+ console.log(filepaths.join("\n"));
+ }
+}
+
 program
  .name("generate-persisted-query-manifest")
  .description("Generate a persisted query manifest file")
  .option("-c, --config <path>", "path to the config file")
+ .option(
+ "-l, --list-files",
+ "prints the files matched from the documents pattern",
+ )
  .version(version, "-v, --version")
  .action(async (cliOptions) => {
  const result = await getUserConfig(cliOptions);
+
+ if (cliOptions.listFiles) {
+ await listFiles(result?.config);
+ process.exit(0);
+ }
+
  const outputPath = result?.config.output ?? defaults.output;
 
  const manifest = await generatePersistedQueryManifest(

packages/generate-persisted-query-manifest/src/__tests__/cli.test.ts

@@ -23,6 +23,7 @@ test("prints help message with --help", async () => {
  "Generate a persisted query manifest file",
  "Options:",
  "-c, --config <path> path to the config file",
+ "-l, --list-files prints the files matched from the documents pattern",
  "-v, --version output the version number",
  "-h, --help display help for command",
  ]
@@ -45,6 +46,31 @@ test("prints version number with --version", async () => {
  await cleanup();
 });
 
+test("prints list of matched files with --list-files option", async () => {
+ const { cleanup, runCommand, writeFile } = await setup();
+
+ await writeFile("./src/query.graphql", "");
+ await writeFile("./src/components/legacy.js", "");
+ await writeFile("./src/components/my-component.tsx", "");
+ await writeFile("./src/queries/root.graphql", "");
+ // Include a file that isn't part of the globbed pattern
+ await writeFile("./not-included.ts", "");
+
+ const { code, stdout } = await runCommand("--list-files");
+
+ expect(code).toBe(0);
+ expect(stdout).toMatchInlineSnapshot(`
+ [
+ "src/components/legacy.js",
+ "src/components/my-component.tsx",
+ "src/queries/root.graphql",
+ "src/query.graphql",
+ ]
+ `);
+
+ await cleanup();
+});
+
 test("writes manifest file and prints location", async () => {
  const { cleanup, exists, runCommand } = await setup();
 

packages/generate-persisted-query-manifest/src/index.ts

@@ -215,6 +215,14 @@ function uniq<T>(arr: T[]) {
  return [...new Set(arr)];
 }
 
+// Unfortunately globby does not guarantee deterministic file sorting so we
+// apply some sorting on the files in this function.
+//
+// https:/sindresorhus/globby/issues/131
+export async function getFilepaths(documents: string | string[]) {
+ return [...uniq(await globby(documents))].sort((a, b) => a.localeCompare(b));
+}
+
 export async function generatePersistedQueryManifest(
  config: PersistedQueryManifestConfig = {},
  configFilePath: string | undefined,
@@ -229,8 +237,8 @@ export async function generatePersistedQueryManifest(
  ? relative(process.cwd(), configFilePath)
  : "<virtual>",
  });
- const filepaths = await globby(documents);
- const sources = uniq(filepaths).flatMap(getDocumentSources);
+ const filepaths = await getFilepaths(documents);
+ const sources = filepaths.flatMap(getDocumentSources);
 
  const fragmentsByName = new Map<string, DocumentSource[]>();
  const operationsByName = new Map<string, DocumentSource[]>();