chore: render servers table in readme (#46)

enisdenjo · github-actions[bot] · web-flow · commit 54fdb101989a · 2023-01-20T16:45:40.000+01:00
Co-authored-by: github-actions[bot] &lt;41898282+github-actions[bot]@users.noreply.github.com&gt;
diff --git a/.github/workflows/audits.yml b/.github/workflows/audits.yml
@@ -159,6 +159,8 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: audit-reports
+      - name: Render servers table
+        run: node scripts/render-servers-table.mjs
       - name: Diff
         run: git diff --minimal
       - name: Commit
diff --git a/README.md b/README.md
@@ -744,15 +744,21 @@ Having said this, graphql-http is mostly aimed for library authors and simple se
 
 If you want a feature-full server with bleeding edge technologies, you're recommended to use one of the following.
 
-| Name                                                               | Audit                                                    |
-| ------------------------------------------------------------------ | -------------------------------------------------------- |
-| [graphql-yoga](https://www.the-guild.dev/graphql/yoga-server)      | [✅ Compliant](/implementations/graphql-yoga/README.md)  |
-| [graphql-helix](https://www.graphql-helix.com/)                    | [✅ Compliant](/implementations/graphql-helix/README.md) |
-| [hotchocolate](https://chillicream.com/docs/hotchocolate)          | [✅ Compliant](/implementations/hotchocolate/README.md)  |
-| [pioneer](https://pioneer.dexclaimation.com/)                      | [✅ Compliant](/implementations/pioneer/README.md)       |
-| [postgraphile](https://www.graphile.org/postgraphile/)             | [✅ Compliant](/implementations/postgraphile/README.md)  |
-| [apollo-server](https://www.apollographql.com/docs/apollo-server/) | [✅ Compliant](/implementations/apollo-server/README.md) |
-| [deno](https://deno.com/blog/build-a-graphql-server-with-deno)     | [✅ Compliant](/implementations/deno/README.md)          |
+<!-- <ServersTable> -->
+<!-- prettier-ignore-start -->
+| Name | Audit |
+|------|-------|
+| [apollo-server](https://www.apollographql.com/docs/apollo-server) | [✅ Compliant](/implementations/apollo-server/README.md) |
+| [deno](https://deno.com/blog/build-a-graphql-server-with-deno) | [✅ Compliant](/implementations/deno/README.md) |
+| [graph-client](https://github.com/graphprotocol/graph-client) | [✅ Compliant](/implementations/graph-client/README.md) |
+| [graphql-helix](https://www.graphql-helix.com) | [✅ Compliant](/implementations/graphql-helix/README.md) |
+| [graphql-yoga](https://www.the-guild.dev/graphql/yoga-server) | [✅ Compliant](/implementations/graphql-yoga/README.md) |
+| [hotchocolate](https://chillicream.com/docs/hotchocolate) | [✅ Compliant](/implementations/hotchocolate/README.md) |
+| [pioneer](https://pioneer.dexclaimation.com) | [✅ Compliant](/implementations/pioneer/README.md) |
+| [postgraphile](https://www.graphile.org/postgraphile) | [✅ Compliant](/implementations/postgraphile/README.md) |
+<!-- prettier-ignore-end -->
+
+<!-- </ServersTable> -->
 
 ## [Documentation](docs/)
 
diff --git a/implementations/apollo-server/package.json b/implementations/apollo-server/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "apollo-server",
+  "url": "https://www.apollographql.com/docs/apollo-server",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/deno/package.json b/implementations/deno/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "deno",
+  "url": "https://deno.com/blog/build-a-graphql-server-with-deno",
   "packageManager": "yarn@3.2.3",
   "scripts": {
     "start": "docker compose up"
diff --git a/implementations/express-graphql/package.json b/implementations/express-graphql/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "express-graphql",
+  "url": "https://github.com/graphql/express-graphql",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/graph-client/package.json b/implementations/graph-client/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "graph-client",
+  "url": "https://github.com/graphprotocol/graph-client",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/graphql-helix/package.json b/implementations/graphql-helix/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "graphql-helix",
+  "url": "https://www.graphql-helix.com",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/graphql-yoga/package.json b/implementations/graphql-yoga/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "graphql-yoga",
+  "url": "https://www.the-guild.dev/graphql/yoga-server",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/hotchocolate/package.json b/implementations/hotchocolate/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "hotchocolate",
+  "url": "https://chillicream.com/docs/hotchocolate",
   "packageManager": "yarn@3.2.3",
   "scripts": {
     "start": "docker compose up"
diff --git a/implementations/mercurius/package.json b/implementations/mercurius/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "mercurius",
+  "url": "https://mercurius.dev",
   "packageManager": "yarn@3.2.3",
   "main": "index.mjs",
   "scripts": {
diff --git a/implementations/pioneer/package.json b/implementations/pioneer/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "pioneer",
+  "url": "https://pioneer.dexclaimation.com",
   "packageManager": "yarn@3.2.3",
   "scripts": {
     "start": "docker compose up"
diff --git a/implementations/postgraphile/package.json b/implementations/postgraphile/package.json
@@ -1,6 +1,7 @@
 {
   "private": true,
   "name": "postgraphile",
+  "url": "https://www.graphile.org/postgraphile",
   "packageManager": "yarn@3.2.3",
   "scripts": {
     "start": "docker compose up"
diff --git a/implementations/thegraph/package.json b/implementations/thegraph/package.json
@@ -1,5 +1,6 @@
 {
   "private": true,
   "name": "thegraph",
+  "url": "https://thegraph.com/docs/en/",
   "packageManager": "yarn@3.2.3"
 }
diff --git a/scripts/render-servers-table.mjs b/scripts/render-servers-table.mjs
@@ -0,0 +1,63 @@
+import fs from 'fs/promises';
+import path from 'path';
+
+async function main() {
+  const openMark = '<!-- <ServersTable> -->';
+  const closeMark = '<!-- </ServersTable> -->';
+
+  let table = `${openMark}\n`;
+  table += await renderTable('implementations');
+  table += '\n'; // prettier would the new line here
+  table += `\n${closeMark}`;
+
+  const readme = (await fs.readFile('README.md')).toString();
+
+  await fs.writeFile(
+    'README.md',
+    readme.replace(new RegExp(`${openMark}.+?${closeMark}`, 's'), table),
+  );
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+
+/** @param {string} implsDir */
+async function renderTable(implsDir) {
+  let out = `<!-- prettier-ignore-start -->
+| Name | Audit |
+|------|-------|`;
+  for (const implDir of (await fs.readdir(implsDir)).sort()) {
+    /** @type {{ error: number }} */
+    const report = JSON.parse(
+      (
+        await fs.readFile(path.join(implsDir, implDir, 'report.json'))
+      ).toString(),
+    );
+    if (report.error > 0) {
+      continue;
+    }
+
+    /** @type {Record<string, unknown>} */
+    const pkg = JSON.parse(
+      (
+        await fs.readFile(path.join(implsDir, implDir, 'package.json'))
+      ).toString(),
+    );
+    if (pkg.name === 'express-graphql') {
+      // deprecated
+      continue;
+    }
+
+    out += '\n';
+    if (pkg.url) {
+      out += `| [${pkg.name}](${pkg.url}) `;
+    } else {
+      out += `| ${pkg.name} `;
+    }
+    out += `| [✅ Compliant](/implementations/${implDir}/README.md) |`;
+  }
+  out += '\n<!-- prettier-ignore-end -->';
+  return out;
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "apollo-server",`
	`4`	`+ "url": "https://www.apollographql.com/docs/apollo-server",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "deno",`
	`4`	`+ "url": "https://deno.com/blog/build-a-graphql-server-with-deno",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"scripts": {`
`6`	`7`	`"start": "docker compose up"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "express-graphql",`
	`4`	`+ "url": "https://github.com/graphql/express-graphql",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "graph-client",`
	`4`	`+ "url": "https://github.com/graphprotocol/graph-client",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "graphql-helix",`
	`4`	`+ "url": "https://www.graphql-helix.com",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "graphql-yoga",`
	`4`	`+ "url": "https://www.the-guild.dev/graphql/yoga-server",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "hotchocolate",`
	`4`	`+ "url": "https://chillicream.com/docs/hotchocolate",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"scripts": {`
`6`	`7`	`"start": "docker compose up"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "mercurius",`
	`4`	`+ "url": "https://mercurius.dev",`
`4`	`5`	`"packageManager": "[email protected]",`
`5`	`6`	`"main": "index.mjs",`
`6`	`7`	`"scripts": {`