don't display declaration platforms if they're all the same (#717) rdar://130985928

don't display declaration platforms if they're all the same (#717) rdar://130985928

---------

Co-authored-by: Hanqing Huang <[email protected]>
Co-authored-by: Marina Aísa <[email protected]>

Author: 3 people

src/components/DocumentationTopic/PrimaryContent/Declaration.vue

@@ -1,7 +1,7 @@
 <!--
   This source file is part of the Swift.org open source project
 
-  Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
+  Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
   Licensed under Apache License v2.0 with Runtime Library Exception
 
   See https://swift.org/LICENSE.txt for license information
@@ -53,6 +53,7 @@ import DeclarationSourceLink
 
 import { ChangeTypes } from 'docc-render/constants/Changes';
 import { multipleLinesClass } from 'docc-render/constants/multipleLines';
+import { isEqual } from 'docc-render/utils/arrays';
 
 export default {
   name: 'Declaration',
@@ -89,12 +90,13 @@ export default {
   computed: {
     /**
      * Show the captions of DeclarationGroup without changes
-     * when there are more than one declarations
+     * when there are multiple sets of platforms among the
+     * declarations.
      * @returns {boolean}
      */
-    hasPlatformVariants() {
-      return this.declarations.length > 1;
-    },
+    hasPlatformVariants: ({ declarations }) => !(declarations.every(
+      ({ platforms }) => isEqual(platforms, declarations[0].platforms),
+    )),
     /**
      * Returns whether there are declaration changes.
      * @returns {boolean}
@@ -153,4 +155,8 @@ export default {
 .conditional-constraints {
   margin-top: var(--declaration-conditional-constraints-margin, 20px);
 }
+
+.declaration-list:not(:first-child) {
+  margin-top: var(--declaration-conditional-constraints-margin, 20px);
+}
 </style>

tests/unit/components/DocumentationTopic/PrimaryContent/Declaration.spec.js

@@ -161,6 +161,31 @@ describe('Declaration', () => {
     expect(labels.at(1).props('shouldCaption')).toBe(true);
   });
 
+  it('does not render captions when multiple declarations have the same platforms', () => {
+    const declarations = [
+      propsData.declarations[0],
+      {
+        platforms: [
+          'macOS',
+        ],
+        tokens: [
+          {
+            kind: TokenKind.keyword,
+            text: 'let',
+          },
+          ...propsData.declarations[0].tokens.slice(1),
+        ],
+      },
+    ];
+
+    wrapper.setProps({ declarations });
+
+    const labels = wrapper.findAll(DeclarationList);
+    expect(labels.length).toBe(declarations.length);
+    expect(labels.at(0).props('shouldCaption')).toBe(false);
+    expect(labels.at(1).props('shouldCaption')).toBe(false);
+  });
+
   it('renders a `DeclarationDiff` when there are API changes for current and previous and collapsed other declaration list', () => {
     // no DeclarationDiff if no changes
     expect(wrapper.find(DeclarationDiff).exists()).toBe(false);