docs: tweaks (#229)

* docs: tweaks

* build: print coverage

* build: add engines field

.github/workflows/publish.yml

@@ -3,14 +3,13 @@ name: Publish
 on:
   push:
     branches:
-    - main
+      - main
     tags:
-    - '!*'
+      - '!*'
 
 env:
   NODE_VERSION: '18'
 
-
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:

.github/workflows/test.yml

@@ -50,4 +50,3 @@ jobs:
 
       - name: Generate coverage
         run: pnpm coverage
-

package.json

@@ -111,7 +111,7 @@
     "clean:build": "pnpm -r run clean:build",
     "clean:node": "pnpm -r run clean:node",
     "contributors": "git-authors-cli && finepack",
-    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
+    "coverage": "c8 report",
     "lockfile": "pnpm install --lockfile && git add pnpm-lock.yaml && git commit -m \"build: regenerate lock\"",
     "postinstall": "./node_modules/.bin/simple-git-hooks",
     "prebuild": "pnpm -r run clean:build",

packages/cookies/README.md

@@ -0,0 +1,36 @@
+<div align="center">
+  <br>
+  <img src="https://edge-runtime.vercel.app/og-image.png" alt="edge-runtime logo">
+  <br>
+  <br>
+  <p align="center"><strong>@edge-runtime/cookies</strong>: An Edge Runtime compatible cookie helpers.</p>
+  <p align="center">See <a href="https://edge-runtime.vercel.app/packages/jest-environment" target='_blank' rel='noopener noreferrer'>@edge-runtime/cookies</a> section in our <a href="https://edge-runtime.vercel.app/" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
+  <br>
+</div>
+
+## Install
+
+Using npm:
+
+```sh
+npm install @edge-runtime/cookies --save
+```
+
+or using yarn:
+
+```sh
+yarn add @edge-runtime/cookies --dev
+```
+
+or using pnpm:
+
+```sh
+pnpm install @edge-runtime/cookies --save
+```
+
+## License
+
+**@edge-runtime/cookies** © [Vercel](https://vercel.com), released under the [MPLv2](https://github.com/vercel/edge-runtime/blob/main/LICENSE.md) License.<br>
+Authored and maintained by [Vercel](https://vercel.com) with help from [contributors](https://github.com/vercel/edge-runtime/contributors).
+
+> [vercel.com](https://vercel.com) · GitHub [Vercel](https://github.com/vercel) · Twitter [@vercel](https://twitter.com/vercel)

packages/cookies/package.json

@@ -16,14 +16,23 @@
   "keywords": [
     "cookie",
     "cookies",
-    "set-cookie"
+    "edge",
+    "edge-runtime",
+    "functions",
+    "runtime",
+    "set-cookie",
+    "standard",
+    "web"
   ],
   "devDependencies": {
     "@edge-runtime/format": "workspace:1.1.0",
     "@edge-runtime/jest-environment": "workspace:2.0.2",
     "@types/cookie": "0.5.1",
     "tsup": "6"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist"
   ],

packages/feature-detector/README.md

@@ -3,14 +3,14 @@
   <img src="https://edge-runtime.vercel.app/og-image.png" alt="edge-runtime logo">
   <br>
   <br>
-  <p align="center"><strong>@edge-runtime/feature-detector</strong>: utilities to analyze code running on the edge and its used low-level APIs.</p>
+  <p align="center"><strong>@edge-runtime/feature-detector</strong>: A set of utilities to analyze code running on the edge and its used low-level APIs.</p>
   <p align="center">See <a href="https://edge-runtime.vercel.app/packages/feature-detector" target='_blank' rel='noopener noreferrer'>@edge-runtime/feature-detector</a> section in our <a href="https://edge-runtime.vercel.app/" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
   <br>
 </div>
 
-## Install
+> **Note**: This is an alpha version.
 
-**Note: this is an alpha version.**
+## Install
 
 Using npm:
 

packages/feature-detector/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edge-runtime/feature-detector",
-  "description": "Helpers for analyzing code running on the edge and its used low-level APIs",
+  "description": "A set of utilities to analyze code running on the edge and its used low-level APIs",
   "homepage": "https://edge-runtime.vercel.app/packages/feature-detector",
   "version": "1.0.0-alpha.1",
   "main": "dist/index.js",
@@ -13,14 +13,32 @@
   "bugs": {
     "url": "https://github.com/vercel/edge-runtime/issues"
   },
-  "keywords": [],
+  "keywords": [
+    "detector",
+    "edge",
+    "edge-runtime",
+    "feature",
+    "functions",
+    "runtime",
+    "standard",
+    "web"
+  ],
+  "dependencies": {
+    "ts-morph": "17.0.1"
+  },
   "devDependencies": {
     "jest-text-transformer": "1.0.4",
-    "next": "^13.1.1",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "tsup": "^6"
+    "next": "13",
+    "react": "18",
+    "react-dom": "18",
+    "tsup": "6"
   },
+  "engines": {
+    "node": ">=14"
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "pnpm run build:patch && pnpm run build:src",
     "build:patch": "ts-node scripts/patch-type-definition.ts",
@@ -33,8 +51,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "ts-morph": "^17.0.1"
-  }
+  "types": "dist/index.d.ts"
 }

packages/format/package.json

@@ -14,25 +14,30 @@
   },
   "keywords": [
     "edge",
+    "edge-runtime",
     "format",
     "formatter",
     "functions",
     "printf",
     "runtime",
-    "standard"
+    "standard",
+    "web"
   ],
   "devDependencies": {
     "tsup": "6"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "prebuild": "pnpm run clean:build",
     "build": "tsup",
     "clean": "pnpm run clean:node && pnpm run clean:build",
-    "clean:node": "rm -rf node_modules",
     "clean:build": "rm -rf dist",
+    "clean:node": "rm -rf node_modules",
+    "prebuild": "pnpm run clean:build",
     "test": "TZ=UTC jest"
   },
   "license": "MPLv2",

packages/jest-environment/package.json

@@ -14,6 +14,7 @@
   },
   "keywords": [
     "edge",
+    "edge-runtime",
     "functions",
     "jest",
     "runtime",
@@ -29,6 +30,9 @@
     "jest-mock": "28.1.3",
     "jest-util": "28.1.3"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist"
   ],

packages/jest-expect/package.json

@@ -14,7 +14,7 @@
   },
   "keywords": [
     "edge",
-    "expect",
+    "edge-runtime",
     "functions",
     "jest",
     "matchers",
@@ -33,6 +33,9 @@
   "devDependencies": {
     "@edge-runtime/jest-environment": "workspace:*"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist",
     "index.d.ts",

packages/node-utils/README.md

@@ -3,14 +3,14 @@
   <img src="https://edge-runtime.vercel.app/og-image.png" alt="edge-runtime logo">
   <br>
   <br>
-  <p align="center"><strong>@edge-runtime/node-utils</strong>: Utilities to run web compliant code into a Node.js environment.</p>
+  <p align="center"><strong>@edge-runtime/node-utils</strong>: A set of helpers for running edge-compliant code in Node.js environment.</p>
   <p align="center">See <a href="https://edge-runtime.vercel.app/packages/node-utils" target='_blank' rel='noopener noreferrer'>@edge-runtime/node-utils</a> section in our <a href="https://edge-runtime.vercel.app/" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
   <br>
 </div>
 
-## Install
+> **Note**: This is an alpha version.
 
-**Note: this is an alpha version.**
+## Install
 
 Using npm:
 

packages/node-utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edge-runtime/node-utils",
-  "description": "Helpers for running edge-compliant code in Node.js environment",
+  "description": "A set of helpers for running edge-compliant code in Node.js environment",
   "homepage": "https://edge-runtime.vercel.app/packages/node-utils",
   "version": "1.0.0-alpha.1",
   "main": "dist/index.js",
@@ -13,13 +13,25 @@
   "bugs": {
     "url": "https://github.com/vercel/edge-runtime/issues"
   },
-  "keywords": [],
+  "keywords": [
+    "edge",
+    "edge-runtime",
+    "functions",
+    "node",
+    "runtime",
+    "standard",
+    "utils",
+    "web"
+  ],
   "devDependencies": {
     "@edge-runtime/primitives": "workspace:2.0.2",
     "@types/test-listen": "1.1.0",
     "test-listen": "1.1.0",
     "tsup": "6"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist"
   ],

packages/ponyfill/package.json

@@ -16,6 +16,7 @@
   "keywords": [
     "apis",
     "edge",
+    "edge-runtime",
     "functions",
     "polyfill",
     "ponyfill",
@@ -33,6 +34,9 @@
     "acorn-loose": "8.3.0",
     "acorn-walk": "8.2.0"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "src"
   ],

packages/primitives/package.json

@@ -15,6 +15,7 @@
   "keywords": [
     "apis",
     "edge",
+    "edge-runtime",
     "functions",
     "primites",
     "runtime",
@@ -37,6 +38,9 @@
     "web-streams-polyfill": "4.0.0-beta.3",
     "whatwg-url": "11.0.0"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "abort-controller",
     "blob",

packages/primitives/scripts/build.ts

@@ -158,9 +158,7 @@ async function bundlePackage() {
 }
 
 bundlePackage()
-  .then(() => {
-    process.exit(0)
-  })
+  .then(() => process.exit(0))
   .catch((error) => {
     console.log('Errored', error)
     process.exit(1)

packages/runtime/package.json

@@ -17,8 +17,11 @@
   },
   "keywords": [
     "edge",
+    "edge-runtime",
     "functions",
-    "runtime"
+    "runtime",
+    "standard",
+    "web"
   ],
   "dependencies": {
     "@edge-runtime/format": "workspace:1.1.0",
@@ -35,6 +38,9 @@
     "@types/node-fetch": "2.x",
     "node-fetch": "2"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "dist"
   ],

packages/types/package.json

@@ -14,6 +14,7 @@
   "keywords": [
     "context",
     "edge",
+    "edge-runtime",
     "functions",
     "runtime",
     "standard",
@@ -25,6 +26,9 @@
   "dependencies": {
     "@edge-runtime/primitives": "workspace:2.0.2"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "src"
   ],