Merge remote-tracking branch 'origin/main' into hm/mul-1242

Author: hmalik88

.github/actions/check-release/action.yml

@@ -0,0 +1,87 @@
+name: Check release
+description: Check for conflicts in packages being released in this PR.
+
+inputs:
+  pull-request:
+    description: 'The pull request number to get changed files from.'
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Get target reference
+      id: get-target
+      shell: bash
+      env:
+        EVENT_NAME: ${{ github.event_name }}
+      run: |
+        if [ "$EVENT_NAME" = "pull_request" ]; then
+          echo "TARGET=$(git merge-base HEAD refs/remotes/origin/main)" >> "$GITHUB_OUTPUT"
+        elif [ "$EVENT_NAME" = "merge_group" ]; then
+          echo "TARGET=$(git rev-parse HEAD^)" >> "$GITHUB_OUTPUT"
+        else
+          echo "::error::This action only supports \`pull_request\` and \`merge_group\` events."
+          exit 1
+        fi
+
+    - name: Check commits for changes in released packages
+      shell: bash
+      env:
+        GH_TOKEN: ${{ github.token }}
+        PULL_REQUEST: ${{ inputs.pull-request }}
+        TARGET: ${{ steps.get-target.outputs.TARGET }}
+      run: |
+        set -euo pipefail
+        git fetch origin main
+
+        mapfile -t PACKAGES < <(find packages -maxdepth 2 -name "package.json" -not -path "*/node_modules/*")
+        RELEASED_PACKAGES=()
+
+        # Get all packages being released in this PR
+        MERGE_BASE=$(git merge-base HEAD refs/remotes/origin/main)
+        for package in "${PACKAGES[@]}"; do
+          MAIN_VERSION=$(git show "$MERGE_BASE:$package" | jq -r .version)
+          HEAD_VERSION=$(jq -r .version "$package")
+
+          if [ "$HEAD_VERSION" != "$MAIN_VERSION" ]; then
+            package_name=$(jq -r ".name" "$package")
+            echo "📦 Package \`$package_name\` is being released (version \`$MAIN_VERSION\` -> \`$HEAD_VERSION\`)"
+            RELEASED_PACKAGES+=("$package")
+          fi
+        done
+
+        # Fetch the pull request branch to compare changes.
+        PULL_REQUEST_BRANCH=$(gh pr view "$PULL_REQUEST" --json headRefName --template "{{ .headRefName }}")
+        echo "🔍 Checking for release conflicts with files changed ahead of PR branch \`$PULL_REQUEST_BRANCH\`..."
+        git fetch origin "$PULL_REQUEST_BRANCH"
+
+        # Get all files changed ahead of this PR.
+        BEFORE=$(git merge-base "refs/remotes/origin/main" "origin/$PULL_REQUEST_BRANCH")
+        git diff --name-only "$BEFORE..$TARGET" > changed-files.txt
+
+        CONFLICTS=()
+        for package in "${RELEASED_PACKAGES[@]}"; do
+          package_directory=$(dirname "$package")
+          if grep -q "^$package_directory/" changed-files.txt; then
+            CONFLICTS+=("$package_directory")
+          fi
+        done
+
+        if [ ${#CONFLICTS[@]} -ne 0 ]; then
+          mapfile -t CONFLICTS < <(printf "%s\n" "${CONFLICTS[@]}" | sort -u)
+        fi
+
+        if [ ${#CONFLICTS[@]} -ne 0 ]; then
+          for conflict in "${CONFLICTS[@]}"; do
+            package_name=$(jq -r ".name" "$conflict/package.json")
+            echo "::error::Release conflict detected in \`$package_name\`. This package is being released in this PR, but files in the package were also modified ahead of this PR. Please ensure that all changes are included in the release."
+          done
+          exit 1
+        else
+          echo "✅ No release conflicts detected."
+        fi

.github/workflows/main.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
+  merge_group:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.sha || github.ref }}
@@ -62,6 +63,59 @@ jobs:
     needs: check-workflows
     uses: ./.github/workflows/lint-build-test.yml
 
+  check-release:
+    name: Check release
+    needs: check-workflows
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get merge base
+        id: merge-base
+        if: github.event_name != 'push'
+        env:
+          BASE_REF: ${{ github.event.pull_request.base.ref || github.event.merge_group.base_ref }}
+        run: |
+          echo "MERGE_BASE=$(git merge-base HEAD "refs/remotes/origin/$BASE_REF")" >> "$GITHUB_OUTPUT"
+
+      - name: Check if the commit or pull request is a release
+        id: is-release
+        if: github.event_name != 'push'
+        uses: MetaMask/action-is-release@d063725cd15ee145d7e795a2e77db31a3e3f2c92
+        with:
+          commit-starts-with: 'Release [version],Release v[version],Release/[version],Release/v[version],Release `[version]`'
+          commit-message: ${{ github.event.pull_request.title }}
+          before: ${{ steps.merge-base.outputs.MERGE_BASE }}
+
+      - name: Get pull request number
+        if: github.event_name != 'push'
+        id: pr-number
+        env:
+          EVENT_NAME: ${{ github.event_name }}
+          PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}
+          MERGE_GROUP_HEAD_REF: ${{ github.event.merge_group.head_ref }}
+        run: |
+          if [ "$EVENT_NAME" = "pull_request" ]; then
+            echo "PR_NUMBER=$PULL_REQUEST_NUMBER" >> "$GITHUB_OUTPUT"
+          elif [ "$EVENT_NAME" = "merge_group" ]; then
+            PR_NUMBER_REGEX='/pr-([0-9]+)-'
+            if [[ "$MERGE_GROUP_HEAD_REF" =~ $PR_NUMBER_REGEX ]]; then
+              echo "PR_NUMBER=${BASH_REMATCH[1]}" >> "$GITHUB_OUTPUT"
+            else
+              echo "::error::Could not extract PR number from merge group head ref: $MERGE_GROUP_HEAD_REF."
+              exit 1
+            fi
+          fi
+
+      - name: Check release
+        if: github.event_name != 'push' && steps.is-release.outputs.IS_RELEASE == 'true'
+        uses: ./.github/actions/check-release
+        with:
+          pull-request: ${{ steps.pr-number.outputs.PR_NUMBER }}
+
   is-release:
     name: Determine whether this is a release merge commit
     needs: lint-build-test
@@ -99,6 +153,7 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - analyse-code
+      - check-release
       - lint-build-test
     outputs:
       passed: ${{ steps.set-output.outputs.passed }}

eslint-warning-thresholds.json

@@ -31,9 +31,6 @@
   "packages/assets-controllers/src/NftDetectionController.test.ts": {
     "import-x/namespace": 6
   },
-  "packages/assets-controllers/src/NftDetectionController.ts": {
-    "jsdoc/check-tag-names": 34
-  },
   "packages/assets-controllers/src/Standards/ERC20Standard.test.ts": {
     "jest/no-commented-out-tests": 1
   },
@@ -49,15 +46,11 @@
   "packages/assets-controllers/src/TokenListController.test.ts": {
     "import-x/namespace": 7
   },
-  "packages/assets-controllers/src/TokenRatesController.ts": {
-    "jsdoc/check-tag-names": 11
-  },
   "packages/assets-controllers/src/TokensController.test.ts": {
     "import-x/namespace": 1
   },
   "packages/assets-controllers/src/TokensController.ts": {
-    "@typescript-eslint/no-unused-vars": 1,
-    "jsdoc/check-tag-names": 10
+    "@typescript-eslint/no-unused-vars": 1
   },
   "packages/assets-controllers/src/multicall.test.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 2
@@ -74,8 +67,7 @@
     "no-shadow": 2
   },
   "packages/controller-utils/src/siwe.ts": {
-    "@typescript-eslint/no-unused-vars": 1,
-    "jsdoc/check-tag-names": 5
+    "@typescript-eslint/no-unused-vars": 1
   },
   "packages/controller-utils/src/util.test.ts": {
     "import-x/no-named-as-default": 1,
@@ -90,9 +82,6 @@
   "packages/eip-5792-middleware/src/hooks/processSendCalls.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
-  "packages/ens-controller/src/EnsController.ts": {
-    "jsdoc/check-tag-names": 6
-  },
   "packages/eth-block-tracker/src/PollingBlockTracker.test.ts": {
     "@typescript-eslint/unbound-method": 4
   },
@@ -101,15 +90,11 @@
     "@typescript-eslint/unbound-method": 5,
     "no-restricted-syntax": 28
   },
