feat(posts-list): support search posts (#79)

* feat(posts-list): support search posts

* feat(posts-list/search): allow clear search result

* feat(posts-list/search): allow refresh search results

* fix(posts-list/result): fix delete not working

* fix(posts-list): make commands work for the search-result-item

* docs: add document about search posts

Author: laggage

README.md

@@ -11,6 +11,7 @@
 	- [登录 / 授权](#登录--授权)
 	- [将本地 markdown 文件发布到博客园](#将本地-markdown-文件发布到博客园)
 	- [博客园博文列表](#博客园博文列表)
+	- [搜索博文](#搜索博文)
 	- [将本地文件关联到博客园博文](#将本地文件关联到博客园博文)
 	- [拉取远程博文内容更新本地文件](#拉取远程博文内容更新本地文件)
 	- [图片上传](#图片上传)
@@ -51,6 +52,16 @@
 
 <kbd><img src="https://img2020.cnblogs.com/blog/3/202112/3-20211227184342642-1938639868.png" height="550"></kbd>
 
+### 搜索博文
+
+在博文列表的工具栏中, 包含一个搜索的图标, 点击这个图标可以触发搜索功能, 点击后会先要求输入关键词, 输入完成后按回车确认, 搜索结果将在列表中进行展示
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202210/35695-20221027141735814-276823372.png"></kbd>
+
+列表中的 `搜索结果` 那一项的工具栏包含两个可以使用的命令, 分别是 `刷新搜索结果` 和 `清除搜索结果`; 也可以通过右键上下文菜单调用这两个命令
+
+<kbd><img  src="https://img2022.cnblogs.com/blog/35695/202210/35695-20221027142035784-2094216229.png"></kbd>
+
 ### 将本地文件关联到博客园博文
 
 一个本地文件可以关联到一篇博客园博文，本地文件必须在 `vscode-cnb.workspace` 配置的工作目录中

package.json

@@ -75,6 +75,20 @@
                     "fontPath": "dist/assets/icons.woff2",
                     "fontCharacter": "\\e65b"
                 }
+            },
+            "vscode-cnb-posts-list-search": {
+                "description": "posts list search",
+                "default": {
+                    "fontPath": "dist/assets/icons.woff2",
+                    "fontCharacter": "\\e610"
+                }
+            },
+            "vscode-cnb-posts-list-search-result-summary": {
+                "description": "posts list search result summary",
+                "default": {
+                    "fontPath": "dist/assets/icons.woff2",
+                    "fontCharacter": "\\e674"
+                }
             }
         },
         "commands": [
@@ -254,6 +268,27 @@
                 "title": "提取图片",
                 "category": "Cnblogs",
                 "enablement": "vscode-cnb.isAuthorized"
+            },
+            {
+                "command": "vscode-cnb.search-posts",
+                "title": "搜索博文",
+                "category": "Cnblogs",
+                "icon": "$(vscode-cnb-posts-list-search)",
+                "enablement": "vscode-cnb.isAuthorized && !vscode-cnb.posts-list.refreshing"
+            },
+            {
+                "command": "vscode-cnb.clear-posts-search-results",
+                "title": "清除随笔搜索结果",
+                "category": "Cnblogs",
+                "icon": "$(clear-all)",
+                "enablement": "vscode-cnb.isAuthorized && !vscode-cnb.posts-list.refreshing"
+            },
+            {
+                "command": "vscode-cnb.refresh-posts-search-results",
+                "title": "刷新随笔搜索结果",
+                "category": "Cnblogs",
+                "icon": "$(refresh)",
+                "enablement": "vscode-cnb.isAuthorized && !vscode-cnb.posts-list-refreshing"
             }
         ],
         "configuration": [
@@ -400,9 +435,14 @@
                     "when": "view == cnblogs-posts-list || view == cnblogs-posts-list-another",
                     "group": "navigation@4"
                 },
+                {
+                    "command": "vscode-cnb.search-posts",
+                    "when": "view == cnblogs-posts-list || view == cnblogs-posts-list-another",
+                    "group": "navigation@5"
+                },
                 {
                     "command": "vscode-cnb.create-local-draft",
-                    "group": "navigation@5",
+                    "group": "navigation@6",
                     "when": "view == cnblogs-posts-list || view == cnblogs-posts-list-another"
                 },
                 {
@@ -581,6 +621,26 @@
                 {
                     "command": "vscode-cnb.update-post-category",
                     "when": "viewItem == cnb-post-category"
+                },
+                {
+                    "command": "vscode-cnb.refresh-posts-search-results",
+                    "when": "viewItem == cnblogs-posts-search-results-entry",
+                    "group": "inline@1"
+                },
+                {
+                    "command": "vscode-cnb.clear-posts-search-results",
+                    "when": "viewItem == cnblogs-posts-search-results-entry",
+                    "group": "inline@2"
+                },
+                {
+                    "command": "vscode-cnb.refresh-posts-search-results",
+                    "when": "viewItem == cnblogs-posts-search-results-entry",
+                    "group": "cnblogs-posts-search-results-entry@1"
+                },
+                {
+                    "command": "vscode-cnb.clear-posts-search-results",
+                    "when": "viewItem == cnblogs-posts-search-results-entry",
+                    "group": "cnblogs-posts-search-results-entry@2"
                 }
             ],
             "editor/context": [

src/assets/icons.woff2

@@ -33,6 +33,7 @@ import { viewPostOnline } from './view-post-online';
 import { exportPostToPdf } from './pdf/export-pdf.command';
 import { pullPostRemoteUpdates } from './pull-post-remote-updates';
 import { extractImages } from './extract-images';
+import { clearPostsSearchResults, refreshPostsSearchResults, searchPosts } from './posts-list/search';
 
 export const registerCommands = () => {
     const context = globalState.extensionContext;
@@ -73,6 +74,9 @@ export const registerCommands = () => {
         commands.registerCommand(`${appName}.view-post-online`, viewPostOnline),
         commands.registerCommand(`${appName}.export-post-to-pdf`, exportPostToPdf),
         commands.registerCommand(`${appName}.extract-images`, extractImages),
+        commands.registerCommand(`${appName}.search-posts`, searchPosts),
+        commands.registerCommand(`${appName}.clear-posts-search-results`, clearPostsSearchResults),
+        commands.registerCommand(`${appName}.refresh-posts-search-results`, refreshPostsSearchResults),
     ];
     context?.subscriptions.push(...disposables);
 };

src/commands/commands-registration.ts

@@ -1,12 +1,14 @@
 import { commands, Uri } from 'vscode';
 import { Post } from '../models/post';
 import { PostFileMapManager } from '../services/post-file-map';
+import { PostTreeItem } from '../tree-view-providers/models/post-tree-item';
 
-export const openPostInBlogAdmin = (item: Post | Uri) => {
+export const openPostInBlogAdmin = (item: Post | PostTreeItem | Uri) => {
     if (!item) {
         return;
     }
 
+    item = item instanceof PostTreeItem ? item.post : item;
     const postId = item instanceof Post ? item.id : PostFileMapManager.getPostId(item.fsPath) ?? -1;
 
     void commands.executeCommand('vscode.open', Uri.parse(`https://i.cnblogs.com/posts/edit;postId=${postId}`));

src/commands/open-post-in-blog-admin.ts

@@ -12,6 +12,7 @@ import { chromiumPathProvider } from '../../utils/chromium-path-provider';
 import { Settings } from '../../services/settings.service';
 import { accountService } from '../../services/account.service';
 import { AlertService } from '../../services/alert.service';
+import { PostTreeItem } from '../../tree-view-providers/models/post-tree-item';
 
 const launchBrowser = async (
     chromiumPath: string
@@ -142,9 +143,10 @@ const inputTargetFolder = async (): Promise<Uri | undefined> => {
     })) ?? [])[0];
 };
 
-const handlePostInput = (post: Post): Promise<Post[]> => {
-    const posts: Post[] = [post];
+const handlePostInput = (post: Post | PostTreeItem): Promise<Post[]> => {
+    const posts: Post[] = [post instanceof PostTreeItem ? post.post : post];
     extensionViews.visiblePostsList()?.selection.map(item => {
+        item = item instanceof PostTreeItem ? item.post : item;
         if (item instanceof Post && !posts.includes(item)) {
             posts.push(item);
         }
@@ -182,7 +184,7 @@ const reportErrors = (errors: string[] | undefined) => {
     }
 };
 
-const exportPostToPdf = async (input: Post | Uri): Promise<void> => {
+const exportPostToPdf = async (input: Post | PostTreeItem | Uri): Promise<void> => {
     const chromiumPath = await retrieveChromiumPath();
     if (!chromiumPath) {
         return;
@@ -203,7 +205,9 @@ const exportPostToPdf = async (input: Post | Uri): Promise<void> => {
             async progress => {
                 const errors: string[] = [];
                 progress.report({ message: '导出pdf - 处理博文数据' });
-                let selectedPosts = await (input instanceof Post ? handlePostInput(input) : handleUriInput(input));
+                let selectedPosts = await (input instanceof Post || input instanceof PostTreeItem
+                    ? handlePostInput(input)
+                    : handleUriInput(input));
                 if (selectedPosts.length <= 0) {
                     return;
                 }

src/commands/pdf/export-pdf.command.ts

@@ -2,6 +2,7 @@ import { MessageOptions, window } from 'vscode';
 import { Post } from '../../models/post';
 import { PostFileMap, PostFileMapManager } from '../../services/post-file-map';
 import { revealPostsListItem } from '../../services/posts-list-view';
+import { PostTreeItem } from '../../tree-view-providers/models/post-tree-item';
 import { extensionViews } from '../../tree-view-providers/tree-view-registration';
 
 const confirm = async (posts: Post[]): Promise<boolean> => {
@@ -17,9 +18,12 @@ const confirm = async (posts: Post[]): Promise<boolean> => {
     return input === options[0];
 };
 
-export const deletePostToLocalFileMap = async (post: Post) => {
+export const deletePostToLocalFileMap = async (post: Post | PostTreeItem) => {
+    post = post instanceof PostTreeItem ? post.post : post;
     const view = extensionViews.postsList!;
-    let selectedPosts = view.selection.filter(x => x instanceof Post).map(x => x as Post);
+    let selectedPosts = view.selection
+        .map(x => (x instanceof Post ? x : x instanceof PostTreeItem ? x.post : null))
+        .filter((x): x is Post => x != null);
     if (!selectedPosts.includes(post)) {
         await revealPostsListItem(post);
         selectedPosts = post ? [post] : [];

src/commands/posts-list/delete-post-to-local-file-map.ts

@@ -6,6 +6,7 @@ import { PostFileMap, PostFileMapManager } from '../../services/post-file-map';
 import { postsDataProvider } from '../../tree-view-providers/posts-data-provider';
 import { extensionViews } from '../../tree-view-providers/tree-view-registration';
 import { refreshPostsList } from './refresh-posts-list';
+import { PostTreeItem } from '../../tree-view-providers/models/post-tree-item';
 
 let deleting = false;
 
@@ -38,9 +39,19 @@ const confirmDelete = async (
     return result;
 };
 
-export const deleteSelectedPosts = async (post: Post) => {
+export const deleteSelectedPosts = async (arg: unknown) => {
+    let post: Post;
+    if (arg instanceof Post) {
+        post = arg;
+    } else if (arg instanceof PostTreeItem) {
+        post = arg.post;
+    } else {
+        return;
+    }
+
     const selectedPosts: Post[] = post ? [post] : [];
-    extensionViews.visiblePostsList()?.selection.map(post => {
+    extensionViews.visiblePostsList()?.selection.map(item => {
+        const post = item instanceof PostTreeItem ? item.post : item;
         if (post instanceof Post && !selectedPosts.includes(post)) {
             postsDataProvider.pagedPosts?.items.find(item => item === post);
             selectedPosts.push(post);

src/commands/posts-list/delete-post.ts

@@ -10,10 +10,13 @@ import fs from 'fs';
 import { LocalDraft } from '../../services/local-draft.service';
 import { saveFilePendingChanges } from '../../utils/save-file-pending-changes';
 import { postsDataProvider } from '../../tree-view-providers/posts-data-provider';
+import { PostTreeItem } from '../../tree-view-providers/models/post-tree-item';
 
-export const modifyPostSettings = async (input: Post | Uri) => {
+export const modifyPostSettings = async (input: Post | PostTreeItem | Uri) => {
     let post: Post | undefined;
     let postId = -1;
+    input = input instanceof PostTreeItem ? input.post : input;
+
     if (input instanceof Post) {
         post = input;
         postId = input.id;

src/commands/posts-list/modify-post-settings.ts

@@ -40,6 +40,12 @@ export const refreshPostsList = ({ queue = false } = {}): Promise<boolean> => {
                               )
                 )
                 .catch(() => false)
+                .then(x =>
+                    postsDataProvider.refreshSearch().then(
+                        () => x,
+                        () => x
+                    )
+                )
                 .then(x =>
                     setRefreshing(false).then(
                         () => x,