feat: vary blame modes depending on enableExtensionsDecorationsColumnView experimental feature (#276)

Author: taras-yemets

package.json

@@ -27,15 +27,15 @@
           [
             "git.blame.decorations"
           ],
-          "${(config.git.blame.decorations === 'line' && 'file') || (config.git.blame.decorations === 'file' && 'none') || 'line'}",
+          "${(config.git.blame.decorations === 'line' && 'file') || (config.git.blame.decorations === 'file' && 'none') || (clientApplication.isSourcegraph && experimentalFeatures.enableExtensionsDecorationsColumnView && 'file' || 'line')}",
           null
         ],
         "category": "Git",
-        "title": "${(config.git.blame.decorations === 'line' && 'Show blame for the whole file') || (config.git.blame.decorations === 'file' && 'Hide blame') || 'Show blame for selected lines'}",
+        "title": "${(config.git.blame.decorations === 'line' && 'Show blame for the whole file') || (config.git.blame.decorations === 'file' && 'Hide blame') || (clientApplication.isSourcegraph && experimentalFeatures.enableExtensionsDecorationsColumnView && 'Show blame for the whole file' || 'Show blame for selected lines')}",
         "actionItem": {
           "label": "Blame",
-          "description": "${(config.git.blame.decorations === 'line' && 'Show Git blame line annotations for the whole file') || (config.git.blame.decorations === 'file' && 'Hide Git blame line annotations') || 'Show Git blame line annotations on selected lines'}",
-          "pressed": "(config.git.blame.decorations === 'line') || (config.git.blame.decorations === 'file')",
+          "description": "${(config.git.blame.decorations === 'line' && 'Show Git blame line annotations for the whole file') || (config.git.blame.decorations === 'file' && 'Hide Git blame line annotations') || (clientApplication.isSourcegraph && experimentalFeatures.enableExtensionsDecorationsColumnView && 'Show Git blame line annotations for the whole file' || 'Show Git blame line annotations on selected lines')}",
+          "pressed": "((!clientApplication.isSourcegraph || !experimentalFeatures.enableExtensionsDecorationsColumnView) && config.git.blame.decorations === 'line') || (config.git.blame.decorations === 'file')",
           "iconURL": "https://raw.githubusercontent.com/sourcegraph/sourcegraph-git-extras/63dd95962c43b95b3f3a9ea2aa0165d6b38a958c/icon/git_logo.svg?sanitize=true"
         }
       }
@@ -129,6 +129,7 @@
     "@types/node": "16.11.33",
     "@types/sinon": "10.0.11",
     "expect": "^24.1.0",
+    "graphql": "^15.4.0",
     "husky": "^4.3.5",
     "lnfs-cli": "^2.1.0",
     "lodash": "^4.17.20",
@@ -139,7 +140,7 @@
     "prettier": "^1.19.1",
     "sinon": "^9.2.1",
     "source-map-support": "^0.5.12",
-    "sourcegraph": "^25.3.0",
+    "sourcegraph": "^25.6.0",
     "ts-node": "^8.10.2",
     "tslint": "^5.11.0",
     "typescript": "^4.1.2",

src/blame.test.ts

@@ -93,7 +93,7 @@ describe('getDecorationsFromHunk()', () => {
             getDecorationFromHunk(FIXTURE_HUNK_1, NOW, 0, { 'git.blame.showPreciseDate': false }, SOURCEGRAPH as any)
         ).toEqual({
             after: {
-                contentText: 'a, 3 months ago: • c',
+                contentText: '3 months ago • a [c]',
                 dark: {
                     backgroundColor: 'rgba(15, 43, 89, 0.65)',
                     color: 'rgba(235, 235, 255, 0.55)',
@@ -125,7 +125,7 @@ describe('getDecorationsFromHunk()', () => {
             SOURCEGRAPH as any
         )
         expect(decoration.after && decoration.after.contentText).toEqual(
-            'a, 3 months ago: • asdgjdsag asdklgbasdghladg asdgjlhbasdgjlhabs…'
+            '3 months ago • a [asdgjdsag asdklgbasdghladg asdgjlhbasdgjlhabs…]'
         )
     })
 
@@ -148,7 +148,7 @@ describe('getDecorationsFromHunk()', () => {
             SOURCEGRAPH as any
         )
         expect(decoration.after && decoration.after.contentText).toEqual(
-            'asdgjdsag asdklgbasdghlad…, 3 months ago: • c'
+            '3 months ago • asdgjdsag asdklgbasdghlad… [c]'
         )
     })
 })
@@ -322,7 +322,7 @@ describe('getBlameDecorations()', () => {
                 3,
                 { 'git.blame.showPreciseDate': false },
                 SOURCEGRAPH as any
-            ).after!.contentText!.startsWith(
+            ).after!.contentText!.includes(
                 `(${FIXTURE_HUNK_4.author.person.user!.username}) ${FIXTURE_HUNK_4.author.person.displayName}`
             )
         ).toBe(true)
@@ -333,7 +333,7 @@ describe('getBlameDecorations()', () => {
                 2,
                 { 'git.blame.showPreciseDate': false },
                 SOURCEGRAPH as any
-            ).after!.contentText!.startsWith(`${FIXTURE_HUNK_3.author.person.displayName}`)
+            ).after!.contentText!.includes(`${FIXTURE_HUNK_3.author.person.displayName}`)
         ).toBe(true)
     })
 })

