feat: reveal local draft in explorer after created (#75)

laggage · web-flow · commit 0f47920ca6c6 · 2022-10-24T18:39:46.000+08:00
* feat: reveal local draft in explorer after created

* refactor: remove redundant commands about local draft

* refactor: rename LocalFileService to LocalDraft
diff --git a/package.json b/package.json
@@ -91,25 +91,12 @@
                 "category": "Cnblogs Posts List",
                 "enablement": "vscode-cnb.isAuthorized"
             },
-            {
-                "command": "vscode-cnb.delete-local-draft",
-                "title": "删除",
-                "icon": "$(trash)",
-                "category": "Cnblogs Local Draft"
-            },
             {
                 "command": "vscode-cnb.create-local-draft",
                 "title": "新建本地草稿",
                 "icon": "$(new-file)",
                 "category": "Cnblogs Local Draft"
             },
-            {
-                "command": "vscode-cnb.save-local-draft-to-cnblogs",
-                "title": "发布",
-                "icon": "dist/assets/icon-upload.svg",
-                "category": "Cnblogs Local Draft",
-                "enablement": "vscode-cnb.isAuthorized"
-            },
             {
                 "command": "vscode-cnb.modify-post-settings",
                 "title": "博文设置",
@@ -387,10 +374,6 @@
                     "command": "vscode-cnb.modify-post-settings",
                     "when": "false"
                 },
-                {
-                    "command": "vscode-cnb.save-local-draft-to-cnblogs",
-                    "when": "false"
-                },
                 {
                     "command": "vscode-cnb.delete-post",
                     "when": "false"
@@ -399,10 +382,6 @@
                     "command": "vscode-cnb.save-post-file-to-cnblogs",
                     "when": "true"
                 },
-                {
-                    "command": "vscode-cnb.delete-local-draft",
-                    "when": "false"
-                },
                 {
                     "command": "vscode-cnb.logout",
                     "when": "false"
@@ -481,24 +460,10 @@
                     "group": "inline@4",
                     "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category"
                 },
-                {
-                    "command": "vscode-cnb.save-local-draft-to-cnblogs",
-                    "when": "viewItem == cnb-local-draft-file",
-                    "group": "inline@1"
-                },
-                {
-                    "command": "vscode-cnb.delete-local-draft",
-                    "when": "viewItem == cnb-local-draft-file",
-                    "group": "inline@2"
-                },
                 {
                     "command": "vscode-cnb.create-local-draft",
                     "when": "viewItem == cnb-local-drafts-folder"
                 },