-  "packages/eth-block-tracker/tests/buildDeferred.ts": {
-    "@typescript-eslint/naming-convention": 1
-  },
   "packages/eth-block-tracker/tests/recordCallsToSetTimeout.ts": {
     "@typescript-eslint/no-explicit-any": 1
   },
   "packages/eth-block-tracker/tests/setupAfterEnv.ts": {
     "@typescript-eslint/consistent-type-definitions": 1,
-    "@typescript-eslint/naming-convention": 1,
     "@typescript-eslint/no-explicit-any": 3
   },
   "packages/eth-block-tracker/tests/withBlockTracker.ts": {
@@ -118,9 +103,6 @@
   "packages/gas-fee-controller/src/GasFeeController.test.ts": {
     "import-x/namespace": 2
   },
-  "packages/gas-fee-controller/src/GasFeeController.ts": {
-    "jsdoc/check-tag-names": 20
-  },
   "packages/json-rpc-middleware-stream/src/index.test.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 1,
     "no-empty-function": 1
@@ -137,18 +119,6 @@
   "packages/logging-controller/src/LoggingController.test.ts": {
     "import-x/namespace": 1
   },
-  "packages/logging-controller/src/LoggingController.ts": {
-    "jsdoc/check-tag-names": 1
-  },
-  "packages/message-manager/src/AbstractMessageManager.ts": {
-    "jsdoc/check-tag-names": 23
-  },
-  "packages/message-manager/src/DecryptMessageManager.ts": {
-    "jsdoc/check-tag-names": 11
-  },
-  "packages/message-manager/src/EncryptionPublicKeyManager.ts": {
-    "jsdoc/check-tag-names": 13
-  },
   "packages/message-manager/src/utils.ts": {
     "@typescript-eslint/no-unused-vars": 1
   },
@@ -161,18 +131,9 @@
   "packages/notification-services-controller/src/NotificationServicesController/NotificationServicesController.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
-  "packages/permission-log-controller/src/PermissionLogController.ts": {
-    "jsdoc/check-tag-names": 2
-  },
-  "packages/phishing-controller/src/PhishingController.ts": {
-    "jsdoc/check-tag-names": 32
-  },
   "packages/phishing-controller/src/utils.test.ts": {
     "import-x/namespace": 5
   },
-  "packages/rate-limit-controller/src/RateLimitController.ts": {
-    "jsdoc/check-tag-names": 4
-  },
   "packages/remote-feature-flag-controller/src/client-config-api-service/client-config-api-service.test.ts": {
     "promise/param-names": 1
   },
@@ -206,11 +167,7 @@
     "no-empty-function": 1
   },
   "tests/fake-provider.ts": {
-    "@typescript-eslint/prefer-promise-reject-errors": 1,
-    "jsdoc/check-tag-names": 12
-  },
-  "tests/mock-network.ts": {
-    "jsdoc/check-tag-names": 10
+    "@typescript-eslint/prefer-promise-reject-errors": 1
   },
   "tests/setupAfterEnv/nock.ts": {
     "import-x/no-named-as-default-member": 3

eslint.config.mjs

@@ -169,7 +169,6 @@ const config = createConfig([
       'import-x/namespace': 'warn',
       'import-x/no-named-as-default': 'warn',
       'import-x/order': 'warn',
-      'jsdoc/check-tag-names': 'warn',
       'jsdoc/require-returns': 'warn',
       'jsdoc/tag-lines': 'warn',
       'no-unused-private-class-members': 'warn',
@@ -188,7 +187,6 @@ const config = createConfig([
   {
     files: ['**/*.d.ts'],
     rules: {
-      '@typescript-eslint/naming-convention': 'warn',
       'import-x/unambiguous': 'off',
     },
   },
@@ -224,7 +222,6 @@ const config = createConfig([
       // TODO: Re-enable these rules or add inline ignores for warranted cases
       '@typescript-eslint/prefer-nullish-coalescing': 'warn',
       'no-restricted-syntax': 'warn',
-      '@typescript-eslint/naming-convention': 'warn',
       '@typescript-eslint/no-explicit-any': 'warn',
       '@typescript-eslint/unbound-method': 'warn',
       '@typescript-eslint/consistent-type-definitions': 'warn',
@@ -251,6 +248,32 @@ const config = createConfig([
       'consistent-this': 'off',
     },
   },
+  {
+    files: [
+      'packages/assets-controllers/src/NftDetectionController.ts',
+      'packages/assets-controllers/src/TokenRatesController.ts',
+      'packages/assets-controllers/src/TokensController.ts',
+      'packages/controller-utils/src/siwe.ts',
+      'packages/ens-controller/src/EnsController.ts',
+      'packages/gas-fee-controller/src/GasFeeController.ts',
+      'packages/logging-controller/src/LoggingController.ts',
+      'packages/message-manager/src/AbstractMessageManager.ts',
+      'packages/message-manager/src/DecryptMessageManager.ts',
+      'packages/message-manager/src/EncryptionPublicKeyManager.ts',
+      'packages/permission-log-controller/src/PermissionLogController.ts',
+      'packages/phishing-controller/src/PhishingController.ts',
+      'packages/rate-limit-controller/src/RateLimitController.ts',
+      'tests/fake-provider.ts',
+      'tests/mock-network.ts',
+    ],
+    rules: {
+      // TODO: Re-enable this rule
+      // This has been temporarily disabled because the auto-fix mangles pre-existing JSDoc blocks
+      // for types that don't follow TSDoc properly.
+      // See https://github.com/gajus/eslint-plugin-jsdoc/issues/1054
+      'jsdoc/check-tag-names': 'off',
+    },
+  },
 ]);
 
 export default config;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/core-monorepo",
-  "version": "675.0.0",
+  "version": "679.0.0",
   "private": true,
   "description": "Monorepo for packages shared between MetaMask clients",
   "repository": {