Create find-replace extension

Author: marekweb

package.json

@@ -10,10 +10,27 @@
   "categories": [],
   "tags": [],
   "contributes": {
-    "actions": [],
+    "actions": [
+      {
+        "id": "start-find-replace",
+        "title": "New find-replace campaign...",
+        "command": "start-find-replace",
+        "actionItem": {
+          "label": "Find-replace"
+        }
+      }
+    ],
     "menus": {
-      "editor/title": [],
-      "commandPalette": []
+      "global/nav": [
+        {
+          "action": "start-find-replace"
+        }
+      ],
+      "commandPalette": [
+        {
+          "action": "start-find-replace"
+        }
+      ]
     },
     "configuration": {}
   },
@@ -28,7 +45,8 @@
     "serve": "yarn run symlink-package && parcel serve --no-hmr --out-file dist/find-replace.js src/find-replace.ts",
     "watch:typecheck": "tsc -p tsconfig.json -w",
     "watch:build": "tsc -p tsconfig.dist.json -w",
-    "sourcegraph:prepublish": "yarn run typecheck && yarn run build"
+    "sourcegraph:prepublish": "yarn run typecheck && yarn run build",
+    "prettier": "prettier '**/*.{ts,md}' --write --list-different"
   },
   "browserslist": [
     "last 1 Chrome versions",
@@ -43,7 +61,13 @@
     "lnfs-cli": "^2.1.0",
     "mkdirp": "^1.0.4",
     "parcel-bundler": "^1.12.4",
+    "prettier": "^2.1.2",
     "sourcegraph": "^24.7.0",
     "typescript": "^4.0.3"
+  },
+  "dependencies": {
+    "@sourcegraph/campaigns-client": "file:../campaigns-client",
+    "rxjs": "^6.6.3",
+    "slugify": "^1.4.5"
   }
 }

src/find-replace.ts

@@ -1,16 +1,6 @@
 import * as sourcegraph from 'sourcegraph'
+import { registerFindReplaceAction } from './register-action'
 
-export function activate(ctx: sourcegraph.ExtensionContext): void {
-    ctx.subscriptions.add(
-        sourcegraph.languages.registerHoverProvider(['*'], {
-            provideHover: () => ({
-                contents: {
-                    value: 'Hello world from find-replace! 🎉🎉🎉',
-                    kind: sourcegraph.MarkupKind.Markdown
-                }
-            }),
-        })
-    )
+export function activate(context: sourcegraph.ExtensionContext): void {
+    context.subscriptions.add(registerFindReplaceAction())
 }
-
-// Sourcegraph extension documentation: https://docs.sourcegraph.com/extensions/authoring

src/register-action.ts

@@ -0,0 +1,92 @@
+import { Subscription } from 'rxjs'
+import * as sourcegraph from 'sourcegraph'
+import { evaluateAndCreateCampaignSpec } from '@sourcegraph/campaigns-client'
+import slugify from 'slugify'
+import { getCurrentUser } from './util'
+
+// TODO(sqs) SECURITY(sqs): sanitize for real
+const escapedMarkdownCode = (text: string): string => '`' + text.replace(/`/g, '\\`') + '`'
+
+export const registerFindReplaceAction = (): Subscription => {
+    const subscription = new Subscription()
+    subscription.add(
+        sourcegraph.commands.registerCommand('start-find-replace', async () => {
+
+            // To create campaigns, a namespace is used, which can be the current user's username.
+            const currentUser = await getCurrentUser();
+            const namespaceName = currentUser?.username
+            console.log('currentUser', currentUser)
+
+            const match = await sourcegraph.app.activeWindow!.showInputBox({
+                prompt: 'Find all matches of:',
+            })
+            if (!match) {
+                return
+            }
+            const replacement = await sourcegraph.app.activeWindow!.showInputBox({
+                prompt: 'Replace with:',
+            })
+            if (replacement === undefined) {
+                return
+            }
+
+            const name = `replace-${slugify(match)}-with-${slugify(replacement)}`
+            const description = `Replace ${escapedMarkdownCode(match)} with ${escapedMarkdownCode(replacement)}`
+
+            let percentage = 0
+            const { applyURL, diffStat } = await sourcegraph.app.activeWindow!.withProgress(
+                { title: '**Find-replace**' },
+                async reporter =>
+                    evaluateAndCreateCampaignSpec(namespaceName, {
+                        name,
+                        on: [
+                            {
+                                repositoriesMatchingQuery: match,
+                            },
+                        ],
+                        description,
+                        steps: [
+                            {
+                                fileFilter: path =>
+                                    path.endsWith('.yaml') || path.endsWith('.yml') || path.endsWith('.md'), // TODO(sqs)
+                                editFile: (path, text) => {
+                                    if (!text.includes(match)) {
+                                        return null
+                                    }
+                                    try {
+                                        console.log('editFile running on', path)
+                                    } catch (error) {
+                                        console.error('Caught', error)
+                                    }
+
+                                    percentage += (100 - percentage) / 100
+                                    reporter.next({ message: `Computing changes in ${path}`, percentage })
+                                    return text.split(match).join(replacement)
+                                },
+                            },
+                        ],
+                        changesetTemplate: {
+                            title: description,
+                            branch: `campaign/${name}`,
+                            commit: {
+                                message: description,
+                                author: {
+                                    name: currentUser.username,
+                                    email: currentUser.email
+                                },
+                            },
+                            published: false,
+                        },
+                    })
+            )
+            await sourcegraph.app.activeWindow!.showNotification(
+                `[**Find-replace changes**](${applyURL}) are ready to preview and apply.<br/><br/><small>${diffStat.added} additions, ${diffStat.changed} changes, ${diffStat.deleted} deletions</small>`,
+                sourcegraph.NotificationType.Success
+            )
+
+            // const relativeURL = new URL(applyURL)
+            // await sourcegraph.commands.executeCommand('open', `${relativeURL.pathname}${relativeURL.search}`)
+        })
+    )
+    return subscription
+}

src/util.ts

@@ -0,0 +1,14 @@
+import sourcegraph from 'sourcegraph'
+
+export async function getCurrentUser(): Promise<{username: string, email: string}> {
+    const response = await sourcegraph.commands.executeCommand(
+        'queryGraphQL',
+        `{
+        currentUser {
+          username, email
+        }
+      }`
+    )
+    console.log('A response is going to the extension', response.data)
+    return response?.data?.currentUser
+}