src/blame.ts

@@ -101,7 +101,7 @@ export const getDecorationFromHunk = (
                 color: 'rgba(235, 235, 255, 0.55)',
                 backgroundColor: 'rgba(15, 43, 89, 0.65)',
             },
-            contentText: `${username}${displayName}, ${dateString}: • ${truncate(hunk.message, 45)}`,
+            contentText: `${dateString} • ${username}${displayName} [${truncate(hunk.message, 45)}]`,
             hoverMessage,
             linkURL,
         },

src/extension.ts

@@ -10,9 +10,18 @@ export interface Settings {
     ['git.blame.lineDecorations']?: boolean
     ['git.blame.decorateWholeFile']?: boolean
     ['git.blame.showPreciseDate']?: boolean
+
+    experimentalFeatures?: {
+        enableExtensionsDecorationsColumnView?: boolean
+    }
 }
 
-const decorationType = sourcegraph.app.createDecorationType && sourcegraph.app.createDecorationType()
+const isBlameForSelectedLinesEnabled = () =>
+    !sourcegraph.configuration.get<Settings>().get('experimentalFeatures')?.enableExtensionsDecorationsColumnView ||
+    sourcegraph.internal.clientApplication !== 'sourcegraph'
+
+const decorationType =
+    sourcegraph.app.createDecorationType && sourcegraph.app.createDecorationType({ display: 'column' })
 
 const statusBarItemType = sourcegraph.app.createStatusBarItemType && sourcegraph.app.createStatusBarItemType()
 
@@ -32,7 +41,7 @@ export function activate(context: sourcegraph.ExtensionContext): void {
         // When the configuration or current file changes, publish new decorations.
         context.subscriptions.add(
             combineLatest(configurationChanges, selectionChanges).subscribe(([, { editor, selections }]) =>
-                decorate(editor, selections)
+                decorate(editor, isBlameForSelectedLinesEnabled() ? selections : null)
             )
         )
     } else {

yarn.lock

@@ -3259,6 +3259,11 @@ grapheme-breaker@^0.3.2:
     brfs "^1.2.0"
     unicode-trie "^0.3.1"
 
+graphql@^15.4.0:
+  version "15.8.0"
+  resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.8.0.tgz#33410e96b012fa3bdb1091cc99a94769db212b38"
+  integrity sha512-5gghUc24tP9HRznNpV2+FIoq3xKkj5dTQqf4v0CpdPbFVwFkWoxOM+o+2OC9ZSvjEMTjfmG9QT+gcvggTwW1zw==
+
 [email protected]:
   version "1.10.5"
   resolved "https://registry.yarnpkg.com/growl/-/growl-1.10.5.tgz#f2735dc2283674fa67478b10181059355c369e5e"
@@ -6583,10 +6588,10 @@ source-map@^0.5.0, source-map@^0.5.3, source-map@^0.5.6:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc"
   integrity sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=
 
-sourcegraph@^25.3.0:
-  version "25.3.0"
-  resolved "https://registry.yarnpkg.com/sourcegraph/-/sourcegraph-25.3.0.tgz#0ad58f40a6fb286ddaf5f441c28b2c1241098e94"
-  integrity sha512-677uVs3rq1gVeiKTZ6wrlq862dUIn02ZmEgxoPTfFMI3tlJWhdgFZOg2GpFEgFRoB1ct7rMMlRrI1cEQdB7Rkg==
+sourcegraph@^25.6.0:
+  version "25.6.0"
+  resolved "https://registry.yarnpkg.com/sourcegraph/-/sourcegraph-25.6.0.tgz#fc23822a8e207e25ff9bfc217dad4a14bfbd1e84"
+  integrity sha512-BKe/hugALfgMyM38ecWpeFLtXvVklq++aUpGlm4Y3fY8/ufbUE/FAaYchF9qkidli8Usef5xnDRCKbAfsPRpWA==
 
 spawn-wrap@^1.4.2:
   version "1.4.2"