-                {
-                    "command": "vscode-cnb.delete-local-draft",
-                    "when": "viewItem == cnb-local-draft-file"
-                },
                 {
                     "command": "vscode-cnb.rename-post",
                     "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category",
diff --git a/src/commands/commands-registration.ts b/src/commands/commands-registration.ts
@@ -11,16 +11,15 @@ import {
     refreshPostsList,
     seekPostsList,
 } from './posts-list/refresh-posts-list';
-import { saveLocalDraftToCnblogs, savePostFileToCnblogs, savePostToCnblogs } from './posts-list/save-post';
+import { savePostFileToCnblogs, savePostToCnblogs } from './posts-list/save-post';
 import { createLocalDraft } from './posts-list/create-local-draft';
-import { deleteLocalDraft } from './posts-list/delete-local-draft';
 import { deleteSelectedPosts } from './posts-list/delete-post';
 import { modifyPostSettings } from './posts-list/modify-post-settings';
 import { uploadImage } from './upload-image/upload-image';
 import { revealLocalPostFileInOs } from './reveal-local-post-file-in-os';
 import { showLocalFileToPostInfo } from './show-local-file-to-post-info';
 import { newPostCategory } from './post-category/new-post-category';
-import { deleteSelectedCategories } from './post-category/delete-selected-categoriess';
+import { deleteSelectedCategories } from './post-category/delete-selected-categories';
 import { refreshPostCategoriesList } from './post-category/refresh-post-categories-list';
 import { updatePostCategory } from './post-category/update-post-category';
 import { openPostInVscode } from './posts-list/open-post-in-vscode';
@@ -54,8 +53,6 @@ export const registerCommands = () => {
         commands.registerCommand(`${appName}.modify-post-settings`, modifyPostSettings),
         commands.registerCommand(`${appName}.delete-post`, deleteSelectedPosts),
         commands.registerCommand(`${appName}.create-local-draft`, createLocalDraft),
-        commands.registerCommand(`${appName}.delete-local-draft`, deleteLocalDraft),
-        commands.registerCommand(`${appName}.save-local-draft-to-cnblogs`, saveLocalDraftToCnblogs),
         commands.registerCommand(`${appName}.save-post-file-to-cnblogs`, savePostFileToCnblogs),
         commands.registerCommand(`${appName}.pull-post-remote-updates`, pullPostRemoteUpdates),
         commands.registerCommand(`${appName}.upload-clipboard-image`, () => uploadImage(true, 'clipboard')),
diff --git a/src/commands/post-category/delete-selected-categories.ts b/src/commands/post-category/delete-selected-categories.ts
diff --git a/src/commands/posts-list/create-local-draft.ts b/src/commands/posts-list/create-local-draft.ts
@@ -1,11 +1,8 @@
 import { homedir } from 'os';
 import path = require('path');
 import { Uri, window, workspace } from 'vscode';
-import { LocalFileService } from '../../services/local-draft.service';
-import { AlertService } from '../../services/alert.service';
 import { Settings } from '../../services/settings.service';
-import { localDraftsTreeItem, postsDataProvider } from '../../tree-view-providers/posts-data-provider';
-import { extensionViews } from '../../tree-view-providers/tree-view-registration';
+import { revealActiveFileInExplorer } from '../../utils/reveal-active-file';
 import { openPostFile } from './open-post-file';
 
 export const createLocalDraft = async () => {
@@ -26,22 +23,33 @@ export const createLocalDraft = async () => {
     const { fsPath: workspacePath } = Settings.workspaceUri;
     title = ['.md', '.html'].some(ext => title!.endsWith(ext)) ? title : `${title}${title.endsWith('.') ? '' : '.'}md`;
     const filePath = path.join(workspacePath, title);
+
     try {
         await workspace.fs.stat(Uri.file(filePath));
-        AlertService.error('已存在同名文件');
-        return;
     } catch (e) {
-        // ignore
+        // 文件不存在
+        await workspace.fs.writeFile(Uri.file(filePath), new TextEncoder().encode(''));
     }
 
-    await workspace.fs.writeFile(Uri.file(filePath), new TextEncoder().encode(''));
     await openPostFile(filePath);
-    postsDataProvider.fireTreeDataChangedEvent(localDraftsTreeItem);
-    const items = (await postsDataProvider.getChildren(localDraftsTreeItem)) as LocalFileService[] | undefined;
-    if (items) {
-        const item = items.find(x => x.filePath === filePath);
-        if (item) {
-            await extensionViews.postsList?.reveal(item);
-        }
+    await revealActiveFileInExplorer();
+    // 设置中关闭了 `autoReveal` 的情况下, 需要两次调用 `workbench.files.action.showActiveFileInExplorer` 命令, 才能正确 `reveal`
+    if (!workspace.getConfiguration('explorer').get<boolean>('autoReveal')) {
+        await revealActiveFileInExplorer();
     }
+
+    const focusEditor = async () => {
+        const { activeTextEditor } = window;
+        if (activeTextEditor) {
+            await window.showTextDocument(activeTextEditor.document, { preview: false, preserveFocus: false });
+        }
+    };
+    await focusEditor();
+    // 确保能 focus 到编辑器(不这么做, 有时会聚焦到 explorer 处)
+    await new Promise<void>(resolve => {
+        const innerTimeout = setTimeout(() => {
+            clearTimeout(innerTimeout);
+            focusEditor().finally(() => resolve());
+        }, 50);
+    });
 };
diff --git a/src/commands/posts-list/delete-local-draft.ts b/src/commands/posts-list/delete-local-draft.ts
diff --git a/src/commands/posts-list/modify-post-settings.ts b/src/commands/posts-list/modify-post-settings.ts
@@ -7,7 +7,7 @@ import { revealPostsListItem } from '../../services/posts-list-view';
 import { postConfigurationPanel } from '../../services/post-configuration-panel.service';
 import path from 'path';
 import fs from 'fs';
-import { LocalFileService } from '../../services/local-draft.service';
+import { LocalDraft } from '../../services/local-draft.service';
 import { saveFilePendingChanges } from '../../utils/save-file-pending-changes';
 
 export const modifyPostSettings = async (input: Post | Uri) => {
@@ -49,7 +49,7 @@ export const modifyPostSettings = async (input: Post | Uri) => {
         beforeUpdate: async post => {
             if (localFilePath && fs.existsSync(localFilePath)) {
                 await saveFilePendingChanges(localFilePath);
-                const content = await new LocalFileService(localFilePath).readAllText();
+                const content = await new LocalDraft(localFilePath).readAllText();
                 post.postBody = content;
             }
             return true;
diff --git a/src/commands/posts-list/open-post-file.ts b/src/commands/posts-list/open-post-file.ts
@@ -1,11 +1,11 @@
 import { commands, TextDocumentShowOptions, Uri } from 'vscode';
 import { Post } from '../../models/post';
-import { LocalFileService } from '../../services/local-draft.service';
+import { LocalDraft } from '../../services/local-draft.service';
 import { PostFileMapManager } from '../../services/post-file-map';
 
-export const openPostFile = async (post: LocalFileService | Post | string, options?: TextDocumentShowOptions) => {
+export const openPostFile = async (post: LocalDraft | Post | string, options?: TextDocumentShowOptions) => {
     let filePath = '';
-    if (post instanceof LocalFileService) {
+    if (post instanceof LocalDraft) {
         filePath = post.filePath;
     } else if (post instanceof Post) {
         filePath = PostFileMapManager.getFilePath(post.id) ?? '';
diff --git a/src/commands/posts-list/save-post.ts b/src/commands/posts-list/save-post.ts
@@ -1,6 +1,6 @@
 import { Uri, workspace, window, ProgressLocation, MessageOptions } from 'vscode';
 import { Post } from '../../models/post';
-import { LocalFileService } from '../../services/local-draft.service';
+import { LocalDraft } from '../../services/local-draft.service';
 import { AlertService } from '../../services/alert.service';
 import { postService } from '../../services/post.service';
 import { PostFileMapManager } from '../../services/post-file-map';
@@ -77,13 +77,13 @@ export const savePostFileToCnblogs = async (fileUri: Uri | undefined) => {
                 }
                 break;
             case options[0]:
-                await saveLocalDraftToCnblogs(new LocalFileService(filePath));
+                await saveLocalDraftToCnblogs(new LocalDraft(filePath));
                 break;
         }
     }
 };
 
-export const saveLocalDraftToCnblogs = async (localDraft: LocalFileService) => {
+export const saveLocalDraftToCnblogs = async (localDraft: LocalDraft) => {
     if (!localDraft) {
         return;
     }
diff --git a/src/services/local-draft.service.ts b/src/services/local-draft.service.ts
@@ -1,10 +1,10 @@
 import path from 'path';
 import fs from 'fs';
-import { TreeItem, Uri, workspace } from 'vscode';
+import { Uri, workspace } from 'vscode';
 import { PostFileMapManager } from './post-file-map';
 import { Settings } from './settings.service';
 
-export class LocalFileService {
+export class LocalDraft {
     get fileName(): string {
         return path.basename(this.filePath);
     }
@@ -28,22 +28,10 @@ export class LocalFileService {
         return new TextDecoder().decode(binary);
     }
 
-    toTreeItem(): TreeItem {
-        return Object.assign(new TreeItem(this.fileName), {
-            resourceUri: Uri.file(this.filePath),
-            command: {
-                command: `vscode.open`,
-                arguments: [Uri.file(this.filePath), { preview: false }],
-                title: '编辑博文',
-            },
-            contextValue: 'cnb-local-draft-file',
-        } as TreeItem);
-    }
-
-    static async readDrafts(): Promise<LocalFileService[]> {
+    static async readDrafts(): Promise<LocalDraft[]> {
         const files = await workspace.fs.readDirectory(Settings.workspaceUri);
         return files
-            .map(x => Object.assign(new LocalFileService(path.join(`${Settings.workspaceUri.fsPath}`, x[0]))))
+            .map(x => Object.assign(new LocalDraft(path.join(`${Settings.workspaceUri.fsPath}`, x[0]))))
             .filter(
                 x => !PostFileMapManager.getPostId(x.filePath) && ['.md', '.html'].some(ext => x.fileName.endsWith(ext))
             );
diff --git a/src/tree-view-providers/posts-data-provider.ts b/src/tree-view-providers/posts-data-provider.ts
@@ -1,34 +1,15 @@
 import { homedir } from 'os';
-import {
-    Event,
-    EventEmitter,
-    MarkdownString,
-    ProviderResult,
-    ThemeIcon,
-    TreeDataProvider,
-    TreeItem,
-    TreeItemCollapsibleState,
-    Uri,
-} from 'vscode';
+import { Event, EventEmitter, MarkdownString, ProviderResult, TreeDataProvider, TreeItem, Uri } from 'vscode';
 import { refreshPostsList } from '../commands/posts-list/refresh-posts-list';
 import { Post } from '../models/post';
-import { LocalFileService } from '../services/local-draft.service';
 import { PageModel } from '../models/page-model';
 import { AlertService } from '../services/alert.service';
 import { postService } from '../services/post.service';
 import { globalState } from '../services/global-state';
 import { PostFileMapManager } from '../services/post-file-map';
 import { Settings } from '../services/settings.service';
 
-export const localDraftsTreeItem: TreeItem = Object.assign(new TreeItem('本地草稿'), {
-    iconPath: new ThemeIcon('folder'),
-    collapsibleState: TreeItemCollapsibleState.Collapsed,
-    contextValue: 'cnb-local-drafts-folder',
-    description: Settings.workspaceUri.fsPath.replace(homedir(), '~'),
-    tooltip: '在本地创建的还未保存到博客园的文章',
-} as TreeItem);
-
-export type PostDataProviderItem = Post | TreeItem | LocalFileService;
+export type PostDataProviderItem = Post | TreeItem;
 
 export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem> {
     private static _instance?: PostsDataProvider;
@@ -50,15 +31,9 @@ export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem>
 
     protected constructor() {}
 
-    getChildren(element?: PostDataProviderItem): ProviderResult<PostDataProviderItem[]> {
+    getChildren(parent?: PostDataProviderItem): ProviderResult<PostDataProviderItem[]> {
         return new Promise<PostDataProviderItem[]>(resolve => {
-            if (element === localDraftsTreeItem) {
-                LocalFileService.readDrafts().then(
-                    v => resolve(v),
-                    () => void 0
-                );
-                return;
-            } else if (!element) {
+            if (!parent) {
                 const pagedPosts = this._pagedPosts;
                 if (!pagedPosts) {
                     void refreshPostsList();
@@ -73,10 +48,7 @@ export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem>
     }
 
     getParent(el: PostDataProviderItem) {
-        if (el instanceof LocalFileService) {
-            return localDraftsTreeItem;
-        }
-        return undefined;
+        return el instanceof Post ? undefined : undefined;
     }
 
     readonly onDidChangeTreeData: Event<PostDataProviderItem | null | undefined> | undefined =
@@ -86,9 +58,7 @@ export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem>
         if (item instanceof TreeItem) {
             return item;
         }
-        if (item instanceof LocalFileService) {
-            return item.toTreeItem();
-        }
+
         const descDatePublished = item.datePublished ? `  \n发布于: ${item.datePublished}` : '';
         const localPath = PostFileMapManager.getFilePath(item.id);
         const localPathForDesc = localPath?.replace(homedir(), '~') || '未关联本地文件';
@@ -118,11 +88,11 @@ export class PostsDataProvider implements TreeDataProvider<PostDataProviderItem>
             };
             this._pagedPosts = await postService.fetchPostsList({ pageIndex, pageSize });
             this.fireTreeDataChangedEvent(undefined);
-        } catch (e) {
-            if (e instanceof Error) {
-                AlertService.error(e.message);
+        } catch (ex) {
+            if (ex instanceof Error) {
+                AlertService.error(ex.message);
             } else {
-                AlertService.error(`Failed to fetch posts list\n${JSON.stringify(e)}`);
+                AlertService.error(`Failed to fetch posts list\n${JSON.stringify(ex)}`);
             }
         }
     }
diff --git a/src/utils/reveal-active-file.ts b/src/utils/reveal-active-file.ts
@@ -0,0 +1,4 @@
+import { commands } from 'vscode';
+
+export const revealActiveFileInExplorer = async (): Promise<void> =>
+    await commands.executeCommand('workbench.files.action.showActiveFileInExplorer');

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { Uri, workspace, window, ProgressLocation, MessageOptions } from 'vscode';`
`2`	`2`	`import { Post } from '../../models/post';`
`3`		`-import { LocalFileService } from '../../services/local-draft.service';`
	`3`	`+import { LocalDraft } from '../../services/local-draft.service';`
`4`	`4`	`import { AlertService } from '../../services/alert.service';`
`5`	`5`	`import { postService } from '../../services/post.service';`
`6`	`6`	`import { PostFileMapManager } from '../../services/post-file-map';`
`@@ -77,13 +77,13 @@ export const savePostFileToCnblogs = async (fileUri: Uri \| undefined) => {`
`77`	`77`	`}`
`78`	`78`	`break;`
`79`	`79`	`case options[0]:`
`80`		`- await saveLocalDraftToCnblogs(new LocalFileService(filePath));`
	`80`	`+ await saveLocalDraftToCnblogs(new LocalDraft(filePath));`
`81`	`81`	`break;`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`	`};`
`85`	`85`
`86`		`-export const saveLocalDraftToCnblogs = async (localDraft: LocalFileService) => {`
	`86`	`+export const saveLocalDraftToCnblogs = async (localDraft: LocalDraft) => {`
`87`	`87`	`if (!localDraft) {`
`88`	`88`	`return;`
`89`	`89`	`}`