Add ci script to check examples (#28009)

* Add ci script to check examples

* Install moreutils for `sponge` command.

It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script

* Prettier names in the workflow

* Move "check-examples" into build_test_deploy workflow

* Start breaking the jq script into multiple lines

* Add checks for cleanups in #27121

* Run the `check-examples.sh` script to cleanup all remaining examples.

.github/workflows/build_test_deploy.yml

@@ -8,6 +8,16 @@ on:
 name: Build, test, and deploy
 
 jobs:
+  check-examples:
+    name: Check examples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install moreutils
+        run: sudo apt install moreutils
+      - name: Check examples
+        run: ./scripts/check-examples.sh
+
   build:
     runs-on: ubuntu-latest
     env:

examples/with-cypress/package.json

@@ -1,6 +1,4 @@
 {
-  "name": "with-cypress",
-  "version": "0.1.0",
   "private": true,
   "scripts": {
     "dev": "next dev",

examples/with-fauna/package.json

@@ -1,8 +1,5 @@
 {
   "private": true,
-  "name": "with-fauna",
-  "version": "1.0.0",
-  "description": "Guestbook example with Next.js and Fauna.",
   "scripts": {
     "dev": "next",
     "build": "yarn setup && next build",

examples/with-jotai/next-env.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/types/global" />
 /// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/with-jotai/package.json

@@ -1,5 +1,4 @@
 {
-  "name": "with-jotai",
   "private": true,
   "scripts": {
     "dev": "next dev",

scripts/check-examples.sh

@@ -3,7 +3,10 @@
 for folder in examples/* ; do
   if [ -f "$folder/package.json" ]; then
     cp -n packages/create-next-app/templates/default/gitignore $folder/.gitignore;
-    cat $folder/package.json | jq 'del(.license) | .private = true' | sponge $folder/package.json
+    cat $folder/package.json | jq '
+      .private = true |
+      del(.license, .version, .name, .author, .description)
+    ' | sponge $folder/package.json
   fi
   if [ -f "$folder/tsconfig.json" ]; then
     cp packages/create-next-app/templates/typescript/next-env.d.ts $folder/next-env.d.ts