feat(typegen): add location of discovered query (#7327)

sanity-io · Aug 20, 2024 · 60b4000 · 60b4000
1 parent 662f950
commit 60b4000
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 1 deletion.
diff --git a/packages/@sanity/codegen/src/typescript/__tests__/findQueriesInSource.test.ts b/packages/@sanity/codegen/src/typescript/__tests__/findQueriesInSource.test.ts
@@ -14,7 +14,12 @@ describe('findQueries with the groq template', () => {
       const queries = findQueriesInSource(source, 'test.ts')
       const queryResult = queries[0]
 
+      expect(queryResult?.name).toEqual('postQuery')
       expect(queryResult?.result).toEqual('*[_type == "author"]')
+      expect(queryResult?.location).toStrictEqual({
+        end: {line: 3, column: 50, index: 86},
+        start: {line: 3, column: 12, index: 48},
+      })
     })
 
     test('with variables', () => {
@@ -29,6 +34,10 @@ describe('findQueries with the groq template', () => {
       const queryResult = queries[0]
 
       expect(queryResult?.result).toEqual('*[_type == "author"]')
+      expect(queryResult?.location).toStrictEqual({
+        end: {line: 4, column: 53, index: 118},
+        start: {line: 4, column: 12, index: 77},
+      })
     })
 
     test('with function', () => {

diff --git a/packages/@sanity/codegen/src/typescript/expressionResolvers.ts b/packages/@sanity/codegen/src/typescript/expressionResolvers.ts
@@ -20,6 +20,20 @@ export interface NamedQueryResult {
   name: string
   /** result is a groq query */
   result: resolveExpressionReturnType
+
+  /** location is the location of the query in the source */
+  location: {
+    start?: {
+      line: number
+      column: number
+      index: number
+    }
+    end?: {
+      line: number
+      column: number
+      index: number
+    }
+  }
 }
 
 const TAGGED_TEMPLATE_ALLOW_LIST = ['groq']

diff --git a/packages/@sanity/codegen/src/typescript/findQueriesInSource.ts b/packages/@sanity/codegen/src/typescript/findQueriesInSource.ts
@@ -71,7 +71,18 @@ export function findQueriesInSource(
           resolver,
         })
 
-        queries.push({name: queryName, result: queryResult})
+        const location = node.loc
+          ? {
+              start: {
+                ...node.loc?.start,
+              },
+              end: {
+                ...node.loc?.end,
+              },
+            }
+          : {}
+
+        queries.push({name: queryName, result: queryResult, location})
       }
     },
   })