cjoudrey/graphql-schema-linter

Add --fix option

Open

#23 opened on 2017年8月9日

GitHub で見る
 (24 comments) (2 reactions) (0 assignees)JavaScript (669 stars) (62 forks)batch import
enhancementhelp wanted

説明

In some error cases, the linter can programmatically know what the schema should have been.

It would be awesome to provide a --fix option that would automatically resolve these errors.

Some example rules that could be fixed by the linter this way:

  • EnumValuesAllCaps
  • EnumValuesSortedAlphabetically
  • FieldsAreCamelCased
  • InputObjectValuesAreCamelCased
  • TypesAreCapitalized

コントリビューターガイド

技術スタック
javascriptnodejs
領域
clideveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
GraphQL schema linter internalsunderstanding of lint rule structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
35
調査方針
First, examine the existing rule implementations to understand how errors are detected and reported. Look at the CLI entry point (likely in bin/ or src/cli.js) to see how options are parsed. Investigate the test suite for examples of rule testing. Then, propose a design for how the fix flag would integrate, perhaps by adding an optional fix method to each rule. Check if any existing PRs or comments discuss implementation details.