go>> craftql>> 返回
项目作者： yamafaktory

项目描述 ：
A CLI tool to visualize GraphQL schemas and to output a graph data structure as a graphviz .dot format
高级语言： Rust
项目地址: git://github.com/yamafaktory/craftql.git
创建时间： 2020-08-08T15:14:25Z
项目社区：https://github.com/yamafaktory/craftql
开源协议：MIT License
下载


CraftQL

GitHub Workflow Status Crates.io

A CLI tool to visualize GraphQL schemas and to output a graph data structure as a graphviz .dot format

Installation

  1. cargo install craftql

Usage

  1. USAGE:
  2.     craftql [FLAGS] [OPTIONS] <path>
  4. ARGS:
  5.     <path>
  6.             Path to get files from
  8. FLAGS:
  9.     -h, --help
  10.             Prints help information
  12.     -m, --missing-definitions
  13.             Finds and displays missing definition(s)
  15.     -O, --orphans
  16.             Finds and displays orphan(s) node(s)
  18.     -V, --version
  19.             Prints version information
  22. OPTIONS:
  23.     -f, --filter <filter>...
  24.             Filter nodes by GraphQL type(s)
  26.             - directive
  27.             - enum
  28.             - enum_extension
  29.             - input_object
  30.             - input_object_extension
  31.             - interface
  32.             - interface_extension
  33.             - object
  34.             - object_extension
  35.             - scalar
  36.             - scalar_extension
  37.             - schema
  38.             - union
  39.             - union_extension
  40.     -i, --incoming-dependencies <incoming-dependencies>
  41.             Finds and displays incoming dependencies of a node
  43.     -n, --node <node>
  44.             Finds and displays one node
  46.     -N, --nodes <nodes>...
  47.             Finds and displays multiple nodes
  49.     -o, --outgoing-dependencies <outgoing-dependencies>
  50.             Finds and displays outgoing dependencies of a node

