Skip to content

Commit 74aac2c

Browse files
committed
clean up repository references, more readmes and links
the absolute links are for npm and other repo mirrors of course can't wait to improve our typedoc output and use it in a proper docs website soon! the gatsby docs site experiment I did about 2 years ago is a good starting point, the branch is somewhere, but there are many approaches we can look at. graphql dot org uses gatsby so I figured so should we.
1 parent 7334a37 commit 74aac2c

File tree

12 files changed

+53
-23
lines changed

12 files changed

+53
-23
lines changed

packages/codemirror-graphql/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
"Angel Gomez Salazar <[email protected]>"
99
],
1010
"homepage": "https://github.com/graphql/graphiql/tree/main/packages/codemirror-graphql#readme",
11-
"repository": "https://github.com/graphql/graphiql",
11+
"repository": {
12+
"type": "git",
13+
"url": "http://github.com/graphql/graphiql",
14+
"directory": "packages/codemirror-graphql"
15+
},
1216
"bugs": {
1317
"url": "https://github.com/graphql/graphiql/issues?q=issue+label:codemirror-graphql"
1418
},

packages/graphiql-react/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/graphiql-react/CHANGELOG.md) | [API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphiql_react.html) | [NPM](https://www.npmjs.com/package/@graphiql/react)
2+
3+
A react SDK for building graphql developer experiences for the web
4+
5+
Used by `graphiql@2` and beyond!
6+
7+
(docs coming soon!)

packages/graphiql-react/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@
1414
"main": "dist/graphiql-react.cjs.js",
1515
"module": "dist/graphiql-react.es.js",
1616
"types": "types/index.d.ts",
17+
"keywords": [
18+
"react",
19+
"graphql",
20+
"sdk",
21+
"codemirror"
22+
],
1723
"files": [
1824
"dist",
1925
"src",

packages/graphiql-toolkit/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Discord Channel](https://discord.gg/NP5vbPeUFp)
1+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/graphql-toolkit/CHANGELOG.md) | [API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphiql_toolkit.html) | [NPM](https://www.npmjs.com/package/@graphiql/toolkit) | [Discord](https://discord.gg/NP5vbPeUFp)
22

33
# `@graphiql/toolkit`
44

packages/graphiql/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
"Hyohyeon Jeong <[email protected]>",
77
"Lee Byron <[email protected]> (http://leebyron.com/)"
88
],
9-
"repository": "http://github.com/graphql/graphiql",
9+
"repository": {
10+
"type": "git",
11+
"url": "http://github.com/graphql/graphiql",
12+
"directory": "packages/graphiql"
13+
},
1014
"homepage": "http://github.com/graphql/graphiql/tree/master/packages/graphiql#readme",
1115
"bugs": {
1216
"url": "https://github.com/graphql/graphiql/issues?q=issue+label:graphiql"

packages/graphql-language-service-cli/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
"Hyohyeon Jeong <[email protected]>",
77
"Lee Byron <[email protected]> (http://leebyron.com/)"
88
],
9-
"repository": "http://github.com/graphql/graphiql",
9+
"repository": {
10+
"type": "git",
11+
"url": "http://github.com/graphql/graphiql",
12+
"directory": "packages/graphql-language-service-cli"
13+
},
1014
"homepage": "https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-cli#readme",
1115
"bugs": {
1216
"url": "https://github.com/graphql/graphiql/issues?q=issue+label:language-service-cli"

packages/graphql-language-service-server/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
![npm downloads](https://img.shields.io/npm/dm/graphql-language-service-server?label=npm%20downloads)
55
[![License](https://img.shields.io/npm/l/graphql-language-service-server.svg?style=flat-square)](LICENSE)
66

7-
[API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphql_language_service_server.html)
7+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/graphql-language-service-server/CHANGELOG.md) |
8+
[API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphql_language_service_server.html) |
89
[Discord Channel](https://discord.gg/PXaRYrpgK4)
910

1011
Server process backing the [GraphQL Language Service](https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service).

packages/graphql-language-service-server/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77
"Hyohyeon Jeong <[email protected]>",
88
"Lee Byron <[email protected]> (http://leebyron.com/)"
99
],
10-
"repository": "http://github.com/graphql/graphiql",
10+
"repository": {
11+
"type": "git",
12+
"url": "http://github.com/graphql/graphiql",
13+
"directory": "packages/graphql-language-service-server"
14+
},
1115
"homepage": "https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service-server#readme",
1216
"bugs": {
1317
"url": "https://github.com/graphql/graphiql/issues?q=issue+label:language-server"

packages/graphql-language-service/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `graphql-language-service`
22

3-
[API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphql_language_service.html)
4-
[Discord Channel](https://discord.gg/wkQCKwazxj)
3+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/graphql-language-service/CHANGELOG.md) | [API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphql_language_service.html) |
4+
[Discord](https://discord.gg/wkQCKwazxj)
55

66
> **Note**: Still mostly experimental, however it depends mostly on stable libraries.
77
> **Migration Note**: As of 3.0.0, the LSP Server command line interface has been moved to [`graphql-language-service-cli`](../graphql-language-service-cli)

packages/graphql-language-service/package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
"contributors": [
66
"GraphQL Contributors"
77
],
8-
"repository": "http://github.com/graphql/graphiql",
8+
"repository": {
9+
"type": "git",
10+
"url": "http://github.com/graphql/graphiql",
11+
"directory": "packages/graphql-language-service"
12+
},
913
"homepage": "https://github.com/graphql/graphiql/tree/main/packages/graphql-language-service#readme",
1014
"bugs": {
1115
"url": "https://github.com/graphql/graphiql/issues?q=issue+label:languageservice"

packages/monaco-graphql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/monaco-graphql/CHANGELOG.md) |
2+
[API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphql_language_service_server.html) |
13
[Discord Channel](https://discord.gg/r4BxrAG6fN)
24

3-
# Monaco GraphQL
4-
55
GraphQL language plugin for the Monaco Editor. You can use it to build vscode/codespaces-like web or desktop IDEs using whatever frontend javascript libraries or frameworks you want, or none!
66

77
- [webpack example](https://github.com/graphql/graphiql/tree/main/examples/monaco-graphql-webpack/) using plain javascript, shows how to change schemas

packages/vscode-graphql/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
# VSCode GraphQL
1+
[Changelog](https://github.com/graphql/graphiql/blob/main/packages/vscode-graphql/CHANGELOG.md) | [Discord Channel](https://discord.gg/r4BxrAG6fN) | [LSP Server Docs](<[https://g](https://github.com/graphql/graphiql/blob/main/packages/graphql-language-service-server/README.md)>)
22

33
GraphQL extension VSCode built with the aim to tightly integrate the GraphQL Ecosystem with VSCode for an awesome developer experience.
44

55
![](https://camo.githubusercontent.com/97dc1080d5e6883c4eec3eaa6b7d0f29802e6b4b/687474703a2f2f672e7265636f726469742e636f2f497379504655484e5a342e676966)
66

7-
> _Operation Execution will be available in a new extension_
8-
9-
## Features
10-
11-
Lots of new improvements happening! We now have a [`CHANGELOG.md`](https://github.com/graphql/graphiql/blob/main/packages/vscode-graphql/CHANGELOG.md#change-log)
12-
137
### General features
148

9+
> _Operation Execution will be re-introduced in a new extension_
10+
1511
- Load the extension on detecting `graphql-config file` at root level or in a parent level directory
1612
- Load the extension in `.graphql`, `.gql files`
1713
- Load the extension on detecting `gql` tag in js, ts, jsx, tsx, vue files
@@ -121,6 +117,8 @@ Notice that `documents` key supports glob pattern and hence `["**/*.graphql"]` i
121117

122118
### I can't load `.graphqlconfig` files anymore
123119

120+
> Note: this option has been set to be enabled by default, however `graphql-config` maintainers do not want to continue to support the legacy format (mostly kept for companies where intellij users are stuck on the old config format), so please migrate to the new `graphql-config` format as soon as possible!
121+
124122
If you need to use a legacy config file, then you just need to enable legacy mode for `graphql-config`:
125123

126124
```json
@@ -255,14 +253,12 @@ Thanks to apollo for their [graphql-vscode grammars](https://github.com/apollogr
255253

256254
This plugin uses the [GraphQL language server](https://github.com/graphql/graphql-language-service-server)
257255

258-
1. Clone the repository - https://github.com/graphql/vscode-graphql
259-
1. `npm install`
260-
1. Open it in VSCode
261-
1. Go to the debugging section and run the launch program "Extension"
256+
1. Clone the repository - https://github.com/graphql/graphiql
257+
1. `yarn`
258+
1. Run "VScode Extension" launcher in vscode
262259
1. This will open another VSCode instance with extension enabled
263260
1. Open a project with a graphql config file - ":electric_plug: graphql" in VSCode status bar indicates that the extension is in use
264261
1. Logs for GraphQL language service will appear in output section under GraphQL Language Service
265-
![GraphQL Language Service Logging](https://s3-ap-southeast-1.amazonaws.com/divyendusingh/vscode-graphql/Screen+Shot+2018-06-25+at+12.31.57+PM.png)
266262

267263
### Contributing back to this project
268264

0 commit comments

Comments
 (0)