Merge pull request #1285 from Quramy/upgrade_fretted_strings

chore: Upgrade to fretted-strings v2
Quramy · Apr 2, 2024 · c46a365 · c46a365
2 parents c7a1ffb + d2a109a
commit c46a365
Show file tree

Hide file tree

Showing 13 changed files with 222 additions and 246 deletions.
diff --git a/e2e/lang-server-specs/completions.js b/e2e/lang-server-specs/completions.js
@@ -1,21 +1,19 @@
 const assert = require('assert');
 const path = require('path');
-const { mark } = require('fretted-strings');
+const { extract } = require('fretted-strings');
 
 function findResponse(responses, commandName) {
   return responses.find(response => response.command === commandName);
 }
 
 async function run(server) {
   const file = path.resolve(__dirname, '../../project-fixtures/simple-prj/main.ts');
-  const frets = {};
-  const fileContent = mark(
+  const [fileContent, frets] = extract(
     `
 const q = gql\`query { 
 %%%          \\       ^ %%%
 %%%          \\       p %%%
   `,
-    frets,
   );
   server.send({ command: 'open', arguments: { file, fileContent, scriptKindName: 'TS' } });
   await server.waitEvent('projectLoadingFinish');

diff --git a/e2e/lang-server-specs/definition.js b/e2e/lang-server-specs/definition.js
@@ -1,6 +1,6 @@
 const assert = require('assert');
 const path = require('path');
-const { mark } = require('fretted-strings');
+const { extract } = require('fretted-strings');
 
 function findResponse(responses, commandName) {
   return responses.find(response => response.command === commandName);
@@ -9,15 +9,14 @@ function findResponse(responses, commandName) {
 async function run(server) {
   const fileFragments = path.resolve(__dirname, '../../project-fixtures/simple-prj/fragments.ts');
   const fileMain = path.resolve(__dirname, '../../project-fixtures/simple-prj/main.ts');
-  const frets = {};
   const fileFragmentsContent = `
     const fragment = gql\`
       fragment MyFragment on Query {
         hello
       }
     \`;
   `;
-  const fileMainContent = mark(
+  const [fileMainContent, frets] = extract(
     `
       const query = gql\`
         query MyQuery {
@@ -27,7 +26,6 @@ async function run(server) {
         }
       \`;
     `,
-    frets,
   );
   server.send({
     command: 'open',

diff --git a/e2e/lang-server-specs/diagnostics-with-update.js b/e2e/lang-server-specs/diagnostics-with-update.js
@@ -1,6 +1,6 @@
 const assert = require('assert');
 const path = require('path');
-const { mark } = require('fretted-strings');
+const { extract } = require('fretted-strings');
 
 function findResponse(responses, eventName) {
   return responses.find(response => response.event === eventName);
@@ -14,15 +14,13 @@ const f = gql\`fragment MyFragment on Query { hello }\`;
   `;
 
   const fileMain = path.resolve(__dirname, '../../project-fixtures/simple-prj/main.ts');
-  const frets = {};
-  const fileMainContent = mark(
+  const [fileMainContent, frets] = extract(
     `
 import gql from 'graphql-tag';
 const q = gql\`query MyQuery { }\`;
 %%%          \\               ^ %%%
 %%%          \\               p %%%
   `,
-    frets,
   );
 
   server.send({

diff --git a/e2e/lang-server-specs/quickinfo.js b/e2e/lang-server-specs/quickinfo.js
@@ -1,23 +1,21 @@
 const assert = require('assert');
 const path = require('path');
-const { mark } = require('fretted-strings');
+const { extract } = require('fretted-strings');
 
 function findResponse(responses, commandName) {
   return responses.find(response => response.command === commandName);
 }
 
 async function run(server) {
   const file = path.resolve(__dirname, '../../project-fixtures/simple-prj/main.ts');
-  const frets = {};
-  const fileContent = mark(
+  const [fileContent, frets] = extract(
     `
     const q = gql\`query {
       hello
 %%%   ^                   %%%
 %%%   p                   %%%
     }
   `,
-    frets,
   );
   server.send({
     command: 'open',

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -61,7 +61,7 @@
     "c8": "9.1.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
-    "fretted-strings": "1.0.1",
+    "fretted-strings": "2.0.0",
     "glob": "10.3.12",
     "graphql": "16.8.1",
     "graphql-config": "5.0.3",

diff --git a/src/errors/__snapshots__/error-reporter.test.ts.snap b/src/errors/__snapshots__/error-reporter.test.ts.snap
@@ -1,37 +1,37 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`ErrorReporter outputError ErrorWithLocation should output location of errors in human readable format 1`] = `
-"main.ts:2:25 - some error
+"main.ts:2:27 - some error
 
 1 
-2           const query = invalidQuery;
-                          ~~~~~~~~~~~~
+2             const query = invalidQuery;
+                            ~~~~~~~~~~~~
 "
 `;
 
 exports[`ErrorReporter outputError ErrorWithLocation should output location of errors in human readable format with 2 lines 1`] = `
-"main.ts:3:19 - some error
-
-2           const query = gql\`;
-3             query MyQuery {
-                    ~~~~~~~~~
-4               name
-  ~~~~~~~~~~~~~~~~~~
-5             }
+"main.ts:3:21 - some error
+
+2             const query = gql\`;
+3               query MyQuery {
+                      ~~~~~~~~~
+4                 name
+  ~~~~~~~~~~~~~~~~~~~~
+5               }
 "
 `;
 
 exports[`ErrorReporter outputError ErrorWithLocation should output location of errors in human readable format with 3 or more lines 1`] = `
-"main.ts:3:19 - some error
-
-2           const query = gql\`;
-3             query MyQuery {
-                    ~~~~~~~~~
-4               id
-  ~~~~~~~~~~~~~~~~
-5               name
+"main.ts:3:21 - some error
+
+2             const query = gql\`;
+3               query MyQuery {
+                      ~~~~~~~~~
+4                 id
   ~~~~~~~~~~~~~~~~~~
-6             }
+5                 name
+  ~~~~~~~~~~~~~~~~~~~~
+6               }
 "
 `;
 

diff --git a/src/errors/error-reporter.test.ts b/src/errors/error-reporter.test.ts
@@ -1,4 +1,4 @@
-import { mark, Frets } from 'fretted-strings';
+import extract from 'fretted-strings';
 import { ErrorReporter } from './error-reporter';
 import { ErrorWithLocation, ErrorWithoutLocation } from '.';
 import { clearColor } from '../string-util';
@@ -25,18 +25,17 @@ describe(ErrorReporter, () => {
       it('should output location of errors in human readable format', () => {
         let message: string = '';
         const reporter = new ErrorReporter('/prj', msg => (message = msg));
-        const frets: Frets = {};
+        const [content, frets] = extract(
+          `
+            const query = invalidQuery;
+            %%%           ^           ^  %%%
+            %%%           a1          a2 %%%
+          `,
+        );
         reporter.outputError(
           new ErrorWithLocation('some error', {
             fileName: '/prj/main.ts',
-            content: mark(
-              `
-          const query = invalidQuery;
-          %%%           ^           ^  %%%
-          %%%           a1          a2 %%%
-        `,
-              frets,
-            ),
+            content,
             start: frets.a1.pos,
             end: frets.a2.pos,
           }),
@@ -47,24 +46,23 @@ describe(ErrorReporter, () => {
       it('should output location of errors in human readable format with 2 lines', () => {
         let message: string = '';
         const reporter = new ErrorReporter('/prj', msg => (message = msg));
-        const frets: Frets = {};
+        const [content, frets] = extract(
+          `
+            const query = gql\`;
+              query MyQuery {
+            %%%     ^             %%%
+            %%%     a1            %%%
+                name
+            %%%     ^             %%%
+            %%%     a2            %%%
+              }
+            \`:
+          `,
+        );
         reporter.outputError(
           new ErrorWithLocation('some error', {
             fileName: '/prj/main.ts',
-            content: mark(
-              `
-          const query = gql\`;
-            query MyQuery {
-          %%%     ^             %%%
-          %%%     a1            %%%
-              name
-          %%%     ^             %%%
-          %%%     a2            %%%
-            }
-          \`:
-        `,
-              frets,
-            ),
+            content,
             start: frets.a1.pos,
             end: frets.a2.pos,
           }),
@@ -75,25 +73,24 @@ describe(ErrorReporter, () => {
       it('should output location of errors in human readable format with 3 or more lines', () => {
         let message: string = '';
         const reporter = new ErrorReporter('/prj', msg => (message = msg));
-        const frets: Frets = {};
+        const [content, frets] = extract(
+          `
+            const query = gql\`;
+              query MyQuery {
+            %%%     ^             %%%
+            %%%     a1            %%%
+                id
+                name
+            %%%     ^             %%%
+            %%%     a2            %%%
+              }
+            \`:
+          `,
+        );
         reporter.outputError(
           new ErrorWithLocation('some error', {
             fileName: '/prj/main.ts',
-            content: mark(
-              `
-          const query = gql\`;
-            query MyQuery {
-          %%%     ^             %%%
-          %%%     a1            %%%
-              id
-              name
-          %%%     ^             %%%
-          %%%     a2            %%%
-            }
-          \`:
-        `,
-              frets,
-            ),
+            content,
             start: frets.a1.pos,
             end: frets.a2.pos,
           }),

diff --git a/src/graphql-language-service-adapter/get-definition-and-bound-span.test.ts b/src/graphql-language-service-adapter/get-definition-and-bound-span.test.ts
@@ -1,5 +1,5 @@
 import ts from 'typescript';
-import { mark, type Frets } from 'fretted-strings';
+import extract from 'fretted-strings';
 import { AdapterFixture } from './testing/adapter-fixture';
 
 function createFixture(name: string) {
@@ -67,16 +67,15 @@ describe('getDefinitionAndBoundSpan', () => {
     },
   ])('should return no definition info for $name .', ({ source }) => {
     const fixture = createFixture('input.ts');
-    const frets: Frets = {};
-    fixture.source = mark(source, frets);
+    const [content, frets] = extract(source);
+    fixture.source = content;
     fixture.adapter.getDefinitionAndBoundSpan(delegateFn, 'input.ts', frets.s1.pos);
     expect(delegateFn).toHaveBeenCalledTimes(1);
   });
 
   it('should return definition info when cursor is on fragment spread', () => {
     const fixture = createFixture('input.ts');
-    const frets: Frets = {};
-    fixture.source = mark(
+    const [content, frets] = extract(
       `
         const query = \`
           query MyQuery {
@@ -92,8 +91,8 @@ describe('getDefinitionAndBoundSpan', () => {
           }
         \`;
       `,
-      frets,
     );
+    fixture.source = content;
     const actual = fixture.adapter.getDefinitionAndBoundSpan(delegateFn, 'input.ts', frets.s1.pos);
     expect(actual).toMatchObject({
       textSpan: {
@@ -114,15 +113,7 @@ describe('getDefinitionAndBoundSpan', () => {
 
   it('should return definition to other file', () => {
     const fixture = createFixture('input.ts');
-    const frets: Frets = {};
-    fixture.registerFragment(
-      'fragments.ts',
-      `
-        fragment MyFragment on Query {
-          __typename
-        }
-      `,
-    ).source = mark(
+    const [content, frets] = extract(
       `
         const query = \`
           query MyQuery {
@@ -132,8 +123,15 @@ describe('getDefinitionAndBoundSpan', () => {
           }
         \`;
       `,
-      frets,
     );
+    fixture.registerFragment(
+      'fragments.ts',
+      `
+        fragment MyFragment on Query {
+          __typename
+        }
+      `,
+    ).source = content;
     const actual = fixture.adapter.getDefinitionAndBoundSpan(delegateFn, 'input.ts', frets.s1.pos);
     expect(actual?.definitions?.[0].fileName).toBe('fragments.ts');
   });