feat: pin/unpin/togglepin command (#487)

This PR add the three command for tab pinning
- `pin` ... Pin the current tab or specific tab which is matched with
the keyword.
- `unpin` ... Unpin the current tab or specific tab which is matched
with the keyword.
- `togglepin` ... Toggle the pinning of the current tab which is matched
with the keyword.

Close #478

Author: ueokande

docs/console_commands.md

@@ -98,3 +98,30 @@ the current page.
 The `:set` command can be used to temporarily override properties in the
 console. See the [properties](./properties) section for more details on
 the available properties.
+
+## `:pin`
+
+The `:pin` command pins the current tab or specific tab by URL or title keywords.
+
+```
+:pin        " pin the current tab
+:pin foobar " pin the tab with "foobar" in the title or URL
+```
+
+## `:unpin`
+
+The `:unpin` command unpins the current tab or specific tab by URL or title keywords.
+
+```
+:unpin        " unpin the current tab
+:unpin foobar " unpin the tab with "foobar" in the title or URL
+```
+
+## `:togglepin`
+
+The `:togglepin` command toggles pinning of the current tab or specific tab by URL or title keywords.
+
+```
+:togglepin        " toggle pinning of the current tab
+:togglepin foobar " toggle pinning of the tab with "foobar" in the title or URL
+```

src/background/command/BufferCommand.ts

@@ -1,13 +1,11 @@
 import type { Command, CommandContext, Completions } from "./types";
 import type { LastSelectedTabRepository } from "../repositories/LastSelectedTabRepository";
-import { BufferCommandHelper } from "./BufferCommandHelper";
+import type { TabQueryHelper } from "./TabQueryHelper";
 
 export class BufferCommand implements Command {
   constructor(
     private readonly lastSelectedTabRepository: LastSelectedTabRepository,
-    private readonly bufferCommandHelper = new BufferCommandHelper(
-      lastSelectedTabRepository,
-    ),
+    private readonly tabQueryHelper: TabQueryHelper,
   ) {}
 
   names(): string[] {
@@ -23,7 +21,9 @@ export class BufferCommand implements Command {
   }
 
   async getCompletions(_force: boolean, query: string): Promise<Completions> {
-    return this.bufferCommandHelper.getCompletions(true, query);
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: true,
+    });
   }
 
   // eslint-disable-next-line max-statements
@@ -67,7 +67,9 @@ export class BufferCommand implements Command {
       currentWindow: true,
       active: true,
     });
-    const tabs = await this.bufferCommandHelper.queryTabs(true, keywords);
+    const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+      includePinned: true,
+    });
     if (tabs.length === 0) {
       throw new RangeError("No matching buffer for " + keywords);
     }

src/background/command/BufferDeleteCommand.ts

@@ -1,8 +1,8 @@
 import type { Command, CommandContext, Completions } from "./types";
