feat: allow customize page size of posts list (#77)

laggage · web-flow · commit 2a47537d8b92 · 2022-10-25T13:52:21.000+08:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,7 +11,7 @@
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
     "typescript.tsc.autoDetect": "off",
     "editor.formatOnSave": true,
-    "cSpell.words": ["ASPNETCORE", "fluentui", "randomstring", "tailwindcss"],
+    "cSpell.words": ["ASPNETCORE", "fluentui", "randomstring", "singleline", "tailwindcss"],
     "json.format.enable": false,
     "eslint.alwaysShowStatus": true,
     "eslint.lintTask.enable": true,
diff --git a/package.json b/package.json
@@ -231,7 +231,7 @@
                         "scope": "application",
                         "type": "string",
                         "editPresentation": "singlelineText",
-                        "markdownDescription": "存放markdown博文的文件夹, 默认为`~/Documents/Cnblogs`, 当检测到vscode处于此工作空间时, 可以vscode-cnb插件编辑已有博文, 也可以将本地markdown文件保存到博客园"
+                        "markdownDescription": "存放博文的文件夹, 默认为`~/Documents/Cnblogs`, 当检测到vscode处于此工作空间时, 可以vscode-cnb插件编辑已有博文, 也可以将本地markdown文件保存到博客园"
                     },
                     "cnblogsClientForVSCode.windows.chromiumPath": {
                         "order": 1,
@@ -254,7 +254,7 @@
                         "default": true,
                         "scope": "application",
                         "type": "boolean",
-                        "markdownDescription": "设置是否根据博文分类保存到不同的文件夹中"
+                        "markdownDescription": "创建本地博文时, 是否根据博文分类保存到对应的文件夹中"
                     },
                     "cnblogsClientForVSCode.automaticallyExtractImages": {
                         "order": 4,
@@ -273,7 +273,27 @@
                             "自动提取全部图片"
                         ],
                         "editPresentation": "singlelineText",
-                        "description": "配置保存到博客园时要自动进行提取上传到博客园的图片"
+                        "markdownDescription": "提取图片, 配置保存到博客园时要自动提取上传到博客园的图片"
+                    },
+                    "cnblogsClientForVSCode.pageSize.postsList": {
+                        "order": 5,
+                        "default": 30,
+                        "scope": "application",
+                        "editPresentation": "singlelineText",
+                        "markdownDescription": "随笔列表分页大小, 自定义随笔列表每页展示数量",
+                        "type": "integer",
+                        "maximum": 100,
+                        "enum": [
+                            20,
+                            30,
+                            40,
+                            50,
+                            60,
+                            70,
+                            80,
+                            90,
+                            100
+                        ]
                     }
                 }
             }
diff --git a/src/commands/posts-list/refresh-posts-list.ts b/src/commands/posts-list/refresh-posts-list.ts
@@ -4,35 +4,55 @@ import vscode from 'vscode';
 import { postsDataProvider } from '../../tree-view-providers/posts-data-provider';
 import { AlertService } from '../../services/alert.service';
 import { PostsListState } from '../../models/posts-list-state';
-import { PageModel } from '../../models/page-model';
-import { Post } from '../../models/post';
 import { window } from 'vscode';
 import { extensionViews } from '../../tree-view-providers/tree-view-registration';
 
