Explorer: Locate Current Buffer

browser/src/Services/Explorer/ExplorerSelectors.ts

@@ -50,6 +50,20 @@ export const isPathExpanded = (state: IExplorerState, pathToCheck: string): bool
     return !!state.expandedFolders[pathToCheck]
 }
 
+/**
+ * Extract path component from an ExplorerNode.
+ */
+export const nodePath = (node: ExplorerNode) => {
+    switch (node.type) {
+        case "file":
+            return (node as IFileNode).filePath
+        case "folder":
+            return (node as IFolderNode).folderPath
+        default:
+            return node.name
+    }
+}
+
 export const mapStateToNodeList = (state: IExplorerState): ExplorerNode[] => {
     let ret: ExplorerNode[] = []
 

browser/src/Services/Explorer/ExplorerSplit.tsx

@@ -67,6 +67,15 @@ export class ExplorerSplit {
                 rootPath: this._workspace.activeWorkspace,
             })
         }
+
+        this._commandManager.registerCommand(
+            new CallbackCommand(
+                "explorer.locate.buffer",
+                "Explorer: Locate Current Buffer",
+                "Locate current buffer in file tree",
+                () => this._locateFile(this._editorManager.activeEditor.activeBuffer.filePath),
+            ),
+        )
     }
 
     public enter(): void {
@@ -223,6 +232,14 @@ export class ExplorerSplit {
 
     private _onSelectionChanged(id: string): void {
         this._selectedId = id
+        // If we are trying to select a file, check if it's now selected, and if so trigger success.
+        const fileToSelect: string = this._store.getState().fileToSelect
+        if (fileToSelect) {
+            const selectedPath: string = ExplorerSelectors.nodePath(this._getSelectedItem())
+            if (selectedPath === fileToSelect) {
+                this._store.dispatch({ type: "SELECT_FILE_SUCCESS" })
+            }
+        }
     }
 
     private _onOpenItem(id?: string): void {
@@ -282,6 +299,10 @@ export class ExplorerSplit {
         return parentNode
     }
 
+    private _locateFile = (filePath: string) => {
+        this._store.dispatch({ type: "SELECT_FILE", filePath })
+    }
+
     private _renameItem = () => {
         const selected = this._getSelectedItem()
         if (!selected) {

browser/src/Services/Explorer/ExplorerStore.ts

@@ -107,14 +107,15 @@ export interface IExplorerState {
     rootFolder: IFolderState
 
     expandedFolders: ExpandedFolders
-
+    fileToSelect: string
     hasFocus: boolean
     register: IRegisterState
 }
 
 export const DefaultExplorerState: IExplorerState = {
     rootFolder: null,
     expandedFolders: {},
+    fileToSelect: null,
     hasFocus: false,
     register: DefaultRegisterState,
 }
@@ -192,6 +193,25 @@ export interface IExpandDirectoryResult {
     children: FolderOrFile[]
 }
 
+export interface ISelectFileAction {
+    type: "SELECT_FILE"
+    filePath: string
+}
+
+export interface ISelectFilePendingAction {
+    type: "SELECT_FILE_PENDING"
+    filePath: string
+}
+
+export interface ISelectFileSuccessAction {
+    type: "SELECT_FILE_SUCCESS"
+}
+
+export interface ISelectFileFailAction {
+    type: "SELECT_FILE_FAIL"
+    reason: string
+}
+
 export interface IEnterAction {
     type: "ENTER"
 }
@@ -308,6 +328,10 @@ export type ExplorerAction =
     | ICreateNodeCommitAction
     | ICreateNodeSuccessAction
     | INotificationSentAction
+    | ISelectFileAction
+    | ISelectFilePendingAction
+    | ISelectFileSuccessAction
+    | ISelectFileFailAction
 
 // Helper functions for Updating state ========================================================
 export const removePastedNode = (nodeArray: ExplorerNode[], ids: string[]): ExplorerNode[] =>
@@ -613,6 +637,20 @@ export const hasFocusReducer: Reducer<boolean> = (
     }
 }
 
+export const selectFileReducer: Reducer<string> = (
+    state: string = null,
+    action: ExplorerAction,
+) => {
+    switch (action.type) {
+        case "SELECT_FILE_PENDING":
+            return action.filePath
+        case "SELECT_FILE_SUCCESS":
+            return null
+        default:
+            return state
+    }
+}
+
 export const reducer: Reducer<IExplorerState> = (
     state: IExplorerState = DefaultExplorerState,
     action: ExplorerAction,
@@ -622,6 +660,7 @@ export const reducer: Reducer<IExplorerState> = (
         hasFocus: hasFocusReducer(state.hasFocus, action),
         rootFolder: rootFolderReducer(state.rootFolder, action),
         expandedFolders: expandedFolderReducer(state.expandedFolders, action),
+        fileToSelect: selectFileReducer(state.fileToSelect, action),
         register: yankRegisterReducer(state.register, action),
     }
 }
@@ -920,6 +959,35 @@ const expandDirectoryEpic: ExplorerEpic = (action$, store, { fileSystem }) =>
         return Actions.expandDirectoryResult(pathToExpand, sortedFilesAndFolders)
     })
 
+export const selectFileEpic: ExplorerEpic = (action$, store, { fileSystem }) =>
+    action$.ofType("SELECT_FILE").mergeMap(({ filePath }: ISelectFileAction): ExplorerAction[] => {
+        const rootPath = store.getState().rootFolder.fullPath
+        // Normalize, e.g. to remove trailing slash so that subsequent string comparisons work.
+        filePath = path.format(path.parse(path.normalize(filePath)))
+        // Can only select files in the workspace.
+        if (!filePath.startsWith(rootPath)) {
+            const failure: ISelectFileFailAction = {
+                type: "SELECT_FILE_FAIL",
+                reason: `File is not in workspace: ${filePath}`,
+            }
+            return [failure]
+        }
+        const relDirectoryPath = path.relative(rootPath, path.dirname(filePath))
+        const directories = relDirectoryPath.split(path.sep)
+        const actions = []
+
+        // Expand each directory in turn from the project root down to the file we want.
+        for (let dirNum = 1; dirNum <= directories.length; dirNum++) {
+            const relParentDirectoryPath = directories.slice(0, dirNum).join(path.sep)
+            const parentDirectoryPath = path.join(rootPath, relParentDirectoryPath)
+            actions.push(Actions.expandDirectory(parentDirectoryPath))
+        }
+        // Update the state with the file path we want the VimNaviator to select.
+        const pending: ISelectFilePendingAction = { type: "SELECT_FILE_PENDING", filePath }
+        actions.push(pending)
+        return actions
+    })
+
 export const createNodeEpic: ExplorerEpic = (action$, store, { fileSystem }) =>
     action$.ofType("CREATE_NODE_COMMIT").mergeMap(({ name }: ICreateNodeCommitAction) => {
         const {
@@ -946,6 +1014,7 @@ export const notificationEpic: ExplorerEpic = (action$, store, { notifications }
             "PASTE_FAIL",
             "DELETE_FAIL",
             "CREATE_NODE_FAIL",
+            "SELECT_FILE_FAIL",
         )
         .map(action => {
             switch (action.type) {
@@ -985,6 +1054,7 @@ export const notificationEpic: ExplorerEpic = (action$, store, { notifications }
                 case "DELETE_FAIL":
                 case "RENAME_FAIL":
                 case "CREATE_NODE_FAIL":
+                case "SELECT_FILE_FAIL":
                     const [type] = action.type.split("_")
                     errorNotification({
                         type,
@@ -1019,6 +1089,7 @@ export const createStore = ({
                 undoEpic,
                 deleteEpic,
                 expandDirectoryEpic,
+                selectFileEpic,
                 notificationEpic,
             ),
             { dependencies: { fileSystem, notifications } },

browser/src/Services/Explorer/ExplorerView.tsx

@@ -267,6 +267,7 @@ export interface IExplorerViewProps extends IExplorerViewContainerProps {
     nodes: ExplorerSelectors.ExplorerNode[]
     isActive: boolean
     updated: string[]
+    idToSelect: string
 }
 
 import { SidebarEmptyPaneView } from "./../../UI/components/SidebarEmptyPaneView"
@@ -293,6 +294,7 @@ export class ExplorerView extends React.PureComponent<IExplorerViewProps, {}> {
                 <VimNavigator
                     ids={ids}
                     active={this.props.isActive && !this.props.isRenaming && !this.props.isCreating}
+                    idToSelect={this.props.idToSelect}
                     onSelectionChanged={this.props.onSelectionChanged}
                     onSelected={id => this.props.onClick(id)}
                     render={(selectedId: string) => {
@@ -334,13 +336,30 @@ const mapStateToProps = (
     const yanked = state.register.yank.map(node => node.id)
     const {
         register: { updated, rename },
+        fileToSelect,
     } = state
+
+    const nodes: ExplorerSelectors.ExplorerNode[] = ExplorerSelectors.mapStateToNodeList(state)
+
+    let idToSelect: string = null
+    // If parent has told us to select a file, attempt to convert the file path into a node ID.
+    if (fileToSelect) {
+        const [nodeToSelect] = nodes.filter((node: ExplorerSelectors.ExplorerNode) => {
+            const nodePath: string = ExplorerSelectors.nodePath(node)
+            return nodePath === fileToSelect
+        })
+        if (nodeToSelect) {
+            idToSelect = nodeToSelect.id
+        }
+    }
+
     return {
         ...containerProps,
         isActive: state.hasFocus,
-        nodes: ExplorerSelectors.mapStateToNodeList(state),
+        nodes,
         updated,
         yanked,
+        idToSelect,
         isCreating: state.register.create.active,
         isRenaming: rename.active && rename.target,
     }

browser/src/UI/components/VimNavigator.tsx

@@ -35,6 +35,7 @@ export interface IVimNavigatorProps {
     render: (selectedId: string) => JSX.Element
 
     style?: React.CSSProperties
+    idToSelect?: string
 }
 
 export interface IVimNavigatorState {
@@ -127,16 +128,7 @@ export class VimNavigator extends React.PureComponent<IVimNavigatorProps, IVimNa
 
             this._activeBinding.onCursorMoved.subscribe(newValue => {
                 Log.info("[VimNavigator::onCursorMoved] - " + newValue)
-
-                if (newValue !== this.state.selectedId) {
-                    this.setState({
-                        selectedId: newValue,
-                    })
-
-                    if (this.props.onSelectionChanged) {
-                        this.props.onSelectionChanged(newValue)
-                    }
-                }
+                this._maybeUpdateSelection(newValue)
             })
 
             await this._activeBinding.setItems(this.props.ids, this.state.selectedId)
@@ -146,5 +138,19 @@ export class VimNavigator extends React.PureComponent<IVimNavigatorProps, IVimNa
         } else if (!props.active && this._activeBinding) {
             this._releaseBinding()
         }
+
+        if (props.idToSelect) {
+            this._maybeUpdateSelection(props.idToSelect)
+        }
+    }
+
+    private _maybeUpdateSelection(id: string) {
+        if (id !== this.state.selectedId) {
+            this.setState({ selectedId: id })
+
+            if (this.props.onSelectionChanged) {
+                this.props.onSelectionChanged(id)
+            }
+        }
     }
 }