rename "example" dir to "_examples"

.gitattributes

@@ -1,3 +1,3 @@
 /codegen/templates/data.go linguist-generated
-/example/dataloader/*_gen.go linguist-generated
+/_examples/dataloader/*_gen.go linguist-generated
 generated.go linguist-generated

.github/workflows/check-coverage

@@ -3,5 +3,5 @@
 set -euo pipefail
 GO111MODULE=off go get github.com/mattn/goveralls
 
-go test -covermode atomic -coverprofile=/tmp/coverage.out -coverpkg=./... $(go list github.com/99designs/gqlgen/... | grep -v example)
-goveralls -coverprofile=/tmp/coverage.out -service=github -ignore='example/*/*,example/*/*/*,integration/*,integration/*/*,codegen/testserver/*/*,plugin/federation/testdata/*/*/*,*/generated.go,*/*/generated.go,*/*/*/generated.go,graphql/executable_schema_mock.go'
+go test -covermode atomic -coverprofile=/tmp/coverage.out -coverpkg=./... $(go list github.com/99designs/gqlgen/... | grep -v _examples)
+goveralls -coverprofile=/tmp/coverage.out -service=github -ignore='_examples/*/*,_examples/*/*/*,integration/*,integration/*/*,codegen/testserver/*/*,plugin/federation/testdata/*/*/*,*/generated.go,*/*/generated.go,*/*/*/generated.go,graphql/executable_schema_mock.go'

.github/workflows/check-federation

@@ -2,7 +2,7 @@
 
 set -euo pipefail
 
-cd example/federation
+cd _examples/federation
 
 ./start.sh &
 

.github/workflows/check-fmt

@@ -3,7 +3,7 @@
 set -euo pipefail
 
 go fmt ./...
-cd example && go fmt ./...
+cd _examples && go fmt ./...
 if [[ $(git --no-pager diff) ]] ; then
     echo "you need to run "go fmt" and commit the changes"
     git --no-pager diff

.github/workflows/check-generate

@@ -3,7 +3,7 @@
 set -euo pipefail
 
 go generate ./...
-cd example && go generate ./...
+cd _examples && go generate ./...
 if [[ $(git --no-pager diff) ]] ; then
     echo "you need to run "go generate ./..." and commit the changes"
     git --no-pager diff

.github/workflows/check-init

@@ -2,7 +2,7 @@
 
 set -euo pipefail
 
-cd example/init
+cd _examples/init
 
 go get -d github.com/99designs/gqlgen@master
 

.github/workflows/integration.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v1
       - run: apk add --no-cache --no-progress nodejs npm git bash
       - run: go mod download
-      - run: cd example/federation ; npm install
+      - run: cd _examples/federation ; npm install
       - run: .github/workflows/check-federation
 
   init:

.github/workflows/test.yml

@@ -15,4 +15,4 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
       - run: go mod download && go test -race ./...
-      - run: cd example && go mod download && go test -race ./...
+      - run: cd _examples && go mod download && go test -race ./...

.gitignore

@@ -1,12 +1,12 @@
 /vendor
 /docs/public
 /docs/.hugo_build.lock
-/example/chat/node_modules
+/_examples/chat/node_modules
 /integration/node_modules
 /integration/schema-fetched.graphql
-/example/chat/package-lock.json
-/example/federation/package-lock.json
-/example/federation/node_modules
+/_examples/chat/package-lock.json
+/_examples/federation/package-lock.json
+/_examples/federation/node_modules
 /codegen/gen
 /gen
 

CHANGELOG.md

@@ -250,7 +250,7 @@ Also added `go:generate` in federation entity resolver tests to make it simpler
 
 To test:
 ```
-go generate ./... && cd example/ && go generate ./... && cd ..
+go generate ./... && cd _examples/ && go generate ./... && cd ..
 go test -race ./... && cd example && go test -race ./... && cd ..
 ```
 
@@ -341,7 +341,7 @@ To run tests:
 
 * removed unused const in tests
 
-* Update example/chat/readme.md
+* Update _examples/chat/readme.md
 
 </details></dd></dl>
 
@@ -867,8 +867,8 @@ listed in a few example readmes [2]. Using relative paths from the
 respective example directory should be clear enough.
 
 [2]:
-example/todo/server/server.go:10:2: no required module provides package github.com/99designs/gqlgen/example/todo; to add it:
-	go get github.com/99designs/gqlgen/example/todo
+_examples/todo/server/server.go:10:2: no required module provides package github.com/99designs/gqlgen/_examples/todo; to add it:
+	go get github.com/99designs/gqlgen/_examples/todo
 
 </details></dd></dl>
 
@@ -5071,10 +5071,10 @@ Performance improvments
 
 goos: linux
 goarch: amd64
-pkg: github.com/99designs/gqlgen/example/starwars
+pkg: github.com/99designs/gqlgen/_examples/starwars
 BenchmarkSimpleQueryNoArgs-8      300000             25093 ns/op            6453 B/op        114 allocs/op
 PASS
-ok      github.com/99designs/gqlgen/example/starwars    10.807s
+ok      github.com/99designs/gqlgen/_examples/starwars    10.807s
 
 </details></dd></dl>
 
@@ -5083,10 +5083,10 @@ ok      github.com/99designs/gqlgen/example/starwars    10.807s
 go test -benchtime=5s -bench=. -benchmem
 goos: linux
 goarch: amd64
-pkg: github.com/99designs/gqlgen/example/starwars
+pkg: github.com/99designs/gqlgen/_examples/starwars
 BenchmarkSimpleQueryNoArgs-8      200000             32125 ns/op            6277 B/op        118 allocs/op
 PASS
-ok      github.com/99designs/gqlgen/example/starwars    9.768s
+ok      github.com/99designs/gqlgen/_examples/starwars    9.768s
 
 </details></dd></dl>
 
@@ -5095,10 +5095,10 @@ ok      github.com/99designs/gqlgen/example/starwars    9.768s
 go test -benchtime=5s -bench=. -benchmem
 goos: linux
 goarch: amd64
-pkg: github.com/99designs/gqlgen/example/starwars
+pkg: github.com/99designs/gqlgen/_examples/starwars
 BenchmarkSimpleQueryNoArgs-8      200000             32680 ns/op            6357 B/op        126 allocs/op
 PASS
-ok      github.com/99designs/gqlgen/example/starwars    9.901s
+ok      github.com/99designs/gqlgen/_examples/starwars    9.901s
 
 </details></dd></dl>
 
@@ -8187,7 +8187,7 @@ package "query" does not depend on "schema" any more
 
 - <a href="https://github.com/99designs/gqlgen/commit/1a959516cacda256f52b3ba2f5cf2e7fd03c85da"><tt>1a959516</tt></a> refactor
 
-- <a href="https://github.com/99designs/gqlgen/commit/f8cb11c10ab15ad4a547a1695efe538a7b5209a8"><tt>f8cb11c1</tt></a> example/starwars: use interface base type to make type assertions nicer
+- <a href="https://github.com/99designs/gqlgen/commit/f8cb11c10ab15ad4a547a1695efe538a7b5209a8"><tt>f8cb11c1</tt></a> _examples/starwars: use interface base type to make type assertions nicer
 
 - <a href="https://github.com/99designs/gqlgen/commit/746da4b8e1dff2ec72167060487e1441506a97c3"><tt>746da4b8</tt></a> star wars example: friendsConnection
 
@@ -8315,7 +8315,7 @@ This reverts commit fb3a6fc969b0c8c286c7d024a108f5696627639c.
 
 - <a href="https://github.com/99designs/gqlgen/commit/d70d16c4ebc4a9a8513ccab945b4e0ad77de6cfe"><tt>d70d16c4</tt></a> added server example
 
-- <a href="https://github.com/99designs/gqlgen/commit/6f9a89db8ecf538d72ece47158d2ef7f487d8a06"><tt>6f9a89db</tt></a> separate example/starwars package
+- <a href="https://github.com/99designs/gqlgen/commit/6f9a89db8ecf538d72ece47158d2ef7f487d8a06"><tt>6f9a89db</tt></a> separate _examples/starwars package
 
 - <a href="https://github.com/99designs/gqlgen/commit/e4060db594dbd7ca6a98e7bb9cf967b6bc51e063"><tt>e4060db5</tt></a> added support for directives
 

README.md

@@ -36,7 +36,7 @@ Still not convinced enough to use **gqlgen**? Compare **gqlgen** with other Go g
 
 More help to get started:
  - [Getting started tutorial](https://gqlgen.com/getting-started/) - a comprehensive guide to help you get started
- - [Real-world examples](https://github.com/99designs/gqlgen/tree/master/example) show how to create GraphQL applications
+ - [Real-world examples](https://github.com/99designs/gqlgen/tree/master/_examples) show how to create GraphQL applications
  - [Reference docs](https://pkg.go.dev/github.com/99designs/gqlgen) for the APIs
 
 ## Reporting Issues

_examples/chat/.gqlgen.yml

@@ -0,0 +1,3 @@
+models:
+  Chatroom:
+    model: github.com/99designs/gqlgen/_examples/chat.Chatroom

example/chat/server/server.go → _examples/chat/server/server.go

@@ -11,7 +11,7 @@ import (
 
 	"github.com/99designs/gqlgen/graphql/playground"
 
-	"github.com/99designs/gqlgen/example/chat"
+	"github.com/99designs/gqlgen/_examples/chat"
 	"github.com/99designs/gqlgen/graphql/handler"
 	"github.com/gorilla/websocket"
 	"github.com/opentracing/opentracing-go"

example/config/.gqlgen.yml → _examples/config/.gqlgen.yml

@@ -1,4 +1,4 @@
-# .gqlgen.yml example
+# .gqlgen.yml _examples
 #
 # Refer to https://gqlgen.com/config/
 # for detailed .gqlgen.yml documentation.