Output a graphviz .dot format

  1. craftql tests/fixtures
  3. digraph {
  4.     0 [ label = "DateTime (Scalar)" ]
  5.     1 [ label = "Character (Interface extension)\l\l[Boolean, Character]" ]
  6.     2 [ label = "Human (Object)\l\l[Character, Episode, Float, FriendsConnection, ID, Int, LengthUnit, Starship, String]" ]
  7.     3 [ label = "Droid (Object)\l\l[Character, Episode, FriendsConnection, ID, Int, String]" ]
  8.     4 [ label = "FriendsConnection (Object)\l\l[Character, FriendsEdge, Int, PageInfo]" ]
  9.     5 [ label = "FriendsEdge (Object)\l\l[Character, ID]" ]
  10.     6 [ label = "PageInfo (Object)\l\l[Boolean, ID, test]" ]
  11.     7 [ label = "Review (Object)\l\l[DateTime, Episode, Int, String, test]" ]
  12.     8 [ label = "Orphan (Object)\l\l[ID]" ]
  13.     9 [ label = "ColorInput (InputObject extension)\l\l[ColorInput, Int]" ]
  14.     10 [ label = "Episode (Enum extension)\l\l[Episode]" ]
  15.     11 [ label = "deprecated (Directive)\l\l[String]" ]
  16.     12 [ label = "DateTime (Scalar extension)\l\l[DateTime, test]" ]
  17.     13 [ label = "SearchResult (Union extension)\l\l[Ewok, SearchResult]" ]
  18.     14 [ label = "test (Directive)\l\l[Letter]" ]
  19.     15 [ label = "Episode (Enum)\l\l[deprecated, test]" ]
  20.     16 [ label = "LengthUnit (Enum)" ]
  21.     17 [ label = "Starship (Object extension)\l\l[Boolean, Starship]" ]
  22.     18 [ label = "Query (Object)\l\l[Character, Droid, Episode, Human, ID, Review, SearchResult, Starship, String]" ]
  23.     19 [ label = "Mutation (Object)\l\l[Episode, Review, ReviewInput]" ]
  24.     20 [ label = "Subscription (Object)\l\l[Episode, Review]" ]
  25.     21 [ label = "schema (Schema)\l\l[Mutation, Query, Subscription]" ]
  26.     22 [ label = "ReviewInput (InputObject)\l\l[ColorInput, Int, ReviewInput, String]" ]
  27.     23 [ label = "ColorInput (InputObject)\l\l[ColorInput, deprecated, Int, test]" ]
  28.     24 [ label = "Letter (Enum)" ]
  29.     25 [ label = "Starship (Object)\l\l[deprecated, Float, ID, LengthUnit, String]" ]
  30.     26 [ label = "Character (Interface)\l\l[Bool, Character, deprecated, Episode, FriendsConnection, ID, Int, String, test]" ]
  31.     27 [ label = "SearchResult (Union)\l\l[Droid, Human, Starship, test]" ]
  32.     13 -> 27 [ ]
  33.     14 -> 6 [ ]
  34.     26 -> 4 [ ]
  35.     5 -> 4 [ ]
  36.     6 -> 4 [ ]
  37.     11 -> 25 [ ]
  38.     16 -> 25 [ ]
  39.     26 -> 26 [ ]
  40.     11 -> 26 [ ]
  41.     15 -> 26 [ ]
  42.     4 -> 26 [ ]
  43.     14 -> 26 [ ]
  44.     26 -> 3 [ ]
  45.     15 -> 3 [ ]
  46.     4 -> 3 [ ]
  47.     17 -> 25 [ ]
  48.     15 -> 20 [ ]
  49.     7 -> 20 [ ]
  50.     19 -> 21 [ ]
  51.     18 -> 21 [ ]
  52.     20 -> 21 [ ]
  53.     9 -> 23 [ ]
  54.     26 -> 18 [ ]
  55.     3 -> 18 [ ]
  56.     15 -> 18 [ ]
  57.     2 -> 18 [ ]
  58.     7 -> 18 [ ]
  59.     27 -> 18 [ ]
  60.     25 -> 18 [ ]
  61.     26 -> 2 [ ]
  62.     15 -> 2 [ ]
  63.     4 -> 2 [ ]
  64.     16 -> 2 [ ]
  65.     25 -> 2 [ ]
  66.     1 -> 26 [ ]
  67.     15 -> 19 [ ]
  68.     7 -> 19 [ ]
  69.     22 -> 19 [ ]
  70.     23 -> 22 [ ]
  71.     22 -> 22 [ ]
  72.     23 -> 23 [ ]
  73.     11 -> 23 [ ]
  74.     14 -> 23 [ ]
  75.     24 -> 14 [ ]
  76.     12 -> 0 [ ]
  77.     12 -> 14 [ ]
  78.     11 -> 15 [ ]
  79.     14 -> 15 [ ]
  80.     10 -> 15 [ ]
  81.     0 -> 7 [ ]
  82.     15 -> 7 [ ]
  83.     14 -> 7 [ ]
  84.     26 -> 5 [ ]
  85.     3 -> 27 [ ]
  86.     2 -> 27 [ ]
  87.     25 -> 27 [ ]
  88.     14 -> 27 [ ]
  89. }

graph

Filter nodes by GraphQL types(s)

  1. craftql tests/fixtures --filter object object_extension
  3. digraph {
  4.     0 [ label = "Orphan (Object)\l\l[ID]" ]
  5.     1 [ label = "Human (Object)\l\l[Character, Episode, Float, FriendsConnection, ID, Int, LengthUnit, Starship, String]" ]
  6.     2 [ label = "Droid (Object)\l\l[Character, Episode, FriendsConnection, ID, Int, String]" ]
  7.     3 [ label = "FriendsConnection (Object)\l\l[Character, FriendsEdge, Int, PageInfo]" ]
  8.     4 [ label = "FriendsEdge (Object)\l\l[Character, ID]" ]
  9.     5 [ label = "PageInfo (Object)\l\l[@test, Boolean, ID]" ]
  10.     6 [ label = "Review (Object)\l\l[@test, DateTime, Episode, Int, String]" ]
  11.     7 [ label = "Query (Object)\l\l[Character, Droid, Episode, Human, ID, Review, SearchResult, Starship, String]" ]
  12.     8 [ label = "Mutation (Object)\l\l[Episode, Review, ReviewInput]" ]
  13.     9 [ label = "Subscription (Object)\l\l[Episode, Review]" ]
  14.     10 [ label = "Starship (Object extension)\l\l[Boolean, Starship]" ]
  15.     11 [ label = "Starship (Object)\l\l[@deprecated, Float, ID, LengthUnit, String]" ]
  16.     4 -> 3 [ ]
  17.     5 -> 3 [ ]
  18.     10 -> 11 [ ]
  19.     2 -> 7 [ ]
  20.     1 -> 7 [ ]
  21.     6 -> 7 [ ]
  22.     11 -> 7 [ ]
  23.     6 -> 9 [ ]
  24.     3 -> 2 [ ]
  25.     6 -> 8 [ ]
  26.     3 -> 1 [ ]
  27.     11 -> 1 [ ]
  28. }

