Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruanyl/coc-apollo
coc.nvim extension for GraphQL/Apollo GraphQL
https://github.com/ruanyl/coc-apollo
apollo-schema-registry apollographql coc-apollo graphql graphql-language-server neovim nvim-extension plugin vim
Last synced: 2 months ago
JSON representation
coc.nvim extension for GraphQL/Apollo GraphQL
- Host: GitHub
- URL: https://github.com/ruanyl/coc-apollo
- Owner: ruanyl
- License: mit
- Created: 2019-10-13T20:11:14.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T01:25:44.000Z (over 1 year ago)
- Last Synced: 2024-04-15T02:04:49.708Z (9 months ago)
- Topics: apollo-schema-registry, apollographql, coc-apollo, graphql, graphql-language-server, neovim, nvim-extension, plugin, vim
- Language: TypeScript
- Homepage:
- Size: 683 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-apollo (WIP)
coc.nvim extension for Apollo GraphQL. Still work in progress, feedbacks and PRs are welcome.
## Install
`:CocInstall coc-apollo`
## Features
### Client Project
1. [GraphQL Language Server](https://github.com/graphql/graphiql/blob/main/packages/graphql-language-service-server/README.md): autocomplete, diagnostics...
2. Apollo GraphQL integration (Use the Apollo schema registry)
- Graph variants switching
- Performance stats (require `virtual text`)
3. Support loading schema from a remote endpoint, [example config](https://www.apollographql.com/docs/devtools/apollo-config/#option-2-link-a-schema-from-a-remote-endpoint)
4. Support loading schema from local: [example config](https://www.apollographql.com/docs/devtools/apollo-config/#option-3-link-a-schema-from-a-local-file)
### Service project
TODO...
## Setup
1. Add `APOLLO_KEY` to `.env`
2. Add [graphql-config](https://github.com/kamilkisiela/graphql-config) for graphql language server
3. (Optional) Add `apollo.config.json` or `apollo.config.js`, [config details](https://www.apollographql.com/docs/devtools/apollo-config/)
4. (Optional) Use [vim-graphql](https://github.com/jparise/vim-graphql) for syntax highlighting
## Configure graphql.config.json
The plugin will download schema from Apollo Schema Registry/local schema/remote schema, it generates `schema.graphql` file by default. So you have to specify `"schema": "schema.graphql"` in the config in order for language server to read.
Example `graphql.config.json`
```json
{
"schema": "schema.graphql"
}
```
You can also customize the exported schema filename and type with `:CocConfig`
```
{
"apollo.schema.filename": "schema.json"
}
```
This will output the file in json format by converting the schema to schema introspection
## Configurations
`apollo.defaultVariant` the default apollo graph variant to download when the plugin been initially loaded, default: current
## Setup status line
```vimscript
function! LightlineCocApolloStatus() abort
let status = get(g:, 'coc_apollo_current_variant', '')
if empty(status)
return ''
endif
return '🚀 ' . status
endfunction
let g:lightline = {
\ 'active': {
\ 'left': [
\ [ 'mode', 'paste' ],
\ [ 'readonly', 'filename' ]
\ ],
\ 'right':[
\ [ 'filetype', 'lineinfo', 'percent', 'cocstatus' ],
\ [ 'cocapollo' ]
\ ],
\ },
\ 'component_function': {
\ 'cocapollo': 'LightlineCocApolloStatus'
\ }
\ }
```
## Lists
Show variant list:
```
:CocList variants
```
## Commands
Reload Apollo graphql schema variant list
```
:CocCommand apollo.reload.variants
```
Reload Apollo field stats
```
:CocCommand apollo.reload.stats
```
## License
MIT
---
> This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)