-import type { BufferCommandHelper } from "./BufferCommandHelper";
+import type { TabQueryHelper } from "./TabQueryHelper";
 
 export class BufferDeleteCommand implements Command {
-  constructor(private readonly bufferCommandHelper: BufferCommandHelper) {}
+  constructor(private readonly tabQueryHelper: TabQueryHelper) {}
 
   names(): string[] {
     return ["bd", "bdel", "bdelete"];
@@ -17,7 +17,9 @@ export class BufferDeleteCommand implements Command {
   }
 
   async getCompletions(force: boolean, query: string): Promise<Completions> {
-    return this.bufferCommandHelper.getCompletions(force, query);
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: force,
+    });
   }
 
   async exec(
@@ -26,7 +28,9 @@ export class BufferDeleteCommand implements Command {
     args: string,
   ): Promise<void> {
     const keywords = args.trim();
-    const tabs = await this.bufferCommandHelper.queryTabs(force, keywords);
+    const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+      includePinned: force,
+    });
     if (tabs.length === 0) {
       throw new Error("No matching buffer for " + keywords);
     } else if (tabs.length > 1) {

src/background/command/BufferDeletesCommand.ts

@@ -1,8 +1,8 @@
 import type { Command, CommandContext, Completions } from "./types";
-import type { BufferCommandHelper } from "./BufferCommandHelper";
+import type { TabQueryHelper } from "./TabQueryHelper";
 
 export class BufferDeletesCommand implements Command {
-  constructor(private readonly bufferCommandHelper: BufferCommandHelper) {}
+  constructor(private readonly tabQueryHelper: TabQueryHelper) {}
 
   names(): string[] {
     return ["bdeletes"];
@@ -17,7 +17,9 @@ export class BufferDeletesCommand implements Command {
   }
 
   async getCompletions(force: boolean, query: string): Promise<Completions> {
-    return this.bufferCommandHelper.getCompletions(force, query);
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: force,
+    });
   }
 
   async exec(
@@ -26,7 +28,9 @@ export class BufferDeletesCommand implements Command {
     args: string,
   ): Promise<void> {
     const keywords = args.trim();
-    const tabs = await this.bufferCommandHelper.queryTabs(force, keywords);
+    const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+      includePinned: force,
+    });
     if (tabs.length === 0) {
       throw new Error("No matching buffer for " + keywords);
     }

src/background/command/PinCommand.ts

@@ -0,0 +1,51 @@
+import type { Command, CommandContext, Completions } from "./types";
+import type { TabQueryHelper } from "./TabQueryHelper";
+import type { ConsoleClient } from "../clients/ConsoleClient";
+
+export class PinCommand implements Command {
+  constructor(
+    private readonly tabQueryHelper: TabQueryHelper,
+    private readonly consoleClient: ConsoleClient,
+  ) {}
+
+  names(): string[] {
+    return ["pin"];
+  }
+
+  fullname(): string {
+    return "pin";
+  }
+
+  description(): string {
+    return "Make a tab pinned";
+  }
+
+  getCompletions(_force: boolean, query: string): Promise<Completions> {
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: true,
+    });
+  }
+
+  async exec(
+    { sender }: CommandContext,
+    _force: boolean,
+    args: string,
+  ): Promise<void> {
+    let targetTabId: number | undefined;
+    const keywords = args.trim();
+    if (keywords.length === 0) {
+      targetTabId = sender.tabId;
+    } else {
+      const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+        includePinned: true,
+      });
+      if (tabs.length === 0) {
+        throw new Error("No matching buffer for " + keywords);
+      }
+      targetTabId = tabs[0].id!;
+    }
+
+    await chrome.tabs.update(targetTabId, { pinned: true });
+    await this.consoleClient.showInfo(sender.tabId, "Pinned tab");
+  }
+}

src/background/command/BufferCommandHelper.ts renamed to src/background/command/TabQueryHelper.ts

@@ -1,15 +1,20 @@
 import type { Completions } from "../../shared/completions";
 import type { LastSelectedTabRepository } from "../repositories/LastSelectedTabRepository";
 
