feat: provider-specific graphql file naming convention (#982)

.changeset/lovely-adults-learn.md

@@ -0,0 +1,5 @@
+---
+"@bigcommerce/catalyst-core": patch
+---
+
+Introduces more consistent naming convention for files related to GraphQL, changes opinions around when it is appropriate to track GraphQL files in version control, fixes an issue where the `generate.cjs` script was swallowing helpful error messaging

.gitignore

@@ -11,5 +11,6 @@ dist
 test-results/
 playwright-report/
 playwright/.cache/
-graphql-env.d.ts
+bigcommerce.graphql
+bigcommerce-graphql.d.ts
 .DS_Store

core/.gitignore

@@ -40,7 +40,6 @@ next-env.d.ts
 
 # generated
 client/generated
-schema.graphql
 
 # secrets
 .catalyst

core/client/graphql.ts

@@ -1,6 +1,6 @@
 import { initGraphQLTada } from 'gql.tada';
 
-import type { introspection } from '~/graphql-env';
+import type { introspection } from '~/bigcommerce-graphql';
 
 export const graphql = initGraphQLTada<{
   introspection: introspection;

core/scripts/generate.cjs

@@ -44,18 +44,24 @@ const getEndpoint = () => {
 };
 
 const generate = async () => {
-  await generateSchema({
-    input: getEndpoint(),
-    headers: { Authorization: `Bearer ${getToken()}` },
-    output: join(__dirname, '../schema.graphql'),
-    tsconfig: undefined,
-  });
-
-  await generateOutput({
-    disablePreprocessing: false,
-    output: join(__dirname, '../graphql-env.d.ts'),
-    tsconfig: undefined,
-  });
+  try {
+    await generateSchema({
+      input: getEndpoint(),
+      headers: { Authorization: `Bearer ${getToken()}` },
+      output: join(__dirname, '../bigcommerce.graphql'),
+      tsconfig: undefined,
+    });
+
+    await generateOutput({
+      disablePreprocessing: false,
+      output: undefined,
+      tsconfig: undefined,
+    });
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(error);
+    process.exit(1);
+  }
 };
 
 generate();

core/tsconfig.json

@@ -25,10 +25,15 @@
       },
       {
         "name": "@0no-co/graphqlsp",
-        "schema": "./schema.graphql",
-        "tadaOutputLocation": "./graphql-env.d.ts",
         "trackFieldUsage": false,
-        "shouldCheckForColocatedFragments": false
+        "shouldCheckForColocatedFragments": false,
+        "schemas": [
+          {
+            "name": "bigcommerce",
+            "schema": "./bigcommerce.graphql",
+            "tadaOutputLocation": "./bigcommerce-graphql.d.ts"
+          }
+        ]
       }
     ],
     "baseUrl": ".",