Update metadata for all packages (#2748)

This updates the metadata for all packages according to the Yarn constraints used in `MetaMask/core`. The notable changes are: - All packages now have a description. - All packages now have a `homepage` field pointing to the `README.md` of that package, and a `bugs` field pointing to the issue tracker of this repo. - All packages now have keywords.
MetaMask · Sep 20, 2024 · f6e88dc · f6e88dc
1 parent 03b100c
commit f6e88dc
Show file tree

Hide file tree

Showing 50 changed files with 503 additions and 52 deletions.
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
+  "files": [],
   "workspaces": [
     "packages/*"
   ],

diff --git a/packages/create-snap/package.json b/packages/create-snap/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/create-snap",
   "version": "4.0.4",
-  "description": "A CLI for creating MetaMask Snaps.",
+  "description": "A CLI for creating MetaMask Snaps",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/create-snap#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -2,11 +2,22 @@
   "name": "@metamask/example-snaps",
   "version": "3.9.0",
   "private": true,
+  "description": "A collection of examples demonstrating how to build MetaMask Snaps",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "license": "(MIT-0 OR Apache-2.0)",
+  "sideEffects": false,
   "files": [],
   "workspaces": [
     "packages/*"
@@ -22,6 +33,7 @@
     "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!packages/**\" --ignore-path ../../.gitignore",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "start": "yarn workspaces foreach --worktree --parallel --verbose --interlaced --no-private --jobs unlimited run start",
     "start:test": "yarn start",
     "test": "jest --reporters=jest-silent-reporter",

diff --git a/packages/examples/packages/bip32/package.json b/packages/examples/packages/bip32/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/bip32-example-snap",
   "version": "2.2.1",
-  "description": "MetaMask example snap demonstrating the use of `snap_getBip32Entropy`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_getBip32Entropy`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/bip32#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/bip44/package.json b/packages/examples/packages/bip44/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/bip44-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating the use of `snap_getBip44Entropy`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_getBip44Entropy`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/bip44#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/browserify-plugin/package.json b/packages/examples/packages/browserify-plugin/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/browserify-plugin-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating how to use the Browserify plugin to bundle a snap.",
+  "description": "MetaMask example snap demonstrating how to use the Browserify plugin to bundle a snap",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/browserify-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/browserify/package.json b/packages/examples/packages/browserify/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/browserify-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating how to use Browserify to bundle a snap.",
+  "description": "MetaMask example snap demonstrating how to use Browserify to bundle a snap",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/browserify#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/client-status/package.json b/packages/examples/packages/client-status/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/client-status-example-snap",
   "version": "1.0.3",
-  "description": "MetaMask example snap demonstrating the use of `snap_getClientStatus`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_getClientStatus`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/client-status#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/cronjobs/package.json b/packages/examples/packages/cronjobs/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/cronjob-example-snap",
   "version": "2.1.4",
-  "description": "MetaMask example snap demonstrating the use of cronjobs in snaps.",
+  "description": "MetaMask example snap demonstrating the use of cronjobs in snaps",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/cronjobs#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/dialogs/package.json b/packages/examples/packages/dialogs/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/dialog-example-snap",
   "version": "2.3.1",
-  "description": "MetaMask example snap demonstrating the use of `snap_dialog`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_dialog`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/dialogs#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/errors/package.json b/packages/examples/packages/errors/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/error-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating the use of error handling in snaps.",
+  "description": "MetaMask example snap demonstrating the use of error handling in snaps",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/errors#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/ethereum-provider/package.json b/packages/examples/packages/ethereum-provider/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/ethereum-provider-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating the use of the Ethereum Provider API and `endowment:ethereum-provider` permission.",
+  "description": "MetaMask example snap demonstrating the use of the Ethereum Provider API and `endowment:ethereum-provider` permission",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/ethereum-provider#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/ethers-js/package.json b/packages/examples/packages/ethers-js/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/ethers-js-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating how to use Ethers.js inside a snap.",
+  "description": "MetaMask example snap demonstrating how to use Ethers.js inside a snap",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/ethers-js#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/file-upload/package.json b/packages/examples/packages/file-upload/package.json
@@ -2,6 +2,15 @@
   "name": "@metamask/file-upload-example-snap",
   "version": "1.0.1",
   "description": "MetaMask example snap demonstrating file inputs and handling file uploads",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/file-upload#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/get-entropy/package.json b/packages/examples/packages/get-entropy/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/get-entropy-example-snap",
   "version": "2.1.3",
-  "description": "MetaMask example snap demonstrating the use of `snap_getEntropy`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_getEntropy`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/get-entropy#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/get-file/package.json b/packages/examples/packages/get-file/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/get-file-example-snap",
   "version": "1.1.3",
-  "description": "MetaMask example snap demonstrating the use of `snap_getFile`.",
+  "description": "MetaMask example snap demonstrating the use of `snap_getFile`",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/get-file#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/home-page/package.json b/packages/examples/packages/home-page/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/home-page-example-snap",
   "version": "1.1.3",
-  "description": "MetaMask example snap demonstrating the use of home pages.",
+  "description": "MetaMask example snap demonstrating the use of home pages",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/home-page#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/images/package.json b/packages/examples/packages/images/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/images-example-snap",
   "version": "1.1.1",
-  "description": "MetaMask example Snap demonstrating how to render images in Snaps UI.",
+  "description": "MetaMask example Snap demonstrating how to render images in Snaps UI",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/images#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/interactive-ui/package.json b/packages/examples/packages/interactive-ui/package.json
@@ -1,7 +1,16 @@
 {
   "name": "@metamask/interactive-ui-example-snap",
   "version": "2.2.1",
-  "description": "MetaMask example snap demonstrating the use of interactive UI.",
+  "description": "MetaMask example snap demonstrating the use of interactive UI",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/interactive-ui#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"

diff --git a/packages/examples/packages/invoke-snap/package.json b/packages/examples/packages/invoke-snap/package.json
@@ -2,12 +2,23 @@
   "name": "@metamask/invoke-snap-example-snap",
   "version": "2.1.3",
   "private": true,
-  "description": "MetaMask example snaps demonstrating the use of `wallet_invokeSnap` to call a snap from another snap.",
+  "description": "MetaMask example snaps demonstrating the use of `wallet_invokeSnap` to call a snap from another snap",
+  "keywords": [
+    "MetaMask",
+    "Snaps",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/invoke-snap#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/snaps/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "license": "(MIT-0 OR Apache-2.0)",
+  "sideEffects": false,
+  "files": [],
   "workspaces": [
     "packages/*"
   ],
@@ -21,6 +32,7 @@
     "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!snap.manifest.json\" \"!packages/**\" --ignore-path ../../../../.gitignore",
+    "since-latest-release": "../../../../scripts/since-latest-release.sh",
     "start": "yarn workspaces foreach --worktree --parallel --verbose --interlaced --jobs unlimited run start",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
@@ -54,9 +66,5 @@
   },
   "engines": {
     "node": "^18.16 || >=20"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
   }
 }