add turbo, update dev:graphiql command (#3933)

* upd

* upd

* upd

Author: dimaMachina

.changeset/empty-dingos-suffer.md

@@ -0,0 +1,5 @@
+---
+'graphql-language-service-server': patch
+---
+
+remove unnecessary string conversion in `logger.info(String(error))`

.eslintrc.js

@@ -384,6 +384,7 @@ module.exports = {
         '@typescript-eslint/non-nullable-type-assertion-style': 'error',
         '@typescript-eslint/consistent-type-assertions': 'error',
         '@typescript-eslint/no-duplicate-type-constituents': 'error',
+        '@typescript-eslint/no-unnecessary-type-conversion': 'error',
         // TODO: Fix all errors for the following rules included in recommended config
         '@typescript-eslint/no-deprecated': 'off',
         '@typescript-eslint/no-unsafe-function-type': 'off',

DEVELOPMENT.md

@@ -1,4 +1,4 @@
-### Getting Started
+# Getting Started
 
 Please note that we require a signed GraphQL Specification Membership agreement
 before landing a contribution. This is checked automatically when you open a PR.
@@ -9,8 +9,9 @@ prompted by the EasyCLA bot. For more details, please see the
 0. First, you will need the latest `git`, `yarn` 1.16, & `node` 12 or greater.
    macOS, Windows and Linux should all be supported as build environments.
 
-_**Note:** None of the commands below will work with `npm`. Please use `yarn` in
-this repo._
+> [!WARNING]
+>
+> None of the commands below will work with `npm`. Please use `yarn` in this repo.
 
 1. Fork this repo by using the "Fork" button in the upper-right
 
@@ -29,35 +30,35 @@ this repo._
 4. Build all interdependencies so the project you are working on can resolve
    other packages
 
-   First you'll need —
+   First, you'll need:
 
    ```sh
    yarn build
    ```
 
-   — or —
+   or
 
    ```sh
    yarn build:watch
    ```
 
-   If you are focused on GraphiQL development, you can run —
+   If you are focused on GraphiQL development, you can run:
 
    ```sh
-   yarn dev-graphiql
+   yarn dev:graphiql
    ```
 
 5. Get coding! If you've added code, add tests. If you've changed APIs, update
    any relevant documentation or tests. Ensure your work is committed within a
    feature branch.
 
-6. Ensure all tests pass, and build everything
+6. Ensure all tests pass and build everything
 
    ```sh
    yarn test
    ```
 
-### Fix CI issues with linting
+## Fix CI issues with linting
 
 If you have `prettier` or `eslint --fix`-able issues you see in CI, use —
 
@@ -67,7 +68,7 @@ If you see `typescript` build issues, do a `yarn build` locally, and make sure
 the whole project references tree builds. Changing interfaces can end up
 breaking their implementations.
 
-### Run tests for GraphiQL:
+## Run tests for GraphiQL:
 
 - `yarn test graphiql` will run all tests for graphiql. You can also run tests
   from a workspace, but most tooling is at the root.
@@ -80,28 +81,30 @@ breaking their implementations.
 If you want these commands to watch for changes to dependent packages in the
 repo, then run `yarn build --watch` alongside either of these.
 
-### Developing for GraphiQL
+## Developing for GraphiQL
 
 If you want to develop just for graphiql, you won't need to execute commands
 from the package subdirectory at `packages/graphiql`.
 
 First, you'll need to `yarn build` all the packages from the root.
 
-Then, you can run these commands:
+Then, you can run `yarn dev:graphiql` command, which will launch `vite` dev server for GraphiQL.
 
-- `yarn dev-graphiql` — which will launch `webpack` dev server for graphiql
-  from the root
+```text
+VITE v6.3.4  ready in 1015 ms
 
-> The GraphiQL UI is available at http://localhost:8080/dev.html
+➜  Local:   http://localhost:5173/
+➜  Network: use --host to expose
+```
 
-### Developing Monaco GraphQL
+## Developing Monaco GraphQL
 
 1. First run `yarn`.
-2. run `yarn tsc --watch` to watch `monaco-graphql` and
+2. Run `yarn tsc --watch` to watch `monaco-graphql` and
    `graphql-language-service` in one screen session/terminal tab/etc
-3. in another session, run `yarn start-monaco` from anywhere in the repository
+3. In another session, run `yarn start-monaco` from anywhere in the repository
    aside from an individual workspace.
-4. alternatively to the webpack example, or in addition, you can run monaco or
+4. Alternatively to the webpack example, or in addition, you can run monaco or
    next.js examples, though these examples are simpler. They also require their
    own `yarn` or `npm install` as they are excluded from the `workspaces`
    resolved on global `yarn install`

package.json

@@ -14,6 +14,7 @@
   },
   "packageManager": "[email protected]",
   "scripts": {
+    "dev:graphiql": "turbo run dev --filter=graphiql...",
     "build": "yarn build-clean && yarn tsc && yarn build:nontsc",
     "build-bundles": "yarn prebuild-bundles && yarn wsrun:noexamples --stages build-bundles",
     "build-bundles-clean": "rimraf '{packages,examples}/**/{bundle,cdn,webpack}'",
@@ -28,7 +29,6 @@
     "watch-vscode-exec": "yarn workspace vscode-graphql-execution compile",
     "check": "yarn tsc --noEmit",
     "cypress-open": "yarn workspace graphiql cypress-open",
-    "dev-graphiql": "yarn workspace graphiql dev",
     "e2e": "yarn workspace graphiql e2e",
     "eslint": "NODE_OPTIONS=--max-old-space-size=4096 ESLINT_USE_FLAT_CONFIG=false eslint --max-warnings=0 --ignore-path .gitignore --cache .",
     "format": "yarn eslint --fix && yarn pretty",
@@ -86,8 +86,8 @@
     "@types/jest": "^29.5.2",
     "@types/node": "^16.18.4",
     "@types/ws": "8.2.2",
-    "@typescript-eslint/eslint-plugin": "^8.31.0",
-    "@typescript-eslint/parser": "^8.31.0",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
     "babel-jest": "^29.4.3",
     "babel-plugin-transform-import-meta": "^2.2.1",
     "concurrently": "^7.0.0",
@@ -119,7 +119,8 @@
     "typescript": "^4.6.3",
     "vitest": "^2.1.9",
     "wgutils": "^1.2.5",
-    "wsrun": "^5.2.4"
+    "wsrun": "^5.2.4",
+    "turbo": "^2.5.2"
   },
   "resolutions": {
     "@babel/traverse": "^7.23.2",

packages/graphiql-react/README.md

@@ -130,6 +130,6 @@ elements background.
 If you want to develop with `@graphiql/react` locally - in particular when
 working on the `graphiql` package - all you need to do is run `yarn dev` in the
 package folder in a separate terminal. This will build the package using Vite.
-When using it in combination with `yarn dev-graphiql` (running in the repo
+When using it in combination with `yarn dev:graphiql` (running in the repo
 root) this will give you auto-reloading when working on `graphiql` and
 `@graphiql/react` simultaneously.

packages/graphql-language-service-server/src/parsers/astro.ts

@@ -50,7 +50,7 @@ export const astroParser: SourceParser = async (text, uri, logger) => {
       `Could not parse the astro file at ${uri} to extract the graphql tags:`,
     );
     for (const error of parseAstroResult.errors) {
-      logger.info(String(error));
+      logger.info(error);
     }
     return null;
   }

packages/graphql-language-service/src/interface/__tests__/getAutocompleteSuggestions.test.ts

@@ -105,29 +105,32 @@ describe('getAutocompleteSuggestions', () => {
       .map(suggestion => {
         // TODO: A PR where we do `const { type, ..rest} = suggestion; return rest;`
         // and validate the entire completion object - kinds, documentation, etc
-        const response = { label: suggestion.label } as CompletionItem;
+        const response: CompletionItem = { label: suggestion.label };
         if (suggestion.detail) {
-          response.detail = String(suggestion.detail);
+          response.detail = suggestion.detail;
         }
-        if (suggestion.insertText && !options?.ignoreInsert) {
-          response.insertText = suggestion.insertText;
-        }
-        if (suggestion.insertTextFormat && !options?.ignoreInsert) {
-          response.insertTextFormat = suggestion.insertTextFormat;
-        }
-        if (suggestion.command && !options?.ignoreInsert) {
-          response.command = suggestion.command;
+        if (!options?.ignoreInsert) {
+          if (suggestion.insertText) {
+            response.insertText = suggestion.insertText;
+          }
+          if (suggestion.insertTextFormat) {
+            response.insertTextFormat = suggestion.insertTextFormat;
+          }
+          if (suggestion.command) {
+            response.command = suggestion.command;
+          }
+          if (suggestion.labelDetails) {
+            response.labelDetails = suggestion.labelDetails;
+          }
         }
         if (suggestion.documentation?.length) {
           response.documentation = suggestion.documentation;
         }
-        if (suggestion.labelDetails && !options?.ignoreInsert) {
-          response.labelDetails = suggestion.labelDetails;
-        }
 
         return response;
       });
   }
+
   describe('with Operation types', () => {
     const expectedDirectiveSuggestions = [
       { label: 'include', documentation: GraphQLIncludeDirective.description },

turbo.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalDependencies": ["yarn.lock", "resources/patches/*"],
+  "tasks": {
+    "build": {
+      "dependsOn": [
+        // Run `build` in workspaces I depend on first
+        "^build"
+      ],
+      // Cache all files emitted to the packages's directories
+      "outputs": ["dist/**"]
+    },
+    "dev": {
+      "dependsOn": [
+        // Run `build` in workspaces I depend on first
+        "^build"
+      ],
+      "cache": false
+    }
+  }
+}