-export class BufferCommandHelper {
+type TabOption = {
+  includePinned: boolean;
+};
+
+export class TabQueryHelper {
   constructor(
     private readonly lastSelectedTabRepository: LastSelectedTabRepository,
   ) {}
 
-  async getCompletions(force: boolean, query: string): Promise<Completions> {
+  // async getCompletions(force: boolean, query: string): Promise<Completions> {
+  async getCompletions(query: string, opts: TabOption): Promise<Completions> {
     const lastTabId =
       await this.lastSelectedTabRepository.getLastSelectedTabId();
-    const allTabs = await this.getAllTabs(force);
+    const allTabs = await this.getAllTabs(opts);
     const num = parseInt(query, 10);
     let tabs: chrome.tabs.Tab[] = [];
     if (!isNaN(num)) {
@@ -28,7 +33,7 @@ export class BufferCommandHelper {
         tabs = [tab];
       }
     } else {
-      tabs = await this.queryTabs(force, query);
+      tabs = await this.queryTabs(query, opts);
     }
 
     const items = tabs.map((tab) => {
@@ -50,28 +55,25 @@ export class BufferCommandHelper {
     return [{ name: "Buffers", items }];
   }
 
-  async queryTabs(force: boolean, query: string): Promise<chrome.tabs.Tab[]> {
-    const tabs = await chrome.tabs.query({ currentWindow: true });
-    const matched = tabs
+  async queryTabs(query: string, opts: TabOption): Promise<chrome.tabs.Tab[]> {
+    const tabs = await chrome.tabs.query({
+      currentWindow: true,
+      pinned: opts.includePinned ? undefined : false,
+    });
+    return tabs
       .filter((t) => {
         return (
           (t.url && t.url.toLowerCase().includes(query.toLowerCase())) ||
           (t.title && t.title.toLowerCase().includes(query.toLowerCase()))
         );
       })
       .filter((item) => item.id && item.title && item.url);
-
-    if (force) {
-      return matched;
-    }
-    return matched.filter((tab) => !tab.pinned);
   }
 
-  private async getAllTabs(force: boolean): Promise<chrome.tabs.Tab[]> {
-    const tabs = await chrome.tabs.query({ currentWindow: true });
-    if (force) {
-      return tabs;
-    }
-    return tabs.filter((tab) => !tab.pinned);
+  private async getAllTabs(opts: TabOption): Promise<chrome.tabs.Tab[]> {
+    return await chrome.tabs.query({
+      currentWindow: true,
+      pinned: opts.includePinned ? undefined : false,
+    });
   }
 }

src/background/command/TogglePinCommand.ts

@@ -0,0 +1,54 @@
+import type { Command, CommandContext, Completions } from "./types";
+import type { TabQueryHelper } from "./TabQueryHelper";
+import type { ConsoleClient } from "../clients/ConsoleClient";
+
+export class TogglePinCommand implements Command {
+  constructor(
+    private readonly tabQueryHelper: TabQueryHelper,
+    private readonly consoleClient: ConsoleClient,
+  ) {}
+
+  names(): string[] {
+    return ["togglepin"];
+  }
+
+  fullname(): string {
+    return "togglepin";
+  }
+
+  description(): string {
+    return "Toggle a tab's pinning";
+  }
+
+  getCompletions(_force: boolean, query: string): Promise<Completions> {
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: true,
+    });
+  }
+
+  async exec(
+    { sender }: CommandContext,
+    _force: boolean,
+    args: string,
+  ): Promise<void> {
+    let targetTab: chrome.tabs.Tab | undefined;
+    const keywords = args.trim();
+    if (keywords.length === 0) {
+      targetTab = sender.tab;
+    } else {
+      const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+        includePinned: true,
+      });
+      if (tabs.length === 0) {
+        throw new Error("No matching buffer for " + keywords);
+      }
+      targetTab = tabs[0];
+    }
+    if (typeof targetTab.id !== "number") {
+      return;
+    }
+
+    await chrome.tabs.update(targetTab.id, { pinned: !targetTab.pinned });
+    await this.consoleClient.showInfo(sender.tabId, "Toggled tab pinning");
+  }
+}

src/background/command/UnpinCommand.ts

@@ -0,0 +1,52 @@
+import type { Command, CommandContext, Completions } from "./types";
+import type { TabQueryHelper } from "./TabQueryHelper";
+import type { ConsoleClient } from "../clients/ConsoleClient";
+
+export class UnpinCommand implements Command {
+  constructor(
+    private readonly tabQueryHelper: TabQueryHelper,
+    private readonly consoleClient: ConsoleClient,
+  ) {}
+
+  names(): string[] {
+    return ["unpin"];
+  }
+
+  fullname(): string {
+    return "unpin";
+  }
+
+  description(): string {
+    return "Make a tab unpinned";
+  }
+
+  getCompletions(_force: boolean, query: string): Promise<Completions> {
+    return this.tabQueryHelper.getCompletions(query, {
+      includePinned: true,
+    });
+  }
+
+  async exec(
+    { sender }: CommandContext,
+    _force: boolean,
+    args: string,
+  ): Promise<void> {
+    let targetTabId: number | undefined;
+    const keywords = args.trim();
+    if (keywords.length === 0) {
+      targetTabId = sender.tabId;
+    } else {
+      const tabs = await this.tabQueryHelper.queryTabs(keywords, {
+        includePinned: true,
+      });
+      if (tabs.length === 0) {
+        throw new Error("No matching buffer for " + keywords);
+      }
+
+      targetTabId = tabs[0].id!;
+    }
+
+    await chrome.tabs.update(targetTabId, { pinned: false });
+    await this.consoleClient.showInfo(sender.tabId, "Unpinned tab");
+  }
+}