Add `implementedBy` field in `metadata.yml`

オープン
#23 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
graphql
領域
documentation

調査の方向性

metadata.yml、提案されている4つのimplementedBy表現、およびリンクされたプロジェクト定義リストから始めます。名前付きプロジェクトと任意のプラグインのサポートを比較し、選択したスキーマと想定されるメタデータの形式を確認します。フォーマットが決定され、一貫して文書化された時点で作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

@PascalSenn suggested at today's wg meeting that GAPs should list (in metadata.yml) what servers/clients implement the spec, so users can decide which spec to use.

Option 1 - text only

implementedBy:
  - "Apollo Client >= v1.2.3"
  - "Relay >= v3.4.5"

Option 2 - markdown links

implementedBy:
  - [Apollo Client >= v1.2.3](https://www.apollographql.com/docs/react)
  - [Relay >= v3.4.5](https://github.com/facebook/relay)

Option 3 - structured data

implementedBy:
  - name: Apollo Client
    website: https://www.apollographql.com/docs/react
    version: 1.2.3
  - name: Relay
    website: https://www.apollographql.com/docs/react
    version: 3.4.5

Option 4 - project definition keys + structured data

implementedBy:
  - project: apollo-client
    version: 1.2.3
  - project: relay
    version: 3.4.5

...which refers to some central projects.yml that looks like this:

- id: apollo-client
  website: https://www.apollographql.com/docs/react
- id: relay
  website: https://github.com/facebook/relay

Maybe this can reuse the definitions list here https://caniuse.graphql.now/index.html#projects

Note: I'd also like to support arbitrary projects here too, since support might initially be implemented as random a plugin (e.g. the @mock spec is currently implemented in apollo-client-mock-directive-plugin, not apollo core. I would expect many specs might start out this way.

So that implies something like this:

implementedBy:
  - project: relay
    version: 3.4.5
  - name: apollo-client-mock-directive-plugin
    website: https://github.com/magicmark/apollo-client-mock-directive-plugin/
    version: 0.0.1

my vote is Option 4.

主要言語
JavaScript
スター
10
フォーク
8
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

graphql/gaps のほかの issue

graphql/gaps の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。