Find and display one node

  1. craftql tests/fixtures --node Character
  3. # tests/fixtures/Types/Interfaces/Character.graphql
  4. interface Character @test {
  5.   id: ID!
  6.   name: String!
  7.   friends: [Character]
  8.   friendsConnection(first: Int, after: ID): FriendsConnection!
  9.   appearsIn: [Episode]!
  10.   cute: Bool! @deprecated
  11. }

Find and display multiple nodes

  1. craftql tests/fixtures --nodes Character Episode
  3. # tests/fixtures/Types/Interfaces/Character.graphql
  4. interface Character @test {
  5.   id: ID!
  6.   name: String!
  7.   friends: [Character]
  8.   friendsConnection(first: Int, after: ID): FriendsConnection!
  9.   appearsIn: [Episode]!
  10.   cute: Bool! @deprecated
  11. }
  14. # tests/fixtures/Types/Enums/Episode.gql
  15. enum Episode @test(letter: B) {
  16.   NEWHOPE @deprecated
  17.   EMPIRE
  18.   JEDI
  19. }

Find and display orphan(s) node(s)

  1. craftql tests/fixtures --orphans
  3. # tests/fixtures/Types/Types/orphan.gql
  4. type Orphan {
  5.   id: ID!
  6. }

Find and display incoming dependencies of a node

  1. craftql tests/fixtures --incoming-dependencies Starship
  3. # tests/fixtures/Types/Types/extension.graphql
  4. extend type Starship {
  5.   antiGravity: Boolean!
  6. }
  9. # tests/fixtures/Types/Enums/LengthUnit.graphql
  10. enum LengthUnit {
  11.   METER
  12.   FOOT
  13. }
  16. # tests/fixtures/Directives/deprecated.graphql
  17. directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ENUM_VALUE

Find and display outgoing dependencies of a node

  1. craftql tests/fixtures --outgoing-dependencies Starship
  3. # tests/fixtures/Types/Types/b.graphql
  4. type Human implements Character {
  5.   id: ID!
  6.   name: String!
  7.   homePlanet: String
  8.   height(unit: LengthUnit = METER): Float
  9.   mass: Float
  10.   friends: [Character]
  11.   friendsConnection(first: Int, after: ID): FriendsConnection!
  12.   appearsIn: [Episode]!
  13.   starships: [Starship]
  14. }
  17. # tests/fixtures/Types/Unions/SearchResults.graphql
  18. union SearchResult @test = Human | Droid | Starship
  21. # tests/fixtures/Types/Types/a.gql
  22. type Query {
  23.   hero(episode: Episode): Character
  24.   reviews(episode: Episode!): [Review]
  25.   search(text: String): [SearchResult]
  26.   character(id: ID!): Character
  27.   droid(id: ID!): Droid
  28.   human(id: ID!): Human
  29.   starship(id: ID!): Starship
  30. }

Find and display missing definition(s)

  1. craftql tests/fixtures --orphans
  3. # Color is not defined in:
  4. # tests/fixtures/Types/Interfaces/Character.graphql
  5. interface Character @test {
  6.   id: ID!
  7.   name: String!
  8.   friends: [Character]
  9.   friendsConnection(first: Int, after: ID): FriendsConnection!
  10.   appearsIn: [Episode]!
  11.   cute: Boolean! @deprecated
  12.   preferedColor: Color
  13. }
  16. # Ewok, Gungan are not defined in:
  17. # tests/fixtures/Types/Unions/SearchResultExtension.graphql
  18. extend union SearchResult = Ewok | Gungan