graphql / graphql/graphiql

Outdated instructions on how to start graphql-language-service-server

Open
#1,645 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
16.9k
Forks
1.9k
Avg merge
22h 45m
Merged PRs (30d)
70

Description

[Server readme](https://github.com/graphql/graphiql/blob/2de91ba08920927624ec6f6c8d86b6abc46b6d26/packages/graphql-language-service-server/README.md) includes note about using `graphql` "binary" to start it:

> The library includes a node executable file which you can find in ./node_modules/.bin/graphql.js after installation.

But that binary is deprecated and refers user to `graphql-language-service-cli` instead. [Here is the source of the script](https://github.com/graphql/graphiql/blob/2de91ba08920927624ec6f6c8d86b6abc46b6d26/packages/graphql-language-service/src/temp-bin.ts).

So it's the [graphql-language-service-cli script](https://github.com/graphql/graphiql/blob/2de91ba08920927624ec6f6c8d86b6abc46b6d26/packages/graphql-language-service-cli/bin/graphql.js) that can be used to start the server now. Also, the `cli` includes the server as dependency so no need to install server dependency separately.

I think this all should be clarified in the server's readme. It could just say that to start the server in standalone mode, one should use `graphql-language-service-cli` instead.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.