closer behavior to existing

opencollective · Dec 7, 2023 · 2639d5a · 2639d5a
1 parent 4621f7e
commit 2639d5a
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 20 deletions.
diff --git a/packages/plugin/__tests__/processor-with-graphql-config.spec.ts b/packages/plugin/__tests__/processor-with-graphql-config.spec.ts
@@ -26,7 +26,7 @@ describe('processor.preprocess() with graphql-config', () => {
     expect(blocks).toMatchInlineSnapshot(`
       [
         {
-          filename: default_document.graphql,
+          filename: document.graphql,
           lineOffset: 2,
           offset: 77,
           text: query users { id },
@@ -47,7 +47,7 @@ describe('processor.preprocess() with graphql-config', () => {
     expect(blocks).toMatchInlineSnapshot(`
       [
         {
-          filename: default_document.graphql,
+          filename: document.graphql,
           lineOffset: 0,
           offset: 16,
           text: query users { id },

diff --git a/packages/plugin/__tests__/processor-without-graphql-config.spec.ts b/packages/plugin/__tests__/processor-without-graphql-config.spec.ts
@@ -13,7 +13,7 @@ describe('processor.preprocess() without graphql-config', () => {
     expect(blocks).toMatchInlineSnapshot(`
       [
         {
-          filename: default_document.graphql,
+          filename: document.graphql,
           lineOffset: 2,
           offset: 64,
           text: query users { id },
@@ -34,7 +34,7 @@ describe('processor.preprocess() without graphql-config', () => {
     expect(blocks).toMatchInlineSnapshot(`
       [
         {
-          filename: default_document.graphql,
+          filename: document.graphql,
           lineOffset: 0,
           offset: 17,
           text: query users { id },

diff --git a/packages/plugin/__tests__/unique-fragment-name.spec.ts b/packages/plugin/__tests__/unique-fragment-name.spec.ts
@@ -34,7 +34,7 @@ ruleTester.run('unique-fragment-name', rule, {
     {
       // Compare filepath of code as real instead of virtual with siblings
       ...SIBLING_FRAGMENTS(join(__dirname, 'mocks/unique-fragment.js')),
-      filename: join(__dirname, 'mocks/unique-fragment.js/0_default_document.graphql'),
+      filename: join(__dirname, 'mocks/unique-fragment.js/0_document.graphql'),
       code: /* GraphQL */ `
         fragment UserFields on User {
           id

diff --git a/packages/plugin/__tests__/unique-operation-name.spec.ts b/packages/plugin/__tests__/unique-operation-name.spec.ts
@@ -21,7 +21,7 @@ ruleTester.run('unique-operation-name', rule, {
     {
       // Compare filepath of code as real instead of virtual with siblings
       ...SIBLING_OPERATIONS(join(__dirname, 'mocks/unique-fragment.js')),
-      filename: join(__dirname, 'mocks/unique-fragment.js/1_default_document.graphql'),
+      filename: join(__dirname, 'mocks/unique-fragment.js/1_document.graphql'),
       code: /* GraphQL */ `
         query User {
           user {

diff --git a/packages/plugin/src/documents.ts b/packages/plugin/src/documents.ts
@@ -19,9 +19,10 @@ const handleVirtualPath = (documents: Source[], project: GraphQLProjectConfig):
     }
     filepathMap[location] ??= -1;
     const index = (filepathMap[location] += 1);
+    const prefix = project.name && project.name !== 'default' ? `${project.name}_` : '';
     return {
       ...source,
-      location: resolve(location, `${index}_${project.name ?? 'default'}_document.graphql`),
+      location: resolve(location, `${index}_${prefix}document.graphql`),
     };
   });
 };

diff --git a/packages/plugin/src/processor.ts b/packages/plugin/src/processor.ts
@@ -24,25 +24,28 @@ const RELEVANT_KEYWORDS = ['gql', 'graphql', 'GraphQL'] as const;
 function getMatchingProjects(onDiskConfig: GraphQLConfig, filePath: string) {
   const matchingProjects: Record<string, GraphQLProjectConfig> = {};
 
-  if (onDiskConfig?.projects) {
+  // Default project for file
+  // - ok if project is null
+  // - getProjectForFile may be mocked in tests
+  const project = onDiskConfig?.getProjectForFile(filePath);
+  const projectName = project?.name ?? 'default';
+  if (!matchingProjects[projectName]) {
+    matchingProjects[projectName] = project;
+  }
+
+  // If more than one project
+  if (onDiskConfig?.projects && Object.keys(onDiskConfig.projects).length > 1) {
     // Reference:
     // https://github.com/kamilkisiela/graphql-config/blob/423de0e07214ad6d800fb508a74951a5bfc045e6/src/config.ts#L143
-    for (const [projectName, project] of Object.entries(onDiskConfig.projects)) {
+    for (const project of Object.values(onDiskConfig.projects)) {
       if (project.match(filePath)) {
-        matchingProjects[projectName] = project;
+        matchingProjects[project.name] = project;
       } else if (!project.include && !project.exclude) {
-        matchingProjects[projectName] = project;
+        matchingProjects[project.name] = project;
       }
     }
   }
 
-  // Default, also help with tests
-  const project = onDiskConfig?.getProjectForFile(filePath);
-  const projectName = project?.name ?? 'default';
-  if (!matchingProjects[projectName]) {
-    matchingProjects[projectName] = project;
-  }
-
   return matchingProjects;
 }
 
@@ -92,8 +95,10 @@ export const processor = {
         });
 
         for (const item of sources) {
+          // We avoid an unnecessary prefix when it's falsy or default
+          const prefix = projectName && projectName !== 'default' ? `${projectName}_` : '';
           blocks.push({
-            filename: `${projectName ?? 'default'}_document.graphql`,
+            filename: `${prefix}document.graphql`,
             text: item.body,
             lineOffset: item.locationOffset.line - 1,
             // @ts-expect-error -- `index` field exist but show ts error

diff --git a/packages/plugin/src/utils.ts b/packages/plugin/src/utils.ts
@@ -48,7 +48,7 @@ export const logger = {
 
 export const normalizePath = (path: string): string => (path || '').replace(/\\/g, '/');
 
-export const VIRTUAL_DOCUMENT_REGEX = /\/\d+_([a-zA-Z0-9]*)_document.graphql$/;
+export const VIRTUAL_DOCUMENT_REGEX = /\/\d+_([a-zA-Z0-9]*)?_?document.graphql$/;
 
 export const CWD = process.cwd();