-export const refreshPostsList = async () => {
-    if (refreshing) {
+let refreshTask: Promise<any> | null = null;
+
+export const refreshPostsList = ({ queue = false } = {}): Promise<boolean> => {
+    if (refreshing && !queue) {
         alertRefreshing();
-        return;
-    }
-    await setRefreshing(true);
-    let pagedPosts: PageModel<Post> | undefined;
-    try {
-        await postsDataProvider.loadPosts();
-        pagedPosts = postsDataProvider.pagedPosts;
-        if (pagedPosts) {
-            await postService.updatePostsListState(pagedPosts);
-            updatePostsListViewTitle();
-        }
-    } catch (e) {
-        console.error('refresh posts list failed', e);
-        AlertService.error('刷新博文列表失败');
+        return refreshTask || Promise.resolve(false);
+    } else if (refreshing && refreshTask != null) {
+        return refreshTask.then(() => refreshPostsList());
     }
-    await setPostListContext(
-        pagedPosts?.pageCount ?? 0,
-        pagedPosts?.hasPrevious ?? false,
-        pagedPosts?.hasNext ?? false
+
+    refreshTask = new Promise<boolean>(resolve =>
+        setRefreshing(true).finally(() =>
+            postsDataProvider
+                .loadPosts()
+                .then(pagedPosts =>
+                    setPostListContext(
+                        pagedPosts?.pageCount ?? 0,
+                        pagedPosts?.hasPrevious ?? false,
+                        pagedPosts?.hasNext ?? false
+                    ).then(() => pagedPosts)
+                )
+                .then(pagedPosts =>
+                    pagedPosts == null
+                        ? Promise.resolve(false).finally(() => AlertService.error('刷新博文列表失败'))
+                        : postService
+                              .updatePostsListState(pagedPosts)
+                              .then(() => updatePostsListViewTitle())
+                              .then(
+                                  () => true,
+                                  () => true
+                              )
+                )
+                .catch(() => false)
+                .then(x =>
+                    setRefreshing(false).then(
+                        () => x,
+                        () => x
+                    )
+                )
+                .then(undefined, () => false)
+                .then(x => resolve(x))
+                .finally(() => (refreshTask = null))
+        )
     );
-    await setRefreshing(false);
+
+    return refreshTask;
 };
 
 export const gotoNextPostsList = async () => {
@@ -71,7 +91,9 @@ export const seekPostsList = async () => {
 let refreshing = false;
 const setRefreshing = async (value = false) => {
     const extName = globalState.extensionName;
-    await vscode.commands.executeCommand('setContext', `${extName}.posts-list.refreshing`, value);
+    await vscode.commands
+        .executeCommand('setContext', `${extName}.posts-list.refreshing`, value)
+        .then(undefined, () => false);
     refreshing = value;
 };
 
@@ -116,12 +138,14 @@ const updatePostsListViewTitle = () => {
         return;
     }
     const { pageIndex, pageCount } = state;
-    const view = extensionViews.postsList;
-    if (view) {
-        let title = view.title!;
-        const idx = title.indexOf('(');
-        const pager = `第${pageIndex}页,共${pageCount}页`;
-        title = idx >= 0 ? title.substring(0, idx) : title;
-        view.title = `${title}(${pager})`;
+    const views = [extensionViews.postsList, extensionViews.anotherPostsList];
+    for (const view of views) {
+        if (view) {
+            let title = view.title!;
+            const idx = title.indexOf('(');
+            const pager = `第${pageIndex}页,共${pageCount}页`;
+            title = idx >= 0 ? title.substring(0, idx) : title;
+            view.title = `${title}(${pager})`;
+        }
     }
 };
diff --git a/src/services/check-workspace.ts b/src/services/check-workspace.ts
@@ -1,5 +1,6 @@
 import { commands, workspace } from 'vscode';
 import { refreshPostCategoriesList } from '../commands/post-category/refresh-post-categories-list';
+import { refreshPostsList } from '../commands/posts-list/refresh-posts-list';
 import { globalState } from './global-state';
 import { PostFileMapManager } from './post-file-map';
 import { Settings } from './settings.service';
@@ -20,6 +21,9 @@ export const observeConfigurationChange = () => {
             if (ev.affectsConfiguration(`${Settings.iconThemePrefix}.${Settings.iconThemeKey}`)) {
                 refreshPostCategoriesList();
             }
+            if (ev.affectsConfiguration(`${Settings.prefix}.${Settings.postsListPageSizeKey}`)) {
+                void refreshPostsList({ queue: true });
+            }
         })
     );
     isTargetWorkspace();
diff --git a/src/services/settings.service.ts b/src/services/settings.service.ts
@@ -2,8 +2,11 @@ import { homedir, platform } from 'os';
 import fs from 'fs';
 import { ConfigurationTarget, Uri, workspace } from 'vscode';
 import { MarkdownImagesExtractor } from './images-extractor.service';
+import { isNumber } from 'lodash';
 
 export class Settings {
+    static readonly postsListPageSizeKey = 'pageSize.postsList';
+
     static get prefix() {
         return `cnblogsClientForVSCode`;
     }
@@ -81,4 +84,9 @@ export class Settings {
             this.configuration.get<MarkdownImagesExtractor['imageType']>('automaticallyExtractImages') ?? null;
         return value?.startsWith('---') ? null : value;
     }
+
+    static get postsListPageSize() {
+        let size = this.configuration.get<number>(this.postsListPageSizeKey);
+        return isNumber(size) ? size : 30;
+    }
 }
diff --git a/src/tree-view-providers/posts-data-provider.ts b/src/tree-view-providers/posts-data-provider.ts
@@ -80,20 +80,21 @@ export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem>
         } as TreeItem);
     }
 
-    async loadPosts(): Promise<void> {
+    async loadPosts(): Promise<PageModel<Post> | null> {
         try {
-            const { pageIndex, pageSize } = postService.postsListState ?? {
-                pageIndex: undefined,
-                pageSize: undefined,
-            };
+            const { pageIndex } = postService.postsListState ?? {};
+            const pageSize = Settings.postsListPageSize;
             this._pagedPosts = await postService.fetchPostsList({ pageIndex, pageSize });
             this.fireTreeDataChangedEvent(undefined);
+            return this._pagedPosts;
         } catch (ex) {
             if (ex instanceof Error) {
                 AlertService.error(ex.message);
             } else {
                 AlertService.error(`Failed to fetch posts list\n${JSON.stringify(ex)}`);
             }
+
+            return null;
         }
     }
 
