{"_id":"@apollographql/graphql-language-server","_rev":"20-aa8a824517d3992828b317db1ddf0d26","name":"@apollographql/graphql-language-server","dist-tags":{"latest":"1.3.2"},"versions":{"1.3.1":{"name":"@apollographql/graphql-language-server","version":"1.3.1","description":"An interface for building GraphQL language services for IDEs","scripts":{"test":"echo 'Please run `npm test` from the root of the repo' && exit 1"},"repository":{"type":"git","url":"git+https://github.com/graphql/graphql-language-service.git"},"keywords":["graphql"],"license":"ISC","bugs":{"url":"https://github.com/graphql/graphql-language-service/issues"},"homepage":"https://github.com/graphql/graphql-language-service#readme","dependencies":{"graphql-config":"2.0.1"},"publishConfig":{"access":"public"},"_id":"@apollographql/graphql-language-server@1.3.1","_npmVersion":"6.2.0","_nodeVersion":"10.7.0","_npmUser":{"name":"shadaj","email":"shadaj@meteor.com"},"dist":{"integrity":"sha512-S8IaVoAR72nSakW+FEVrAC4p/ZJHa3lz0E+TNlWUUDGsOugFU/vhh5mn9T449pKH08CIZ7xIyoTxTMrhFLoxCg==","shasum":"1e22c95e9c8798482a74460021458a27e4968e0d","tarball":"https://registry.npmjs.org/@apollographql/graphql-language-server/-/graphql-language-server-1.3.1.tgz","fileCount":1,"unpackedSize":696,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbW4peCRA9TVsSAnZWagAAHTkP/RPHQDlFMmpP9gEWdcYq\nfgqcSVbhM6Qy4FyrjICWRho4RFmcv1h5emVQ61PxRcVSzx2fcRjSovE8jPna\nw+QGOQVHhM5cpqzp5/v+mlsPhjkXH36LDu9mS5JKQCO8AzNKMNkNKwgfu5vU\nBzIEx4eikwQG/Rf+LBMIOERIGlAoQaLZ3r8BjSXlcTQo0/yuJwVhPNBi8HXm\nyNhRE1EAiISAE74pE4Y2iXhHkopHT6ajACCXGKmzBv5yfB/0jVLukHX3Z6fG\n2VNx6P37KOH6/78cNaxpe/9IBQYN+2wFnoaunLa9VlpE+oEgQfaPYL96hGK1\nTuyV+W5JUfWZTfZa8iOVwhRn2E3+VCjyzYupeUNjr9XE65J44pZ9K79AmgX6\nJXjUWGn0T5MCW7BDHd7emGEhcRs/T7ltDfX97tEyk+d8Gx44ufIKGJ9X73ht\nfld4rI0pxnEYWbrDAvwQx2eaphnpqbMHPDDM8mgojRFH/rE8TLUz7oyq1HmI\nQhwmk3rEHaEWkTViO3kOTspiCGfjOjsT3t54shGF2tsfPUEXj5z9dniPHuDW\n5L9d2EqQHqg2qmCZsY38RVzwS1NgctF+eknKtRpw6cx9X3lqGbWnTwn8ztC2\n1KlEe1E9GZHjt3biVR8PGfNAxqgWlxPLlYL5XTeqOfgSWfUD1EfMqROS/tLp\n1lPL\r\n=pqoL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDCHJJ5ricD3zEzzrd5K2n4Fv5hdzxemRJzQ6sn60uhQgIgfQsP9DIdV2CVr5V2Q0YYLYp7NT14AslIz3PXWjLtpsc="}]},"maintainers":[{"name":"evanshauser","email":"evanshauser@gmail.com"},{"name":"hwillson","email":"hugh@octonary.com"},{"name":"jbaxleyiii","email":"james@meteor.com"},{"name":"martijnwalraven","email":"martijn@martijnwalraven.com"},{"name":"mdg","email":"npm@meteor.com"},{"name":"sashko","email":"s.stubailo@gmail.com"},{"name":"shadaj","email":"shadaj@meteor.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphql-language-server_1.3.1_1532725854803_0.5260101164330504"},"_hasShrinkwrap":false},"1.3.2":{"name":"@apollographql/graphql-language-server","version":"1.3.2","description":"An interface for building GraphQL language services for IDEs","scripts":{"test":"echo 'Please run `npm test` from the root of the repo' && exit 1"},"repository":{"type":"git","url":"git+https://github.com/graphql/graphql-language-service.git"},"keywords":["graphql"],"license":"ISC","bugs":{"url":"https://github.com/graphql/graphql-language-service/issues"},"homepage":"https://github.com/graphql/graphql-language-service#readme","dependencies":{"graphql-config":"2.0.1"},"publishConfig":{"access":"public"},"_id":"@apollographql/graphql-language-server@1.3.2","_npmVersion":"6.2.0","_nodeVersion":"10.7.0","_npmUser":{"name":"shadaj","email":"shadaj@meteor.com"},"dist":{"integrity":"sha512-Cu6gdEvx+XUgfrT0T0VobxW8WI3rhBMV6C5/VDl+Tf5879K3JFNAaI7n8oxFiDy8wjbztJB1aFA+rQryMdZzOA==","shasum":"1e33a4510b2d3eef7469253c9d3572c138de56a9","tarball":"https://registry.npmjs.org/@apollographql/graphql-language-server/-/graphql-language-server-1.3.2.tgz","fileCount":1,"unpackedSize":696,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbW4wnCRA9TVsSAnZWagAANQgQAIe4EaWlTUTydX8Fgiq0\nW3mkhWl2DOoSRTiH5odCAY/I6aodFCZXfl3FN00yV8cZuijn8syESm3USSBe\n/rtbXqx0qf4Yy/6IDeCqFcXzsmj5oAJpvZrd6XifwcPwBnqEIhtD15lc1OKd\nyTn1LT7/cOokyxMkIBOSjnlNODZg+0ppCLLlAbJq5pfLwIYwIb8dcIBwhK+0\niVNH2BcbiH8arZFYnWkPK0kMqCsu3KMDv+YHm163+10afXw2yY1VWnnMwYM3\n6X1RabmUzHvSM9qVA3HUSPfpCFsH+eqoamTWOG/nXXSAIrVY/hFNd/NMqwzF\nCSD08FhN+lfv0805t0YP9WsKd3YCHE2F3fE00RkT9WzyvQbBRYfjimAtvd8a\nZvsJAK8CD0e8bKaDfaKYpEB/2VtsYnt3SGuzyVWR0Yo6MM0xjXSq9KX0yBzl\nn4Zd+2A8tbdJZPIgMHMupgCldeRw+aaL0PmCRhgir47FHQ3ZB/Nk2gCy5GgU\nC4jDWfrMeMKCjZillW1VyYQaDIdp/HtA5kFXMfdkHXeqEpkaT8DzURF1HgWQ\n+DLuOMwBwnZHyktpNncnhENrC+icQlsO0xNbuHd0XFQjWGZ9Yuh7H4f8MD26\nWLbLn9fZoSSjCfm09mFq8M1E2N0rGDxJjdqg4Nc/QRpZKTlaOUIi+J0N5+sY\n3nxn\r\n=D8pM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDgac/uvM05gc4O2ILGfdEIj5NPf7+z9srkidSSYdXabAIgREhfR5GZ8PUl1bT5cFLxoyWVwLzN2IVMZ7xUrGdi8IM="}]},"maintainers":[{"name":"evanshauser","email":"evanshauser@gmail.com"},{"name":"hwillson","email":"hugh@octonary.com"},{"name":"jbaxleyiii","email":"james@meteor.com"},{"name":"martijnwalraven","email":"martijn@martijnwalraven.com"},{"name":"mdg","email":"npm@meteor.com"},{"name":"sashko","email":"s.stubailo@gmail.com"},{"name":"shadaj","email":"shadaj@meteor.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphql-language-server_1.3.2_1532726311261_0.8873660663324048"},"_hasShrinkwrap":false}},"time":{"created":"2018-07-27T21:10:54.756Z","1.3.1":"2018-07-27T21:10:54.852Z","modified":"2022-10-21T19:09:06.413Z","1.3.2":"2018-07-27T21:18:31.639Z"},"maintainers":[],"description":"An interface for building GraphQL language services for IDEs","homepage":"https://github.com/graphql/graphql-language-service#readme","keywords":["graphql"],"repository":{"type":"git","url":"git+https://github.com/graphql/graphql-language-service.git"},"bugs":{"url":"https://github.com/graphql/graphql-language-service/issues"},"license":"ISC","readme":"# GraphQL Language Service\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/graphql/graphql-language-service.svg)](https://greenkeeper.io/)\n\n_This is currently in technical preview. We welcome your feedback and suggestions._\n\n[![Build Status](https://travis-ci.org/graphql/graphql-language-service.svg?branch=master)](https://travis-ci.org/graphql/graphql-language-service)\n\nGraphQL Language Service provides an interface for building GraphQL language services for IDEs.\n\nPartial support for [Microsoft's Language Server Protocol](https://github.com/Microsoft/language-server-protocol) is in place, with more to come in the future.\n\nCurrently supported features include:\n- Diagnostics (GraphQL syntax linting/validations) (**spec-compliant**)\n- Autocomplete suggestions (**spec-compliant**)\n- Hyperlink to fragment definitions and named types (type, input, enum) definitions (**spec-compliant**)\n- Outline view support for queries\n\n\n## Installation and Usage\n\n### Dependencies\n\nGraphQL Language Service depends on [Watchman](https://facebook.github.io/watchman/) running on your machine. Follow [this installation guide](https://facebook.github.io/watchman/docs/install.html) to install Watchman.\n\n### Installation\n\n```\ngit clone git@github.com:graphql/graphql-language-service.git\ncd {path/to/your/repo}\nnpm install ../graphql-language-service\n```\n\nAfter pulling the latest changes from this repo, be sure to run `npm run build` to transform the `src/` directory and generate the `dist/` directory.\n\nThe library includes a node executable file which you can find in `./node_modules/.bin/graphql.js` after installation.\n\n### GraphQL configuration file (`.graphqlconfig`)\n\nCheck out [graphql-config](https://github.com/graphcool/graphql-config)\n\n### Using the command-line interface\n\nThe node executable contains several commands: `server` and a command-line language service methods (`lint`, `autocomplete`, `outline`).\n\nImproving this list is a work-in-progress.\n\n```\nGraphQL Language Service Command-Line Interface.\nUsage: bin/graphql.js <command> <file>\n    [-h | --help]\n    [-c | --configDir] {configDir}\n    [-t | --text] {textBuffer}\n    [-f | --file] {filePath}\n    [-s | --schema] {schemaPath}\n\n\nOptions:\n  -h, --help        Show help                                          [boolean]\n  -t, --text        Text buffer to perform GraphQL diagnostics on.\n                    Will defer to --file option if omitted.\n                    Overrides the --file option, if any.\n                                                                        [string]\n  -f, --file        File path to perform GraphQL diagnostics on.\n                    Will be ignored if --text option is supplied.\n                                                                        [string]\n  --row             A row number from the cursor location for GraphQL\n                    autocomplete suggestions.\n                    If omitted, the last row number will be used.\n                                                                        [number]\n  --column          A column number from the cursor location for GraphQL\n                    autocomplete suggestions.\n                    If omitted, the last column number will be used.\n                                                                        [number]\n  -c, --configDir   Path to the .graphqlrc configuration file.\n                    Walks up the directory tree from the provided config\n                    directory, or the current working directory, until a\n                    .graphqlrc is found or the root directory is found.\n                                                                        [string]\n  -s, --schemaPath  a path to schema DSL file\n                                                                        [string]\n\nAt least one command is required.\nCommands: \"server, validate, autocomplete, outline\"\n```\n\n## Architectural Overview\n\nGraphQL Language Service currently communicates via Stream transport with the IDE server. GraphQL server will receive/send RPC messages to perform language service features, while caching the necessary GraphQL artifacts such as fragment definitions, GraphQL schemas etc. More about the server interface and RPC message format below.\n\nThe IDE server should launch a separate GraphQL server with its own child process for each `.graphqlconfig` file the IDE finds (using the nearest ancestor directory relative to the file currently being edited):\n```\n./application\n\n  ./productA\n    .graphqlconfig\n    ProductAQuery.graphql\n    ProductASchema.graphql\n\n  ./productB\n    .graphqlconfig\n    ProductBQuery.graphql\n    ProductBSchema.graphql\n```\nA separate GraphQL server should be instantiated for `ProductA` and `ProductB`, each with its own `.graphqlconfig` file, as illustrated in the directory structure above.\n\nThe IDE server should manage the lifecycle of the GraphQL server. Ideally, the IDE server should spawn a child process for each of the GraphQL Language Service processes necessary, and gracefully exit the processes as the IDE closes. In case of errors or a sudden halt the GraphQL Language Service will close as the stream from the IDE closes.\n\n### Server Interface\n\nGraphQL Language Server uses [JSON-RPC](http://www.jsonrpc.org/specification) to communicate with the IDE servers. Microsoft's language server currently supports two communication transports: Stream (stdio) and IPC. For IPC transport, the reference guide to be used for development is [the language server protocol](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md) documentation.\n\nFor each transport, there is a slight difference in JSON message format, especially in how the methods to be invoked are defined - below are the currently supported methods for each transport (will be updated as progress is made):\n\n|                     | Stream                       | IPC                               |\n| -------------------:|------------------------------|-----------------------------------|\n| Diagnostics         | `getDiagnostics`             | `textDocument/publishDiagnostics` |\n| Autocompletion      | `getAutocompleteSuggestions` | `textDocument/completion`         |\n| Outline             | `getOutline`                 | Not supported yet                 |\n| Go-to definition    | `getDefinition`              | Not supported yet                 |\n| File Events         | Not supported yet            | `didOpen/didClose/didSave/didChange` events |\n","readmeFilename":"README.md"}