add changelog formatting script (#44)

Author: wenfix

package.json

@@ -17,6 +17,7 @@
     "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run build:docs",
     "build:only-clean": "rimraf -g 'packages/*/dist' 'packages/*/*.tsbuildinfo'",
+    "changelog:format": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:format",
     "changelog:update": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:update",
     "changelog:validate": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:validate",
     "clean": "rimraf -g 'packages/*/node_modules/.cache' 'playground/*/node_modules/.cache' 'packages/*/node_modules' 'packages/*/dist' 'packages/*/build' 'playground/*/node_modules' 'playground/*/dist' 'playground/*/build' node_modules",

packages/analytics/package.json

@@ -38,6 +38,7 @@
   "scripts": {
     "build": "yarn clean && tsc -b --force tsconfig.build.json && npx tsup src/index.ts --format esm,cjs",
     "build:docs": "typedoc",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/analytics",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/analytics",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/analytics",
     "clean": "npx rimraf ./dist ./tsconfig.build.tsbuildinfo",

packages/connect-evm/package.json

@@ -34,6 +34,7 @@
   "scripts": {
     "build": "yarn tsup ",
     "build:docs": "typedoc",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/connect-evm",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/connect-evm",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connect-evm",
     "clean": "npx rimraf ./dist",

packages/connect-multichain/package.json

@@ -49,6 +49,7 @@
   "scripts": {
     "build": "yarn clean && tsc -b tsconfig.build.json && npx tsup",
     "build:docs": "typedoc",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/connect-multichain",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/connect-multichain",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connect-multichain",
     "clean": "npx rimraf ./dist",

packages/connect/package.json

@@ -48,6 +48,7 @@
     "build": "yarn clean && tsc -b --force tsconfig.build.json && npx tsup src/index.ts src/multichain/index.ts --format esm,cjs --external @metamask/connect-multichain",
     "clean": "npx rimraf ./dist ./tsconfig.build.tsbuildinfo",
     "build:docs": "typedoc",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/connect",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/connect",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connect",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",

packages/multichain-ui/package.json

@@ -52,6 +52,7 @@
     "build:watch": "stencil build --watchAll",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-ui",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-ui",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/multichain-ui",
     "dev": "stencil build --dev --watch --serve",
     "generate": "stencil generate",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",

playground/multichain-node-playground/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@metamask/multichain-node-playground",
   "version": "0.0.0",
+  "private": true,
   "description": "multichain-node-playground",
   "keywords": [
     "MetaMask",
@@ -16,16 +17,19 @@
   },
   "license": "MIT",
   "sideEffects": false,
-  "private": true,
   "main": "index.js",
   "scripts": {
-    "start": "node -r ts-node/register -r tsconfig-paths/register src/index.ts",
     "build": "tsup src/index.ts --format cjs,esm",
-    "clean": "rm -rf dist .sdk-comm",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/multichain-node-playground",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-node-playground",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-node-playground",
+    "clean": "rm -rf dist .sdk-comm",
+    "start": "node -r ts-node/register -r tsconfig-paths/register src/index.ts",
     "test": "echo \"No test specified\""
   },
+  "resolutions": {
+    "elliptic": "6.6.1"
+  },
   "dependencies": {
     "@metamask/connect-multichain": "workspace:^",
     "chalk": "^4.1.2",
@@ -47,9 +51,6 @@
     "typedoc-plugin-missing-exports": "^1.0.0",
     "typescript": "~5.9.2"
   },
-  "resolutions": {
-    "elliptic": "6.6.1"
-  },
   "engines": {
     "node": "^18.18 || >=20"
   },

playground/multichain-react-native-playground/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@metamask/multichain-react-native-playground",
   "version": "0.0.0",
+  "private": true,
   "description": "A native test dapp for multichain api",
   "keywords": [
     "MetaMask",
@@ -21,16 +22,17 @@
     "dist/"
   ],
   "scripts": {
+    "allow-scripts": "",
+    "android": "expo start --android",
     "build": "echo 'builds via expo'",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/multichain-react-native-playground",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-react-native-playground",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-react-native-playground",
-    "start": "expo start --tunnel",
-    "android": "expo start --android",
     "ios": "expo start --ios",
-    "web": "expo start --web",
+    "start": "expo start --tunnel",
     "test": "echo \"No test specified\"",
     "test:verbose": "yarn test",
-    "allow-scripts": ""
+    "web": "expo start --web"
   },
   "dependencies": {
     "@expo/vector-icons": "^15.0.2",
@@ -82,6 +84,13 @@
     "eslint-config-expo": "~10.0.0",
     "typescript": "~5.9.2"
   },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "restricted",
+    "registry": "https://registry.npmjs.org/"
+  },
   "lavamoat": {
     "allowScripts": {
       "@lavamoat/preinstall-always-fail": false,
@@ -93,13 +102,5 @@
       "@metamask/connect-multichain>@metamask/mobile-wallet-protocol-dapp-client>@metamask/mobile-wallet-protocol-core>centrifuge>protobufjs": false,
       "@metamask/connect-multichain>@metamask/mobile-wallet-protocol-core>centrifuge>protobufjs": false
     }
-  },
-  "private": true,
-  "engines": {
-    "node": "^18.18 || >=20"
-  },
-  "publishConfig": {
-    "access": "restricted",
-    "registry": "https://registry.npmjs.org/"
   }
 }

playground/multichain-react-playground/package.json

@@ -26,9 +26,10 @@
   "scripts": {
     "build": "DISABLE_ESLINT_PLUGIN=true craco build",
     "build:docs": "typedoc",
-    "deploy": "serve -s build",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/multichain-react-playground",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/multichain-react-playground",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/multichain-react-playground",
+    "deploy": "serve -s build",
     "prepack": "./scripts/prepack.sh",
     "start": "DISABLE_ESLINT_PLUGIN=true craco start",
     "test": "echo \"No test specified\"",

scripts/format-changelog.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if [[ $# -eq 0 ]]; then
+  echo "Missing package name."
+  exit 1
+fi
+
+package_name="$1"
+shift  # remove package name from arguments
+
+# Get the script directory and find the root node_modules
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)"
+
+# Format/fix the changelog using prettier
+if [[ "${GITHUB_REF:-}" =~ '^release/' ]]; then
+  "${ROOT_DIR}/node_modules/.bin/auto-changelog" update --prettier --tag-prefix "${package_name}@" --rc "$@"
+else
+  "${ROOT_DIR}/node_modules/.bin/auto-changelog" update --prettier --tag-prefix "${package_name}@" "$@"
+fi