diff --git a/.gitattributes b/.gitattributes index e6e56465ad..a90407e267 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,3 +3,6 @@ # Declare text files that will always have LF line endings on checking oni eol=lf + +# Ignore the yarn library from Linguist, for the Github Language Stats. +lib/yarn/* linguist-vendored=true diff --git a/.github/config.yml b/.github/config.yml index d7d670a578..4bafd70751 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -34,3 +34,5 @@ backers: - 8832878 - 5127194 - 1764368 +- 468548 +- 2318955 diff --git a/BACKERS.md b/BACKERS.md index f57d162fe6..f84595807f 100644 --- a/BACKERS.md +++ b/BACKERS.md @@ -139,6 +139,8 @@ Thanks you to all our backers for making Oni possible! * Doug Beney * Aditya Gudimella * Michal Hantl +* Lennaert Meijvogel +* Jonas Strømsodd diff --git a/browser/src/App.ts b/browser/src/App.ts index d11731f026..ab9efcbf99 100644 --- a/browser/src/App.ts +++ b/browser/src/App.ts @@ -75,6 +75,7 @@ export const start = async (args: string[]): Promise => { const themesPromise = import("./Services/Themes") const iconThemesPromise = import("./Services/IconThemes") + const sessionManagerPromise = import("./Services/Sessions") const sidebarPromise = import("./Services/Sidebar") const overlayPromise = import("./Services/Overlay") const statusBarPromise = import("./Services/StatusBar") @@ -182,6 +183,8 @@ export const start = async (args: string[]): Promise => { pluginManager.discoverPlugins() Performance.endMeasure("Oni.Start.Plugins.Discover") + const oniApi = pluginManager.getApi() + Performance.startMeasure("Oni.Start.Themes") const Themes = await themesPromise const IconThemes = await iconThemesPromise @@ -215,7 +218,6 @@ export const start = async (args: string[]): Promise => { const StatusBar = await statusBarPromise StatusBar.activate(configuration) - const statusBar = StatusBar.getInstance() const Overlay = await overlayPromise Overlay.activate() @@ -261,7 +263,7 @@ export const start = async (args: string[]): Promise => { const tasks = Tasks.getInstance() const LanguageManager = await languageManagerPromise - LanguageManager.activate(configuration, editorManager, pluginManager, statusBar, workspace) + LanguageManager.activate(oniApi) const languageManager = LanguageManager.getInstance() Performance.startMeasure("Oni.Start.Editors") @@ -315,24 +317,9 @@ export const start = async (args: string[]): Promise => { const sidebarManager = Sidebar.getInstance() const VCSManager = await vcsManagerPromise - VCSManager.activate( - workspace, - editorManager, - statusBar, - commandManager, - menuManager, - sidebarManager, - notifications, - configuration, - ) + VCSManager.activate(oniApi, sidebarManager, notifications) - Explorer.activate( - commandManager, - configuration, - editorManager, - Sidebar.getInstance(), - workspace, - ) + Explorer.activate(oniApi, configuration, Sidebar.getInstance()) Learning.activate( commandManager, configuration, @@ -341,6 +328,10 @@ export const start = async (args: string[]): Promise => { Sidebar.getInstance(), WindowManager.windowManager, ) + + const Sessions = await sessionManagerPromise + Sessions.activate(oniApi, sidebarManager) + Performance.endMeasure("Oni.Start.Sidebar") const createLanguageClientsFromConfiguration = diff --git a/browser/src/Editor/BufferManager.ts b/browser/src/Editor/BufferManager.ts index f5419aba2d..dc183d3e2b 100644 --- a/browser/src/Editor/BufferManager.ts +++ b/browser/src/Editor/BufferManager.ts @@ -338,25 +338,29 @@ export class Buffer implements IBuffer { public handleInput(key: string): boolean { const state = this._store.getState() - const layers: IBufferLayer[] = state.layers[this._id] + const bufferLayers: IBufferLayer[] = state.layers[this._id] - if (!layers || !layers.length) { + if (!bufferLayers || !bufferLayers.length) { return false } - const result = layers.reduce((prev, curr) => { - if (prev) { - return true - } + const layerShouldHandleInput = bufferLayers.reduce( + (layerHandlerExists, currentLayer) => { + if (layerHandlerExists) { + return true + } - if (!curr || !curr.handleInput) { + if (!currentLayer || !currentLayer.handleInput) { + return false + } else if (currentLayer.isActive && currentLayer.isActive()) { + return currentLayer.handleInput(key) + } return false - } else { - return curr.handleInput(key) - } - }, false) + }, + false, + ) - return result + return layerShouldHandleInput } public async updateHighlights( tokenColors: TokenColor[], diff --git a/browser/src/Editor/Editor.ts b/browser/src/Editor/Editor.ts index 5f03741a08..8ae0222bd8 100644 --- a/browser/src/Editor/Editor.ts +++ b/browser/src/Editor/Editor.ts @@ -11,18 +11,10 @@ import * as types from "vscode-languageserver-types" import { Disposable } from "./../Utility" -export interface IEditor extends Oni.Editor { - // Methods - init(filesToOpen: string[]): void - render(): JSX.Element - - setSelection(selectionRange: types.Range): Promise -} - /** * Base class for Editor implementations */ -export class Editor extends Disposable implements Oni.Editor { +export abstract class Editor extends Disposable implements Oni.Editor { private _currentMode: string private _onBufferEnterEvent = new Event() private _onBufferLeaveEvent = new Event() @@ -44,7 +36,10 @@ export class Editor extends Disposable implements Oni.Editor { return this._onCursorMoved } + public abstract init(filesToOpen: string[]): void + // Events + public get onModeChanged(): IEvent { return this._onModeChangedEvent } @@ -90,6 +85,10 @@ export class Editor extends Disposable implements Oni.Editor { return Promise.reject("Not implemented") } + public abstract render(): JSX.Element + + public abstract setSelection(selectionRange: types.Range): Promise + protected setMode(mode: Oni.Vim.Mode): void { if (mode !== this._currentMode) { this._currentMode = mode diff --git a/browser/src/Editor/NeovimEditor/BufferLayerManager.ts b/browser/src/Editor/NeovimEditor/BufferLayerManager.ts index 1f0939b618..9c9b965a26 100644 --- a/browser/src/Editor/NeovimEditor/BufferLayerManager.ts +++ b/browser/src/Editor/NeovimEditor/BufferLayerManager.ts @@ -11,6 +11,7 @@ export type BufferFilter = (buf: Oni.Buffer) => boolean export interface IBufferLayer extends Oni.BufferLayer { handleInput?: (key: string) => boolean + isActive?: () => boolean } export const createBufferFilterFromLanguage = (language: string) => (buf: Oni.Buffer): boolean => { @@ -69,6 +70,13 @@ export class BufferLayerManager { } } +const getInstance = (() => { + const instance = new BufferLayerManager() + return () => instance +})() + +export default getInstance + export const wrapReactComponentWithLayer = ( id: string, component: JSX.Element, diff --git a/browser/src/Editor/NeovimEditor/Definition.ts b/browser/src/Editor/NeovimEditor/Definition.ts index 733c707501..09bf748ba2 100644 --- a/browser/src/Editor/NeovimEditor/Definition.ts +++ b/browser/src/Editor/NeovimEditor/Definition.ts @@ -19,7 +19,7 @@ export enum OpenType { export class Definition { constructor(private _editor: Oni.Editor, private _store: Store) {} - public async gotoDefinitionUnderCursor(openType: OpenType = OpenType.NewTab): Promise { + public async gotoDefinitionUnderCursor(openOptions?: Oni.FileOpenOptions): Promise { const activeDefinition = this._store.getState().definition if (!activeDefinition) { @@ -31,33 +31,21 @@ export class Definition { const line = range.start.line const column = range.start.character - await this.gotoPositionInUri(uri, line, column, openType) + await this.gotoPositionInUri(uri, line, column, openOptions) } public async gotoPositionInUri( uri: string, line: number, column: number, - openType: OpenType = OpenType.NewTab, + openOptions?: Oni.FileOpenOptions, ): Promise { const filePath = Helpers.unwrapFileUriPath(uri) const activeEditor = this._editor - const command = this._getCommandFromOpenType(openType) - await activeEditor.neovim.command(`${command} ${filePath}`) + await this._editor.openFile(filePath, openOptions) await activeEditor.neovim.command(`cal cursor(${line + 1}, ${column + 1})`) await activeEditor.neovim.command("norm zz") } - - private _getCommandFromOpenType(openType: OpenType) { - switch (openType) { - case OpenType.SplitVertical: - return "vsp" - case OpenType.SplitHorizontal: - return "sp" - default: - return "e" - } - } } diff --git a/browser/src/Editor/NeovimEditor/HoverRenderer.tsx b/browser/src/Editor/NeovimEditor/HoverRenderer.tsx index 893acd13b9..15cf3e049b 100644 --- a/browser/src/Editor/NeovimEditor/HoverRenderer.tsx +++ b/browser/src/Editor/NeovimEditor/HoverRenderer.tsx @@ -8,9 +8,9 @@ import * as React from "react" import * as types from "vscode-languageserver-types" import getTokens from "./../../Services/SyntaxHighlighting/TokenGenerator" -import { enableMouse } from "./../../UI/components/common" +import styled, { enableMouse } from "./../../UI/components/common" import { ErrorInfo } from "./../../UI/components/ErrorInfo" -import { QuickInfoElement, QuickInfoWrapper } from "./../../UI/components/QuickInfo" +import { QuickInfoElement } from "./../../UI/components/QuickInfo" import QuickInfoWithTheme from "./../../UI/components/QuickInfoContainer" import * as Helpers from "./../../Plugins/Api/LanguageClient/LanguageClientHelpers" @@ -22,7 +22,9 @@ import { IToolTipsProvider } from "./ToolTipsProvider" const HoverToolTipId = "hover-tool-tip" -const HoverRendererContainer = QuickInfoWrapper.extend` +const HoverRendererContainer = styled.div` + user-select: none; + cursor: default; ${enableMouse}; ` diff --git a/browser/src/Editor/NeovimEditor/NeovimBufferLayersView.tsx b/browser/src/Editor/NeovimEditor/NeovimBufferLayersView.tsx index 1f6984bd76..7e3f6a69f2 100644 --- a/browser/src/Editor/NeovimEditor/NeovimBufferLayersView.tsx +++ b/browser/src/Editor/NeovimEditor/NeovimBufferLayersView.tsx @@ -14,8 +14,7 @@ import { NeovimActiveWindow } from "./NeovimActiveWindow" import * as State from "./NeovimEditorStore" -import { StackLayer } from "../../UI/components/common" -import { EmptyArray } from "./../../Utility" +import styled, { StackLayer } from "../../UI/components/common" export interface NeovimBufferLayersViewProps { activeWindowId: number @@ -25,23 +24,26 @@ export interface NeovimBufferLayersViewProps { fontPixelHeight: number } -const InnerLayerStyle: React.CSSProperties = { - position: "absolute", - top: "0px", - left: "0px", - right: "0px", - bottom: "0px", - overflowY: "auto", - overflowX: "auto", +const InnerLayer = styled.div` + position: absolute; + top: 0px; + left: 0px; + right: 0px; + bottom: 0px; + overflow: hidden; +` + +export interface LayerContextWithCursor extends Oni.BufferLayerRenderContext { + cursorLine: number + cursorColumn: number } export class NeovimBufferLayersView extends React.PureComponent { public render(): JSX.Element { const containers = this.props.windows.map(windowState => { - const layers = - this.props.layers[windowState.bufferId] || (EmptyArray as Oni.BufferLayer[]) + const layers: Oni.BufferLayer[] = this.props.layers[windowState.bufferId] || [] - const layerContext: Oni.BufferLayerRenderContext = { + const layerContext: LayerContextWithCursor = { isActive: windowState.windowId === this.props.activeWindowId, windowId: windowState.windowId, fontPixelWidth: this.props.fontPixelWidth, @@ -53,22 +55,15 @@ export class NeovimBufferLayersView extends React.PureComponent { + const layerElements = layers.map(layer => { return ( -
- {l.render(layerContext)} -
+ + {layer.render(layerContext)} + ) }) diff --git a/browser/src/Editor/NeovimEditor/NeovimEditor.tsx b/browser/src/Editor/NeovimEditor/NeovimEditor.tsx index b12f05d157..383fb6b44c 100644 --- a/browser/src/Editor/NeovimEditor/NeovimEditor.tsx +++ b/browser/src/Editor/NeovimEditor/NeovimEditor.tsx @@ -1,7 +1,7 @@ /** * NeovimEditor.ts * - * IEditor implementation for Neovim + * Editor implementation for Neovim */ import * as os from "os" @@ -44,6 +44,7 @@ import { Completion, CompletionProviders } from "./../../Services/Completion" import { Configuration, IConfigurationValues } from "./../../Services/Configuration" import { IDiagnosticsDataSource } from "./../../Services/Diagnostics" import { Overlay, OverlayManager } from "./../../Services/Overlay" +import { ISession } from "./../../Services/Sessions" import { SnippetManager } from "./../../Services/Snippets" import { TokenColors } from "./../../Services/TokenColors" @@ -66,9 +67,9 @@ import { IThemeMetadata, ThemeManager } from "./../../Services/Themes" import { TypingPredictionManager } from "./../../Services/TypingPredictionManager" import { Workspace } from "./../../Services/Workspace" -import { Editor, IEditor } from "./../Editor" +import { Editor } from "./../Editor" -import { BufferManager, IBuffer } from "./../BufferManager" +import { BufferManager } from "./../BufferManager" import { CompletionMenu } from "./CompletionMenu" import { HoverRenderer } from "./HoverRenderer" import { NeovimPopupMenu } from "./NeovimPopupMenu" @@ -80,7 +81,7 @@ import { asObservable, normalizePath, sleep } from "./../../Utility" import * as VimConfigurationSynchronizer from "./../../Services/VimConfigurationSynchronizer" -import { BufferLayerManager } from "./BufferLayerManager" +import getLayerManagerInstance from "./BufferLayerManager" import { Definition } from "./Definition" import * as ActionCreators from "./NeovimEditorActions" import { NeovimEditorCommands } from "./NeovimEditorCommands" @@ -93,13 +94,13 @@ import CommandLine from "./../../UI/components/CommandLine" import ExternalMenus from "./../../UI/components/ExternalMenus" import WildMenu from "./../../UI/components/WildMenu" -import { WelcomeBufferLayer } from "./WelcomeBufferLayer" - import { CanvasRenderer } from "../../Renderer/CanvasRenderer" import { WebGLRenderer } from "../../Renderer/WebGL/WebGLRenderer" import { getInstance as getNotificationsInstance } from "./../../Services/Notifications" -export class NeovimEditor extends Editor implements IEditor { +type NeovimError = [number, string] + +export class NeovimEditor extends Editor implements Oni.Editor { private _bufferManager: BufferManager private _neovimInstance: NeovimInstance private _renderer: INeovimRenderer @@ -119,6 +120,7 @@ export class NeovimEditor extends Editor implements IEditor { private _modeChanged$: Observable private _cursorMoved$: Observable private _cursorMovedI$: Observable + private _onScroll$: Observable private _hasLoaded: boolean = false @@ -141,9 +143,10 @@ export class NeovimEditor extends Editor implements IEditor { private _toolTipsProvider: IToolTipsProvider private _commands: NeovimEditorCommands private _externalMenuOverlay: Overlay - private _bufferLayerManager: BufferLayerManager + private _bufferLayerManager = getLayerManagerInstance() private _screenWithPredictions: ScreenWithPredictions + private _onShowWelcomeScreen = new Event() private _onNeovimQuit: Event = new Event() private _autoFocus: boolean = true @@ -152,6 +155,10 @@ export class NeovimEditor extends Editor implements IEditor { return this._onNeovimQuit } + public get onShowWelcomeScreen() { + return this._onShowWelcomeScreen + } + public get /* override */ activeBuffer(): Oni.Buffer { return this._bufferManager.getBufferById(this._lastBufferId) } @@ -161,7 +168,7 @@ export class NeovimEditor extends Editor implements IEditor { return this._neovimInstance } - public get bufferLayers(): BufferLayerManager { + public get bufferLayers() { return this._bufferLayerManager } @@ -200,8 +207,6 @@ export class NeovimEditor extends Editor implements IEditor { this._actions = bindActionCreators(ActionCreators as any, this._store.dispatch) this._toolTipsProvider = new NeovimEditorToolTipsProvider(this._actions) - this._bufferLayerManager = new BufferLayerManager() - this._contextMenuManager = new ContextMenuManager(this._toolTipsProvider, this._colors) this._neovimInstance = new NeovimInstance(100, 100, this._configuration) @@ -307,7 +312,7 @@ export class NeovimEditor extends Editor implements IEditor { // Services const onColorsChanged = () => { - const updatedColors: any = this._colors.getColors() + const updatedColors = this._colors.getColors() this._actions.setColors(updatedColors) } @@ -603,6 +608,7 @@ export class NeovimEditor extends Editor implements IEditor { }) this._modeChanged$ = asObservable(this._neovimInstance.onModeChanged) + this._onScroll$ = asObservable(this._neovimInstance.onScroll) this.trackDisposable( this._neovimInstance.onModeChanged.subscribe(newMode => this._onModeChanged(newMode)), @@ -643,6 +649,7 @@ export class NeovimEditor extends Editor implements IEditor { addInsertModeLanguageFunctionality( this._cursorMovedI$, this._modeChanged$, + this._onScroll$, this._toolTipsProvider, ) @@ -830,6 +837,12 @@ export class NeovimEditor extends Editor implements IEditor { this._neovimInstance.autoCommands.executeAutoCommand("FocusLost") } + public async createWelcomeBuffer() { + const buf = await this.openFile("WELCOME") + await buf.setScratchBuffer() + return buf + } + public async clearSelection(): Promise { await this._neovimInstance.input("") await this._neovimInstance.input("a") @@ -888,6 +901,31 @@ export class NeovimEditor extends Editor implements IEditor { ) } + // "v:this_session" |this_session-variable| - is a variable nvim sets to the path of + // the current session file when one is loaded we use it here to check the current session + // if it in oni's session dir then this is updated + public async getCurrentSession(): Promise { + const result = await this._neovimInstance.request("nvim_get_vvar", [ + "this_session", + ]) + + if (Array.isArray(result)) { + return this._handleNeovimError(result) + } + return result + } + + public async persistSession(session: ISession) { + const result = await this._neovimInstance.command(`mksession! ${session.file}`) + return this._handleNeovimError(result) + } + + public async restoreSession(session: ISession) { + await this._neovimInstance.closeAllBuffers() + const result = await this._neovimInstance.command(`source ${session.file}`) + return this._handleNeovimError(result) + } + public async openFile( file: string, openOptions: Oni.FileOpenOptions = Oni.DefaultFileOpenOptions, @@ -1005,8 +1043,7 @@ export class NeovimEditor extends Editor implements IEditor { await this.openFiles(filesToOpen, { openMode: Oni.FileOpenMode.Edit }) } else { if (this._configuration.getValue("experimental.welcome.enabled")) { - const buf = await this.openFile("WELCOME") - buf.addLayer(new WelcomeBufferLayer()) + this._onShowWelcomeScreen.dispatch() } } @@ -1071,8 +1108,8 @@ export class NeovimEditor extends Editor implements IEditor { { const textToPaste = clipboard.readText() - const sanitizedText = replaceAll(textToPaste, { "<": "" }) - .split(os.EOL) - .join("") + const replacements = { "'": "''" } + replacements[os.EOL] = "\n" + const sanitizedTextLines = replaceAll(textToPaste, replacements) + await neovimInstance.command('let b:oniclipboard=@"') + await neovimInstance.command(`let @"='${sanitizedTextLines}'`) + + if ( + editorManager.activeEditor.mode === "insert" || + editorManager.activeEditor.mode === "cmdline_normal" + ) { + await neovimInstance.command("set paste") + await neovimInstance.input('"') + await neovimInstance.command("set nopaste") + } else { + await neovimInstance.command("normal! p") + } - await neovimInstance.command("set paste") - await neovimInstance.input(sanitizedText) - await neovimInstance.command("set nopaste") + await neovimInstance.command('let @"=b:oniclipboard') + await neovimInstance.command("unlet b:oniclipboard") } const commands = [ @@ -116,7 +129,13 @@ export class NeovimEditorCommands { "editor.clipboard.yank", "Clipboard: Yank", "Yank contents to clipboard", - () => this._neovimInstance.input("y"), + () => this._neovimInstance.command('normal! "+y'), + ), + new CallbackCommand( + "editor.clipboard.cut", + "Clipboard: Cut", + "Cut contents to clipboard", + () => this._neovimInstance.command('normal! "+x'), ), new CallbackCommand("oni.editor.findAllReferences", null, null, () => findAllReferences(), @@ -141,10 +160,25 @@ export class NeovimEditorCommands { () => this._definition.gotoDefinitionUnderCursor(), ), new CallbackCommand("language.gotoDefinition.openVertical", null, null, () => - this._definition.gotoDefinitionUnderCursor(1), + this._definition.gotoDefinitionUnderCursor({ + openMode: Oni.FileOpenMode.VerticalSplit, + }), ), new CallbackCommand("language.gotoDefinition.openHorizontal", null, null, () => - this._definition.gotoDefinitionUnderCursor(2), + this._definition.gotoDefinitionUnderCursor({ + openMode: Oni.FileOpenMode.HorizontalSplit, + }), + ), + new CallbackCommand("language.gotoDefinition.openNewTab", null, null, () => + this._definition.gotoDefinitionUnderCursor({ openMode: Oni.FileOpenMode.NewTab }), + ), + new CallbackCommand("language.gotoDefinition.openEdit", null, null, () => + this._definition.gotoDefinitionUnderCursor({ openMode: Oni.FileOpenMode.Edit }), + ), + new CallbackCommand("language.gotoDefinition.openExistingTab", null, null, () => + this._definition.gotoDefinitionUnderCursor({ + openMode: Oni.FileOpenMode.ExistingTab, + }), ), new CallbackCommand("editor.rename", "Rename", "Rename an item", () => diff --git a/browser/src/Editor/NeovimEditor/NeovimSurface.tsx b/browser/src/Editor/NeovimEditor/NeovimSurface.tsx index a630f8aae0..fde65dcaab 100644 --- a/browser/src/Editor/NeovimEditor/NeovimSurface.tsx +++ b/browser/src/Editor/NeovimEditor/NeovimSurface.tsx @@ -87,7 +87,7 @@ class NeovimSurface extends React.Component { screen={this.props.screen} /> - + diff --git a/browser/src/Editor/NeovimEditor/WelcomeBufferLayer.tsx b/browser/src/Editor/NeovimEditor/WelcomeBufferLayer.tsx index 18cdc5d6f1..506b580bac 100644 --- a/browser/src/Editor/NeovimEditor/WelcomeBufferLayer.tsx +++ b/browser/src/Editor/NeovimEditor/WelcomeBufferLayer.tsx @@ -4,39 +4,29 @@ * IEditor implementation for Neovim */ -import * as React from "react" - -import styled, { keyframes } from "styled-components" - -import { inputManager, InputManager } from "./../../Services/InputManager" - import * as Oni from "oni-api" +import * as Log from "oni-core-logging" +import { Event } from "oni-types" +import * as React from "react" -import { withProps } from "./../../UI/components/common" -import { VimNavigator } from "./../../UI/components/VimNavigator" - -const WelcomeWrapper = withProps<{}>(styled.div)` - background-color: ${p => p.theme["editor.background"]}; - color: ${p => p.theme["editor.foreground"]}; - - overflow-y: auto; - -webkit-user-select: none; - - width: 100%; - height: 100%; - opacity: 0; -` +import { getMetadata } from "./../../Services/Metadata" +import { ISession, SessionManager } from "./../../Services/Sessions" +import styled, { + boxShadowInset, + Css, + css, + enableMouse, + getSelectedBorder, + keyframes, + lighten, +} from "./../../UI/components/common" +import { Icon } from "./../../UI/Icon" // const entrance = keyframes` // 0% { opacity: 0; transform: translateY(2px); } // 100% { opacity: 0.5; transform: translateY(0px); } // ` -const entranceFull = keyframes` - 0% { opacity: 0; transform: translateY(8px); } - 100% { opacity: 1; transform: translateY(0px); } -` - // const enterLeft = keyframes` // 0% { opacity: 0; transform: translateX(-4px); } // 100% { opacity: 1; transform: translateX(0px); } @@ -47,22 +37,85 @@ const entranceFull = keyframes` // 100% { opacity: 1; transform: translateX(0px); } // ` -const Column = styled.div` +const entranceFull = keyframes` + 0% { + opacity: 0; + transform: translateY(8px); + } + 100% { + opacity: 1; + transform: translateY(0px); + } +` +const WelcomeWrapper = styled.div` + background-color: ${p => p.theme["editor.background"]}; + color: ${p => p.theme["editor.foreground"]}; + overflow-y: hidden; + user-select: none; + pointer-events: all; + width: 100%; + height: 100%; + opacity: 0; + animation: ${entranceFull} 0.25s ease-in 0.1s forwards ${enableMouse}; +` + +interface IColumnProps { + alignment?: string + justify?: string + flex?: string + height?: string + extension?: Css +} + +const Column = styled("div")` + background: inherit; display: flex; - justify-content: center; - align-items: center; + justify-content: ${({ justify }) => justify || `center`}; + align-items: ${({ alignment }) => alignment || "center"}; flex-direction: column; - width: 100%; - flex: 1 1 auto; + flex: ${({ flex }) => flex || "1"}; + height: ${({ height }) => height || `auto`}; + ${({ extension }) => extension}; +` + +const sectionStyles = css` + display: flex; + flex-direction: column; + justify-content: flex-start; + align-items: center; + height: 90%; + overflow-y: hidden; + direction: rtl; + &:hover { + overflow-y: overlay; + } + & > * { + direction: ltr; + } +` + +const LeftColumn = styled.div` + ${sectionStyles}; + padding: 0; + padding-left: 1rem; + overflow-y: hidden; + width: 60%; +` + +const RightColumn = styled.div` + ${sectionStyles}; + width: 30%; + border-left: 1px solid ${({ theme }) => theme["editor.background"]}; ` -const Row = styled.div` +const Row = styled<{ extension?: Css }, "div">("div")` display: flex; justify-content: center; align-items: center; flex-direction: row; opacity: 0; + ${({ extension }) => extension}; ` const TitleText = styled.div` @@ -81,13 +134,12 @@ const HeroImage = styled.img` opacity: 0.4; ` -const SectionHeader = styled.div` +export const SectionHeader = styled.div` margin-top: 1em; margin-bottom: 1em; - - font-size: 1.1em; + font-size: 1.2em; font-weight: bold; - text-align: center; + text-align: left; width: 100%; ` @@ -96,67 +148,135 @@ const WelcomeButtonHoverStyled = ` box-shadow: 0 4px 8px 2px rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19); ` -// box-shadow: 0 4px 8px 2px rgba(0, 0, 0, 0.1), 0 6px 20px 0 rgba(0, 0, 0, 0.1); - export interface WelcomeButtonWrapperProps { - selected: boolean + isSelected: boolean + borderSize: string } -const WelcomeButtonWrapper = withProps(styled.div)` +const WelcomeButtonWrapper = styled("button")` + box-sizing: border-box; + font-size: inherit; + font-family: inherit; border: 0px solid ${props => props.theme.foreground}; - border-left: ${props => - props.selected - ? "4px solid " + props.theme["highlight.mode.normal.background"] - : "4px solid transparent"}; + border-left: ${getSelectedBorder}; border-right: 4px solid transparent; - color: ${props => props.theme.foreground}; - background-color: ${props => props.theme.background}; - cursor: pointer; - + color: ${({ theme }) => theme.foreground}; + background-color: ${({ theme }) => lighten(theme.background)}; + transform: ${({ isSelected }) => (isSelected ? "translateX(-4px)" : "translateX(0px)")}; transition: transform 0.25s; - transform: ${props => (props.selected ? "translateX(-4px)" : "translateX(0px)")}; - width: 100%; - margin: 8px 0px; - padding: 8px; - + margin: 0.8em 0; + padding: 0.8em; display: flex; flex-direction: row; - &:hover { - ${WelcomeButtonHoverStyled} + ${WelcomeButtonHoverStyled}; } +` +const AnimatedContainer = styled<{ duration: string }, "div">("div")` + width: 100%; + animation: ${entranceFull} ${p => p.duration} ease-in 1s both; ` const WelcomeButtonTitle = styled.span` - font-size: 1.1em; + font-size: 1em; font-weight: bold; - margin: 4px; + margin: 0.4em; width: 100%; + text-align: left; ` const WelcomeButtonDescription = styled.span` font-size: 0.8em; opacity: 0.75; margin: 4px; - width: 100%; text-align: right; ` +const boxStyling = css` + width: 60%; + height: 60%; + padding: 0 1em; + opacity: 1; + margin-top: 64px; + box-sizing: border-box; + border: 1px solid ${p => p.theme["editor.hover.contents.background"]}; + border-radius: 4px; + overflow: hidden; + justify-content: space-around; + background-color: ${p => p.theme["editor.hover.contents.codeblock.background"]}; + ${boxShadowInset}; +` + +const titleRow = css` + width: 100%; + padding-top: 32px; + animation: ${entranceFull} 0.25s ease-in 0.25s forwards}; +` + +const selectedSectionItem = css` + ${({ theme }) => ` + text-decoration: underline; + color: ${theme["highlight.mode.normal.background"]}; + `}; +` + +export const SectionItem = styled<{ isSelected?: boolean }, "li">("li")` + width: 100%; + margin: 0.2em; + text-align: left; + height: auto; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + ${({ isSelected }) => isSelected && selectedSectionItem}; + + &:hover { + text-decoration: underline; + } +` + +export const SessionsList = styled.ul` + width: 70%; + margin: 0; + list-style-type: none; + border-radius: 4px; + padding: 0 1em; + border: 1px solid ${p => p.theme["editor.hover.contents.codeblock.background"]}; +` + export interface WelcomeButtonProps { title: string description: string command: string selected: boolean + onClick: () => void +} + +interface IChromeDiv extends HTMLButtonElement { + scrollIntoViewIfNeeded: () => void } -export class WelcomeButton extends React.PureComponent { - public render(): JSX.Element { +export class WelcomeButton extends React.PureComponent { + private _button = React.createRef() + + public componentDidUpdate(prevProps: WelcomeButtonProps) { + if (!prevProps.selected && this.props.selected) { + this._button.current.scrollIntoViewIfNeeded() + } + } + + public render() { return ( - + {this.props.title} {this.props.description} @@ -168,194 +288,342 @@ export interface WelcomeHeaderState { version: string } +export interface OniWithActiveSection extends Oni.Plugin.Api { + sessions: SessionManager + getActiveSection(): string +} + +type ExecuteCommand = (command: string, args?: T) => void + +export interface IWelcomeInputEvent { + select: boolean + vertical: number + horizontal?: number +} + +interface ICommandMetadata { + command: string + args?: T +} + +export interface IWelcomeCommandsDictionary { + openFile: ICommandMetadata + openTutor: ICommandMetadata + openDocs: ICommandMetadata + openConfig: ICommandMetadata + openThemes: ICommandMetadata + openWorkspaceFolder: ICommandMetadata + commandPalette: ICommandMetadata + commandline: ICommandMetadata +} + export class WelcomeBufferLayer implements Oni.BufferLayer { - public get id(): string { + public inputEvent = new Event() + + public readonly welcomeCommands: IWelcomeCommandsDictionary = { + openFile: { command: "oni.editor.newFile" }, + openWorkspaceFolder: { command: "workspace.openFolder" }, + commandPalette: { command: "quickOpen.show" }, + commandline: { command: "executeVimCommand" }, + openTutor: { command: "oni.tutor.open" }, + openDocs: { command: "oni.docs.open" }, + openConfig: { command: "oni.config.openUserConfig" }, + openThemes: { command: "oni.themes.open" }, + } + + constructor(private _oni: OniWithActiveSection) {} + + public get id() { return "oni.welcome" } - public get friendlyName(): string { + public get friendlyName() { return "Welcome" } - public render(context: Oni.BufferLayerRenderContext): JSX.Element { + public isActive(): boolean { + const activeSection = this._oni.getActiveSection() + return activeSection === "editor" + } + + public handleInput(key: string) { + Log.info(`ONI WELCOME INPUT KEY: ${key}`) + switch (key) { + case "j": + this.inputEvent.dispatch({ vertical: 1, select: false }) + break + case "k": + this.inputEvent.dispatch({ vertical: -1, select: false }) + break + case "l": + this.inputEvent.dispatch({ vertical: 0, select: false, horizontal: 1 }) + break + case "h": + this.inputEvent.dispatch({ vertical: 0, select: false, horizontal: -1 }) + break + case "": + this.inputEvent.dispatch({ vertical: 0, select: true }) + break + default: + this.inputEvent.dispatch({ vertical: 0, select: false }) + } + } + + public executeCommand: ExecuteCommand = (cmd, args) => { + if (cmd) { + this._oni.commands.executeCommand(cmd, args) + } + } + + public restoreSession = async (name: string) => { + await this._oni.sessions.restoreSession(name) + } + + public getProps() { + const active = this._oni.getActiveSection() === "editor" + const commandIds = Object.values(this.welcomeCommands).map(({ command }) => command) + const sessions = this._oni.sessions ? this._oni.sessions.allSessions : ([] as ISession[]) + const sessionIds = sessions.map(({ id }) => id) + const ids = [...commandIds, ...sessionIds] + const sections = [commandIds.length, sessionIds.length].filter(Boolean) + + return { active, ids, sections, sessions } + } + + public render(context: Oni.BufferLayerRenderContext) { + const props = this.getProps() return ( - - + + ) } } export interface WelcomeViewProps { - inputManager: InputManager + active: boolean + sessions: ISession[] + sections: number[] + ids: string[] + inputEvent: Event + commands: IWelcomeCommandsDictionary + getMetadata: () => Promise<{ version: string }> + restoreSession: (name: string) => Promise + executeCommand: ExecuteCommand } export interface WelcomeViewState { version: string + selectedId: string + currentIndex: number } -import { getMetadata } from "./../../Services/Metadata" +export class WelcomeView extends React.PureComponent { + public state: WelcomeViewState = { + version: null, + currentIndex: 0, + selectedId: this.props.ids[0], + } -export const ButtonIds = [ - "oni.tutor.open", - "oni.docs.open", - "oni.configuration.open", - "oni.themes.open", - "workspace.newFile", - "workspace.openFolder", - "tasks.show", - "editor.openExCommands", -] + private _welcomeElement = React.createRef() -export class WelcomeView extends React.PureComponent { - constructor(props: WelcomeViewProps) { - super(props) + public async componentDidMount() { + const metadata = await this.props.getMetadata() + this.setState({ version: metadata.version }) + this.props.inputEvent.subscribe(this.handleInput) + } + + public handleInput = async ({ vertical, select, horizontal }: IWelcomeInputEvent) => { + const { currentIndex } = this.state + const { sections, ids, executeCommand, active } = this.props - this.state = { - version: null, + const newIndex = this.getNextIndex(currentIndex, vertical, horizontal, sections) + const selectedId = ids[newIndex] + this.setState({ currentIndex: newIndex, selectedId }) + + const selectedSession = this.props.sessions.find(session => session.id === selectedId) + + if (select && active) { + if (selectedSession) { + await this.props.restoreSession(selectedSession.name) + } else { + const currentCommand = this.getCurrentCommand(selectedId) + executeCommand(currentCommand.command, currentCommand.args) + } } } - public componentDidMount(): void { - getMetadata().then(metadata => { - this.setState({ - version: metadata.version, - }) - }) + public getCurrentCommand(selectedId: string): ICommandMetadata { + const { commands } = this.props + const currentCommand = Object.values(commands).find(({ command }) => command === selectedId) + return currentCommand + } + + public getNextIndex( + currentIndex: number, + vertical: number, + horizontal: number, + sections: number[], + ) { + const nextPosition = currentIndex + vertical + const numberOfItems = this.props.ids.length + const multipleSections = sections.length > 1 + + // TODO: this currently handles *TWO* sections if more sections + // are to be added will need to rethink how to allow navigation across multiple sections + switch (true) { + case multipleSections && horizontal === 1: + return sections[0] + case multipleSections && horizontal === -1: + return 0 + case nextPosition < 0: + return numberOfItems - 1 + case nextPosition === numberOfItems: + return 0 + default: + return nextPosition + } } - public render(): JSX.Element { - if (!this.state.version) { - return null + public componentDidUpdate() { + if (this.props.active && this._welcomeElement && this._welcomeElement.current) { + this._welcomeElement.current.focus() } + } + public render() { + const { version, selectedId } = this.state return ( - - + + - + Oni Modern Modal Editing - + - - {"v" + this.state.version} + + {version && {`v${version}`}}
{"https://onivim.io"}
 - - - ( - - )} + + - + + + Sessions + {this.props.sessions.length ? ( + this.props.sessions.map(session => ( + this.props.restoreSession(session.name)} + key={session.id} + > + {" "} + {session.name} + + )) + ) : ( + No Sessions Available + )} + + ) } } -export interface IWelcomeBufferLayerCommandsViewProps { +export interface IWelcomeCommandsViewProps extends Partial { selectedId: string } -export class WelcomeBufferLayerCommandsView extends React.PureComponent< - IWelcomeBufferLayerCommandsViewProps, - {} -> { - public render(): JSX.Element { +export class WelcomeCommandsView extends React.PureComponent { + public render() { + const { commands, executeCommand } = this.props + const isSelected = (command: string) => command === this.props.selectedId return ( - -
- Learn - - -
-
- Customize - - -
-
+ + Quick Commands executeCommand(commands.openFile.command)} description="Control + N" - command="workspace.newFile" - selected={this.props.selectedId === "workspace.newFile"} + command={commands.openFile.command} + selected={isSelected(commands.openFile.command)} /> executeCommand(commands.openWorkspaceFolder.command)} description="Control + O" - command="workspace.openFolder" - selected={this.props.selectedId === "workspace.openFolder"} + command={commands.openWorkspaceFolder.command} + selected={isSelected(commands.openWorkspaceFolder.command)} /> executeCommand(commands.commandPalette.command)} description="Control + Shift + P" - command="tasks.show" - selected={this.props.selectedId === "tasks.show"} + command={commands.commandPalette.command} + selected={isSelected(commands.commandPalette.command)} /> executeCommand(commands.commandline.command)} + selected={isSelected(commands.commandline.command)} /> -
- + + + Learn + executeCommand(commands.openTutor.command)} + description="Learn modal editing with an interactive tutorial." + command={commands.openTutor.command} + selected={isSelected(commands.openTutor.command)} + /> + executeCommand(commands.openDocs.command)} + description="Discover what Oni can do for you." + command={commands.openDocs.command} + selected={isSelected(commands.openDocs.command)} + /> + + + Customize + executeCommand(commands.openConfig.command)} + description="Make Oni work the way you want." + command={commands.openConfig.command} + selected={isSelected(commands.openConfig.command)} + /> + executeCommand(commands.openThemes.command)} + description="Choose a theme that works for you." + command={commands.openThemes.command} + selected={isSelected(commands.openThemes.command)} + /> + + ) } } diff --git a/browser/src/Editor/OniEditor/ColorHighlightLayer.tsx b/browser/src/Editor/OniEditor/ColorHighlightLayer.tsx index 2d0f0e6aa8..20bd6d835e 100644 --- a/browser/src/Editor/OniEditor/ColorHighlightLayer.tsx +++ b/browser/src/Editor/OniEditor/ColorHighlightLayer.tsx @@ -6,34 +6,83 @@ import * as React from "react" import styled, { pixel, withProps } from "../../UI/components/common" -interface IProps { +interface IBackground { top: number left: number height: number width: number +} + +interface IHighlight { color: string fontFamily: string + height: number fontSize: string } -const ColorHighlight = withProps(styled.div).attrs({ - style: (props: IProps) => ({ +const Background = withProps(styled.div).attrs({ + style: (props: IBackground) => ({ top: pixel(props.top), left: pixel(props.left), height: pixel(props.height), width: pixel(props.width), }), })` - display: flex; - justify-content: center; - align-items: center; - background-color: ${p => p.color}; + background-color: ${p => p.theme["editor.background"]}; position: absolute; + white-space: nowrap; +` + +const HighlightSpan = withProps(styled.div)` + display: block; + height: 100%; + width: 100%; color: ${p => (Color(p.color).dark() ? "white" : "black")}; font-family: ${p => p.fontFamily}; font-size: ${p => p.fontSize}; + line-height: ${p => pixel(p.height + 5)}; /* vertically center text inside the highlight */ + background-color: ${p => p.color}; ` +interface IState { + error: Error +} + +type IProps = IHighlight & IBackground + +class Highlight extends React.PureComponent { + public state: IState = { + error: null, + } + + public componentDidCatch(error: Error) { + this.setState({ error }) + } + + public render() { + return ( + !this.state.error && ( + + + {this.props.children} + + + ) + ) + } +} + export default class ColorHighlightLayer implements Oni.BufferLayer { public render = memoize((context: Oni.BufferLayerRenderContext) => ( <>{this._getColorHighlights(context)} @@ -203,6 +252,7 @@ export default class ColorHighlightLayer implements Oni.BufferLayer { constructor(private _config: Oni.Configuration) { this._fontSize = this._config.getValue("editor.fontSize") this._fontFamily = this._config.getValue("editor.fontFamily") + this._config.onConfigurationChanged.subscribe(this._updateFontFamily) this._constructRegex() } @@ -215,6 +265,13 @@ export default class ColorHighlightLayer implements Oni.BufferLayer { return "CSS color highlight layer" } + private _updateFontFamily = (configChanges: Partial) => { + const fontFamilyChanged = Object.keys(configChanges).includes("editor.fontFamily") + if (fontFamilyChanged) { + this._fontFamily = configChanges["editor.fontFamily"] + } + } + private _constructRegex() { // Construct a regex checking for both color codes and all the different css colornames const colorNames = this.CSS_COLOR_NAMES.map(name => `\\b${name}\\b`) @@ -254,7 +311,7 @@ export default class ColorHighlightLayer implements Oni.BufferLayer { const width = endPosition.pixelX - startPosition.pixelX return ( - {location.color} - + ) }) } diff --git a/browser/src/Editor/OniEditor/IndentGuideBufferLayer.tsx b/browser/src/Editor/OniEditor/IndentGuideBufferLayer.tsx index c057a2b598..06f60e2957 100644 --- a/browser/src/Editor/OniEditor/IndentGuideBufferLayer.tsx +++ b/browser/src/Editor/OniEditor/IndentGuideBufferLayer.tsx @@ -22,12 +22,22 @@ interface IProps { color?: string } +interface ConfigOptions { + skipFirst: boolean + color?: string +} + +interface LinePropsWithLevels extends IndentLinesProps { + levelOfIndentation: number +} + interface IndentLinesProps { top: number left: number height: number line: string indentBy: number + indentSize: number characterWidth: number } @@ -71,31 +81,59 @@ class IndentGuideBufferLayer implements Oni.BufferLayer { return "Indent Guide Lines" } - private _getIndentLines = (guidePositions: IndentLinesProps[], color?: string) => { + private _getIndentLines = (guidePositions: IndentLinesProps[], options: ConfigOptions) => { return flatten( - guidePositions.map(({ line, height, characterWidth, indentBy, left, top }, lineNo) => { - const indentation = characterWidth * this._userSpacing - return Array.from({ length: indentBy }, (_, level) => { - const adjustedLeft = left - level * indentation + characterWidth / 3 - // skip the furthest (inwards) indent if there are one or more indents - const skipIndentLine = !level && indentBy >= 1 - return ( - !skipIndentLine && ( + guidePositions.map((props, idx) => { + const indents: JSX.Element[] = [] + // Create a line per indentation + for ( + let levelOfIndentation = 0; + levelOfIndentation < props.indentBy; + levelOfIndentation++ + ) { + const lineProps = { ...props, levelOfIndentation } + const adjustedLeft = this._calculateLeftPosition(lineProps) + const shouldSkip = this._determineIfShouldSkip(lineProps, options) + const key = `${props.line.trim()}-${idx}-${levelOfIndentation}` + indents.push( + !shouldSkip && ( - ) + ), ) - }) + } + return indents }), ) } + private _determineIfShouldSkip(props: LinePropsWithLevels, options: ConfigOptions) { + const skipFirstIndentLine = + options.skipFirst && props.levelOfIndentation === props.indentBy - 1 + + return skipFirstIndentLine + } + + /** + * Remove one indent from left positioning and move lines slightly inwards - + * by a third of a character for a better visual appearance + */ + private _calculateLeftPosition(props: LinePropsWithLevels) { + const adjustedLeft = + props.left - + props.indentSize - + props.levelOfIndentation * props.indentSize + + props.characterWidth / 3 + + return adjustedLeft + } + private _getWrappedLines(context: Oni.BufferLayerRenderContext): IWrappedLine[] { const { lines } = context.visibleLines.reduce( (acc, line, index) => { @@ -137,13 +175,16 @@ class IndentGuideBufferLayer implements Oni.BufferLayer { * @returns {JSX.Element[]} An array of react elements */ private _renderIndentLines = (bufferLayerContext: Oni.BufferLayerRenderContext) => { - // FIXME: Outstanding issues - - // 1. If the beginning of the visible lines is wrapping no lines are drawn - // 2. If a line wraps but the wrapped line has no content line positions are off by one - + // TODO: If the beginning of the visible lines is wrapping no lines are drawn const wrappedScreenLines = this._getWrappedLines(bufferLayerContext) - const color = this._configuration.getValue("experimental.indentLines.color") + + const options = { + color: this._configuration.getValue("experimental.indentLines.color"), + skipFirst: this._configuration.getValue("experimental.indentLines.skipFirst"), + } + const { visibleLines, fontPixelHeight, fontPixelWidth, topBufferLine } = bufferLayerContext + const indentSize = this._userSpacing * fontPixelWidth const { allIndentations } = visibleLines.reduce( (acc, line, currenLineNumber) => { @@ -192,6 +233,7 @@ class IndentGuideBufferLayer implements Oni.BufferLayer { const indent = { left, line, + indentSize, top: adjustedTop, height: adjustedHeight, characterWidth: fontPixelWidth, @@ -205,7 +247,7 @@ class IndentGuideBufferLayer implements Oni.BufferLayer { { allIndentations: [], wrappedHeightAdjustment: 0 }, ) - return this._getIndentLines(allIndentations, color) + return this._getIndentLines(allIndentations, options) } } diff --git a/browser/src/Editor/OniEditor/OniEditor.tsx b/browser/src/Editor/OniEditor/OniEditor.tsx index dc771e1983..403d2c3df4 100644 --- a/browser/src/Editor/OniEditor/OniEditor.tsx +++ b/browser/src/Editor/OniEditor/OniEditor.tsx @@ -1,7 +1,7 @@ /** * OniEditor.ts * - * IEditor implementation for Oni + * Editor implementation for Oni * * Extends the capabilities of the NeovimEditor */ @@ -41,8 +41,6 @@ import { ThemeManager } from "./../../Services/Themes" import { TokenColors } from "./../../Services/TokenColors" import { Workspace } from "./../../Services/Workspace" -import { IEditor } from "./../Editor" - import { BufferScrollBarContainer } from "./containers/BufferScrollBarContainer" import { DefinitionContainer } from "./containers/DefinitionContainer" import { ErrorsContainer } from "./containers/ErrorsContainer" @@ -51,7 +49,9 @@ import { NeovimEditor } from "./../NeovimEditor" import { SplitDirection, windowManager } from "./../../Services/WindowManager" +import { ISession } from "../../Services/Sessions" import { IBuffer } from "../BufferManager" +import { OniWithActiveSection, WelcomeBufferLayer } from "../NeovimEditor/WelcomeBufferLayer" import ColorHighlightLayer from "./ColorHighlightLayer" import { ImageBufferLayer } from "./ImageBufferLayer" import IndentLineBufferLayer from "./IndentGuideBufferLayer" @@ -64,7 +64,7 @@ const wrapReactComponentWithLayer = (id: string, component: JSX.Element): Oni.Bu } } -export class OniEditor extends Utility.Disposable implements IEditor { +export class OniEditor extends Utility.Disposable implements Oni.Editor { private _neovimEditor: NeovimEditor public get mode(): string { @@ -103,6 +103,10 @@ export class OniEditor extends Utility.Disposable implements IEditor { return this._neovimEditor.activeBuffer } + public get onQuit(): IEvent { + return this._neovimEditor.onNeovimQuit + } + // Capabilities public get neovim(): Oni.NeovimEditorCapability { return this._neovimEditor.neovim @@ -174,7 +178,10 @@ export class OniEditor extends Utility.Disposable implements IEditor { ) const imageExtensions = this._configuration.getValue("editor.imageLayerExtensions") - const indentExtensions = this._configuration.getValue("experimental.indentLines.filetypes") + const bannedIndentExtensions = this._configuration.getValue( + "experimental.indentLines.bannedFiletypes", + ) + this._neovimEditor.bufferLayers.addBufferLayer( buf => imageExtensions.includes(path.extname(buf.filePath)), buf => new ImageBufferLayer(buf), @@ -182,7 +189,10 @@ export class OniEditor extends Utility.Disposable implements IEditor { if (this._configuration.getValue("experimental.indentLines.enabled")) { this._neovimEditor.bufferLayers.addBufferLayer( - buf => indentExtensions.includes(path.extname(buf.filePath)), + buf => { + const extension = path.extname(buf.filePath) + return extension && !bannedIndentExtensions.includes(extension) + }, buffer => new IndentLineBufferLayer({ buffer: buffer as IBuffer, @@ -199,6 +209,13 @@ export class OniEditor extends Utility.Disposable implements IEditor { _buf => new ColorHighlightLayer(this._configuration), ) } + + this._neovimEditor.onShowWelcomeScreen.subscribe(async () => { + const oni = this._pluginManager.getApi() + const welcomeBuffer = await this._neovimEditor.createWelcomeBuffer() + const welcomeLayer = new WelcomeBufferLayer(oni as OniWithActiveSection) + welcomeBuffer.addLayer(welcomeLayer) + }) } public dispose(): void { @@ -284,6 +301,18 @@ export class OniEditor extends Utility.Disposable implements IEditor { this._neovimEditor.executeCommand(command) } + public restoreSession(sessionDetails: ISession) { + return this._neovimEditor.restoreSession(sessionDetails) + } + + public getCurrentSession() { + return this._neovimEditor.getCurrentSession() + } + + public persistSession(sessionDetails: ISession) { + return this._neovimEditor.persistSession(sessionDetails) + } + public getBuffers(): Array { return this._neovimEditor.getBuffers() } diff --git a/browser/src/Input/KeyBindings.ts b/browser/src/Input/KeyBindings.ts index 31b936f2c7..adb220a809 100644 --- a/browser/src/Input/KeyBindings.ts +++ b/browser/src/Input/KeyBindings.ts @@ -35,6 +35,7 @@ export const applyDefaultKeyBindings = (oni: Oni.Plugin.Api, config: Configurati !isMenuOpen() const isExplorerActive = () => isSidebarPaneOpen("oni.sidebar.explorer") + const areSessionsActive = () => isSidebarPaneOpen("oni.sidebar.sessions") const isVCSActive = () => isSidebarPaneOpen("oni.sidebar.vcs") const isMenuOpen = () => menu.isMenuOpen() @@ -165,6 +166,10 @@ export const applyDefaultKeyBindings = (oni: Oni.Plugin.Api, config: Configurati // VCS input.bind("e", "vcs.openFile", isVCSActive) + input.bind("u", "vcs.unstage", isVCSActive) input.bind("", "vcs.refresh", isVCSActive) input.bind("?", "vcs.showHelp", isVCSActive) + + // Sessions + input.bind("", "oni.sessions.delete", areSessionsActive) } diff --git a/browser/src/PersistentStore.ts b/browser/src/PersistentStore.ts index 22840230e4..1b4fb63684 100644 --- a/browser/src/PersistentStore.ts +++ b/browser/src/PersistentStore.ts @@ -15,6 +15,8 @@ const PersistentSettings = remote.require("electron-settings") export interface IPersistentStore { get(): Promise set(value: T): Promise + delete(key: string): Promise + has(key: string): boolean } export const getPersistentStore = ( @@ -70,4 +72,12 @@ export class PersistentStore implements IPersistentStore { PersistentSettings.set(this._storeKey, JSON.stringify(this._currentValue)) } + + public has(key: string) { + return PersistentSettings.has(key) + } + + public async delete(key: string) { + return PersistentSettings.delete(`${this._storeKey}.${key}`) + } } diff --git a/browser/src/Plugins/Api/Oni.ts b/browser/src/Plugins/Api/Oni.ts index efbe8f971e..dd688d53a9 100644 --- a/browser/src/Plugins/Api/Oni.ts +++ b/browser/src/Plugins/Api/Oni.ts @@ -27,14 +27,12 @@ import { inputManager } from "./../../Services/InputManager" import * as LanguageManager from "./../../Services/Language" import { getTutorialManagerInstance } from "./../../Services/Learning" import { getInstance as getAchievementsInstance } from "./../../Services/Learning/Achievements" -import { - getInstance as getMenuManagerInstance, - IMenuOptionWithHighlights, -} from "./../../Services/Menu" +import { getInstance as getMenuManagerInstance } from "./../../Services/Menu" import { getInstance as getFiltersInstance } from "./../../Services/Menu/Filter" import { getInstance as getNotificationsInstance } from "./../../Services/Notifications" import { getInstance as getOverlayInstance } from "./../../Services/Overlay" import { recorder } from "./../../Services/Recorder" +import { getInstance as getSessionManagerInstance, SessionManager } from "./../../Services/Sessions" import { getInstance as getSidebarInstance } from "./../../Services/Sidebar" import { getInstance as getSneakInstance } from "./../../Services/Sneak" import { getInstance as getSnippetsInstance } from "./../../Services/Snippets" @@ -47,35 +45,8 @@ import { Search } from "./../../Services/Search/SearchProvider" import * as throttle from "lodash/throttle" -import { ISearch } from "./Search" // TODO: Move to oni-api - const react = require("react") // tslint:disable-line no-var-requires -// TODO: Move to oni-api -export interface QuickFixEntry { - filename: string - lnum: number - col: number - text: string -} - -// TODO: Move to oni-api under `menu` -export type IMenuFilter = (options: any[], searchString: string) => IMenuOptionWithHighlights[] - -// TODO: Move to oni-api under `menu` -export interface IMenuFilters { - getDefault(): IMenuFilter - getByName(name: string): IMenuFilter -} - -export interface ApiNext { - search: ISearch - ui: Ui - filter: IMenuFilters // TODO: Move to oni-api under menu - - populateQuickFix(entries: QuickFixEntry[]): void -} - export class Dependencies { public get React(): any { return react @@ -89,7 +60,7 @@ const helpers = { /** * API instance for interacting with OniApi (and vim) */ -export class Oni implements OniApi.Plugin.Api, ApiNext { +export class Oni implements OniApi.Plugin.Api { private _dependencies: Dependencies private _ui: Ui private _services: Services @@ -158,7 +129,7 @@ export class Oni implements OniApi.Plugin.Api, ApiNext { return getMenuManagerInstance() } - public get filter(): IMenuFilters { + public get filter(): OniApi.Menu.IMenuFilters { return getFiltersInstance("") // TODO: Pass either "core" or plugin's name } @@ -198,6 +169,10 @@ export class Oni implements OniApi.Plugin.Api, ApiNext { return this._ui } + public get sessions(): SessionManager { + return getSessionManagerInstance() + } + public get services(): Services { return this._services } @@ -214,11 +189,11 @@ export class Oni implements OniApi.Plugin.Api, ApiNext { return getWorkspaceInstance() } - public get helpers(): any { + public get helpers() { return helpers } - public get search(): ISearch { + public get search(): OniApi.Search.ISearch { return new Search() } @@ -228,7 +203,26 @@ export class Oni implements OniApi.Plugin.Api, ApiNext { this._services = new Services() } - public populateQuickFix(entries: QuickFixEntry[]): void { + public getActiveSection() { + const isInsertOrCommandMode = () => { + return ( + this.editors.activeEditor.mode === "insert" || + this.editors.activeEditor.mode === "cmdline_normal" + ) + } + switch (true) { + case this.menu.isMenuOpen(): + return "menu" + case this.sidebar && this.sidebar.isFocused: + return this.sidebar.activeEntryId + case isInsertOrCommandMode(): + return "commandline" + default: + return "editor" + } + } + + public populateQuickFix(entries: OniApi.QuickFixEntry[]): void { const neovim: any = editorManager.activeEditor.neovim neovim.quickFix.setqflist(entries, "Search Results") neovim.command(":copen") diff --git a/browser/src/Plugins/Api/Search.ts b/browser/src/Plugins/Api/Search.ts deleted file mode 100644 index 1f4a2b61dc..0000000000 --- a/browser/src/Plugins/Api/Search.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { IEvent } from "oni-types" - -export interface ResultItem { - fileName: string - line: number - column: number - text: string -} - -export interface Result { - items: ResultItem[] - isComplete: boolean -} - -export interface Query { - onSearchResults: IEvent - - start(): void - cancel(): void -} - -export interface Options { - searchQuery: string - fileFilter: string - workspace: string -} - -export interface ISearch { - nullSearch: Query - findInFile(opts: Options): Query - findInPath(opts: Options): Query -} diff --git a/browser/src/Plugins/Api/Ui.ts b/browser/src/Plugins/Api/Ui.ts index 42f840698f..6f8b8f8683 100644 --- a/browser/src/Plugins/Api/Ui.ts +++ b/browser/src/Plugins/Api/Ui.ts @@ -1,8 +1,10 @@ +import * as Oni from "oni-api" + import { getFileIcon } from "../../Services/FileIcon" import { getInstance } from "../../Services/IconThemes" import { Icon, IconProps, IconSize } from "../../UI/Icon" -export class Ui { +export class Ui implements Oni.Ui.IUi { constructor(private _react: any) {} public createIcon(props: IconProps): any { diff --git a/browser/src/Plugins/PluginManager.ts b/browser/src/Plugins/PluginManager.ts index 00587f39f2..c4ffbba8eb 100644 --- a/browser/src/Plugins/PluginManager.ts +++ b/browser/src/Plugins/PluginManager.ts @@ -89,6 +89,10 @@ export class PluginManager implements Oni.IPluginManager { this._pluginsActivated = true this._pluginsLoaded.dispatch() + return this.getApi() + } + + public getApi(): Oni.Plugin.Api { return this._anonymousPlugin.oni } diff --git a/browser/src/Plugins/PluginSidebarPane.tsx b/browser/src/Plugins/PluginSidebarPane.tsx index 68749a4d3d..69952d834b 100644 --- a/browser/src/Plugins/PluginSidebarPane.tsx +++ b/browser/src/Plugins/PluginSidebarPane.tsx @@ -173,6 +173,7 @@ export class PluginsSidebarPaneView extends React.PureComponent< render={(selectedId: string) => { const defaultPluginItems = defaultPlugins.map(p => ( ( (bm: IBookmark) => ( } isFocused={selectedId === bm.id} isContainer={false} diff --git a/browser/src/Services/Browser/index.tsx b/browser/src/Services/Browser/index.tsx index d164714dd8..97b96c81b2 100644 --- a/browser/src/Services/Browser/index.tsx +++ b/browser/src/Services/Browser/index.tsx @@ -4,7 +4,7 @@ * Entry point for browser integration plugin */ -import { ipcRenderer, shell, WebviewTag } from "electron" +import { shell, WebviewTag } from "electron" import * as React from "react" import * as Oni from "oni-api" @@ -173,6 +173,13 @@ export const activate = ( detail: null, }) + commandManager.registerCommand({ + command: "oni.docs.open", + execute: () => openUrl("https://onivim.github.io/oni-docs/#/"), + name: "Browser: Open Documentation", + detail: "Open Oni's Documentation website", + }) + const getLayerForBuffer = (buffer: Oni.Buffer): BrowserLayer => { return (buffer as IBuffer).getLayerById("oni.browser") } @@ -290,10 +297,6 @@ export const activate = ( detail: "", enabled: isBrowserScrollCommandEnabled, }) - - ipcRenderer.on("open-oni-browser", (event: string, args: string) => { - openUrl(args) - }) } export const registerAchievements = (achievements: AchievementsManager) => { diff --git a/browser/src/Services/Commands/GlobalCommands.ts b/browser/src/Services/Commands/GlobalCommands.ts index 05d6c75cb9..bd640803ac 100644 --- a/browser/src/Services/Commands/GlobalCommands.ts +++ b/browser/src/Services/Commands/GlobalCommands.ts @@ -9,6 +9,7 @@ import { remote } from "electron" import * as Oni from "oni-api" +import { gotoNextError, gotoPreviousError } from "./../../Services/Diagnostics/navigateErrors" import { EditorManager } from "./../../Services/EditorManager" import { MenuManager } from "./../../Services/Menu" import { showAboutMessage } from "./../../Services/Metadata" @@ -47,7 +48,7 @@ export const activate = ( const commands = [ new CallbackCommand("editor.executeVimCommand", null, null, (message: string) => { - const neovim = editorManager.activeEditor.neovim + const { neovim } = editorManager.activeEditor if (message.startsWith(":")) { neovim.command('exec "' + message + '"') } else { @@ -60,16 +61,20 @@ export const activate = ( multiProcess.openNewWindow(), ), + new CallbackCommand("oni.editor.newFile", "Oni: Create new file", "Create a new file", () => + editorManager.activeEditor.neovim.command("enew!"), + ), + new CallbackCommand( "oni.editor.maximize", - "Maximize Window", + "Oni: Maximize Window", "Maximize the current window", () => remote.getCurrentWindow().maximize(), ), new CallbackCommand( "oni.editor.minimize", - "Minimize Window", + "Oni: Minimize Window", "Minimize the current window", () => remote.getCurrentWindow().minimize(), ), @@ -80,13 +85,13 @@ export const activate = ( new CallbackCommand( "oni.process.cycleNext", - "Focus Next Oni", + "Oni: Focus Next Oni", "Switch to the next running instance of Oni", () => multiProcess.focusNextInstance(), ), new CallbackCommand( "oni.process.cyclePrevious", - "Focus Previous Oni", + "Oni: Focus Previous Oni", "Switch to the previous running instance of Oni", () => multiProcess.focusPreviousInstance(), ), @@ -106,6 +111,20 @@ export const activate = ( new CallbackCommand("window.moveDown", null, null, () => windowManager.moveDown()), new CallbackCommand("window.moveUp", null, null, () => windowManager.moveUp()), + // Error list + new CallbackCommand( + "oni.editor.nextError", + "Jump to next lint/compiler error", + "Jump to the next error or warning from the linter or compiler", + gotoNextError, + ), + new CallbackCommand( + "oni.editor.previousError", + "Jump to previous lint/compiler error", + "Jump to the previous error or warning from the linter or compiler", + gotoPreviousError, + ), + // Add additional commands here // ... ] @@ -114,7 +133,7 @@ export const activate = ( if (Platform.isMac()) { const addToPathCommand = new CallbackCommand( "oni.editor.removeFromPath", - "Remove from PATH", + "Oni: Remove from PATH", "Disable executing 'oni' from terminal", Platform.removeFromPath, () => Platform.isAddedToPath(), @@ -123,7 +142,7 @@ export const activate = ( const removeFromPathCommand = new CallbackCommand( "oni.editor.addToPath", - "Add to PATH", + "Oni: Add to PATH", "Enable executing 'oni' from terminal", Platform.addToPath, () => !Platform.isAddedToPath(), diff --git a/browser/src/Services/Configuration/DefaultConfiguration.ts b/browser/src/Services/Configuration/DefaultConfiguration.ts index 51beb5b54d..758fecd66d 100644 --- a/browser/src/Services/Configuration/DefaultConfiguration.ts +++ b/browser/src/Services/Configuration/DefaultConfiguration.ts @@ -53,10 +53,15 @@ const BaseConfiguration: IConfigurationValues = { "wildmenu.mode": true, "commandline.mode": true, "commandline.icons": true, - "experimental.vcs.sidebar": false, - "experimental.particles.enabled": false, "experimental.preview.enabled": false, "experimental.welcome.enabled": false, + "experimental.particles.enabled": false, + "experimental.sessions.enabled": false, + "experimental.sessions.directory": null, + "experimental.vcs.sidebar": false, + "experimental.vcs.blame.enabled": false, + "experimental.vcs.blame.mode": "auto", + "experimental.vcs.blame.timeout": 800, "experimental.colorHighlight.enabled": false, "experimental.colorHighlight.filetypes": [ @@ -77,21 +82,12 @@ const BaseConfiguration: IConfigurationValues = { ], "experimental.indentLines.enabled": false, "experimental.indentLines.color": null, - "experimental.indentLines.filetypes": [ - ".tsx", - ".ts", - ".jsx", - ".js", - ".go", - ".re", - ".py", - ".c", - ".cc", - ".lua", - ".java", - ], + "experimental.indentLines.skipFirst": false, + "experimental.indentLines.bannedFiletypes": [], "experimental.markdownPreview.enabled": false, "experimental.markdownPreview.autoScroll": true, + "experimental.markdownPreview.syntaxHighlights": true, + "experimental.markdownPreview.syntaxTheme": "atom-one-dark", "experimental.neovim.transport": "stdio", // TODO: Enable pipe transport for Windows diff --git a/browser/src/Services/Configuration/IConfigurationValues.ts b/browser/src/Services/Configuration/IConfigurationValues.ts index 7333ead8ca..2af6c5d219 100644 --- a/browser/src/Services/Configuration/IConfigurationValues.ts +++ b/browser/src/Services/Configuration/IConfigurationValues.ts @@ -48,7 +48,10 @@ export interface IConfigurationValues { // Whether or not the learning pane is available "experimental.particles.enabled": boolean - + // Whether or not the sessions sidebar pane is enabled + "experimental.sessions.enabled": boolean + // A User specified directory for where Oni session files should be saved + "experimental.sessions.directory": string // Whether Version control sidebar item is enabled "experimental.vcs.sidebar": boolean // Whether the color highlight layer is enabled @@ -57,12 +60,23 @@ export interface IConfigurationValues { "experimental.colorHighlight.filetypes": string[] // Whether the indent lines should be shown "experimental.indentLines.enabled": boolean + // Whether or not to skip the first line of indentation + "experimental.indentLines.skipFirst": boolean "experimental.indentLines.color": string - // Filetypes the indent lines are shown for - "experimental.indentLines.filetypes": string[] + // Filetypes the indent lines are not shown for + "experimental.indentLines.bannedFiletypes": string[] + // Whether or not the vcs blame layer is enabled + "experimental.vcs.blame.enabled": boolean + // Whether or not the blame shows up automatically following a timeout or is manually + // triggered + "experimental.vcs.blame.mode": "auto" | "manual" + // Amount of millisenconds to delay before showing blame per line + "experimental.vcs.blame.timeout": number // Whether the markdown preview pane should be shown "experimental.markdownPreview.enabled": boolean "experimental.markdownPreview.autoScroll": boolean + "experimental.markdownPreview.syntaxHighlights": boolean + "experimental.markdownPreview.syntaxTheme": string // The transport to use for Neovim // Valid values are "stdio" and "pipe" diff --git a/browser/src/Services/Diagnostics.ts b/browser/src/Services/Diagnostics/index.ts similarity index 95% rename from browser/src/Services/Diagnostics.ts rename to browser/src/Services/Diagnostics/index.ts index a8d81147fe..ea862b59b6 100644 --- a/browser/src/Services/Diagnostics.ts +++ b/browser/src/Services/Diagnostics/index.ts @@ -1,5 +1,5 @@ /** - * Diagnostics.ts + * Diagnostics/index.ts * * Integrates the `textDocument/publishDiagnostics` protocol with Oni's UI */ @@ -9,11 +9,11 @@ import * as types from "vscode-languageserver-types" import { Event, IEvent } from "oni-types" -import { ILanguageServerNotificationResponse, LanguageManager } from "./Language" +import { ILanguageServerNotificationResponse, LanguageManager } from "../Language" -import * as Helpers from "./../Plugins/Api/LanguageClient/LanguageClientHelpers" +import * as Helpers from "../../Plugins/Api/LanguageClient/LanguageClientHelpers" -import * as Utility from "./../Utility" +import * as Utility from "../../Utility" interface IPublishDiagnosticsParams { uri: string diff --git a/browser/src/Services/Diagnostics/navigateErrors.ts b/browser/src/Services/Diagnostics/navigateErrors.ts new file mode 100644 index 0000000000..dbc16631b1 --- /dev/null +++ b/browser/src/Services/Diagnostics/navigateErrors.ts @@ -0,0 +1,83 @@ +/** + * navigateErrors.ts + * + * Functions to jump to previous/next diagnostic error in the active buffer + */ +import { isInRange } from "./../../Utility" +import { getAllErrorsForFile, getInstance as getDiagnosticsInstance } from "./../Diagnostics" +import { editorManager } from "./../EditorManager" + +export const gotoNextError = async () => { + const errors = getDiagnosticsInstance().getErrors() + const activeBuffer = editorManager.activeEditor.activeBuffer + const currentFileErrors = getAllErrorsForFile(activeBuffer.filePath, errors) + const currentPosition = activeBuffer.cursor + + if (!currentFileErrors) { + return + } + + for (const error of currentFileErrors) { + if (isInRange(currentPosition.line, currentPosition.column, error.range)) { + continue + } + + const currentLine = (await activeBuffer.getLines(currentPosition.line))[0] + if ( + currentPosition.line === error.range.start.line && + currentLine.length <= error.range.start.character + ) { + continue + } + + if ( + error.range.start.line > currentPosition.line || + (error.range.start.line === currentPosition.line && + error.range.start.character > currentPosition.column) + ) { + await activeBuffer.setCursorPosition( + error.range.start.line, + error.range.start.character, + ) + return + } + } + + await activeBuffer.setCursorPosition( + currentFileErrors[0].range.start.line, + currentFileErrors[0].range.start.character, + ) +} + +export const gotoPreviousError = async () => { + const errors = getDiagnosticsInstance().getErrors() + const activeBuffer = editorManager.activeEditor.activeBuffer + const currentFileErrors = getAllErrorsForFile(activeBuffer.filePath, errors) + const currentPosition = activeBuffer.cursor + + if (!currentFileErrors) { + return + } + + let lastError = currentFileErrors[currentFileErrors.length - 1] + for (const error of currentFileErrors) { + if ( + isInRange(currentPosition.line, currentPosition.column, error.range) || + error.range.start.line > currentPosition.line || + (error.range.start.line === currentPosition.line && + error.range.start.character > currentPosition.column) + ) { + await activeBuffer.setCursorPosition( + lastError.range.start.line, + lastError.range.start.character, + ) + return + } + lastError = error + } + + await activeBuffer.setCursorPosition( + lastError.range.start.line, + lastError.range.start.character, + ) +} diff --git a/browser/src/Services/EditorManager.ts b/browser/src/Services/EditorManager.ts index e2642c9ff8..721b55e260 100644 --- a/browser/src/Services/EditorManager.ts +++ b/browser/src/Services/EditorManager.ts @@ -11,6 +11,8 @@ import * as Oni from "oni-api" import { Event, IDisposable, IEvent } from "oni-types" +import * as types from "vscode-languageserver-types" + import { remote } from "electron" export class EditorManager implements Oni.EditorManager { @@ -123,6 +125,14 @@ class AnyEditorProxy implements Oni.Editor { return this._activeEditor.activeBuffer } + public init(filesToOpen: string[]): void { + if (!this._activeEditor) { + return + } + + this._activeEditor.init(filesToOpen) + } + public get neovim(): Oni.NeovimEditorCapability { if (!this._activeEditor) { return null @@ -181,6 +191,22 @@ class AnyEditorProxy implements Oni.Editor { return this._activeEditor.setTextOptions(options) } + public render(): JSX.Element { + if (!this._activeEditor) { + return null + } + + return this._activeEditor.render() + } + + public setSelection(selectionRange: types.Range): Promise { + if (!this._activeEditor) { + return null + } + + return this._activeEditor.setSelection(selectionRange) + } + /** * Internal methods */ diff --git a/browser/src/Services/Explorer/ExplorerFileSystem.ts b/browser/src/Services/Explorer/ExplorerFileSystem.ts index d651e6f6a5..24f21edcb1 100644 --- a/browser/src/Services/Explorer/ExplorerFileSystem.ts +++ b/browser/src/Services/Explorer/ExplorerFileSystem.ts @@ -18,6 +18,7 @@ import { FolderOrFile } from "./ExplorerStore" export interface IFileSystem { readdir(fullPath: string): Promise exists(fullPath: string): Promise + realpath(fullPath: string): Promise persistNode(fullPath: string): Promise restoreNode(fullPath: string): Promise deleteNode(fullPath: string): Promise @@ -33,6 +34,7 @@ export class FileSystem implements IFileSystem { readdir(path: string): Promise stat(path: string): Promise exists(path: string): Promise + realpath(path: string): Promise } private _backupDirectory = path.join(os.tmpdir(), "oni_backup") @@ -46,6 +48,7 @@ export class FileSystem implements IFileSystem { readdir: promisify(nfs.readdir.bind(nfs)), stat: promisify(nfs.stat.bind(nfs)), exists: promisify(nfs.exists.bind(nfs)), + realpath: promisify(nfs.realpath.bind(nfs)), } this.init() @@ -84,6 +87,13 @@ export class FileSystem implements IFileSystem { return this._fs.exists(fullPath) } + /** + * Resolve symlinks in a path to give the real absolute path. + */ + public realpath(fullPath: string): Promise { + return this._fs.realpath(fullPath) + } + /** * Delete a file or Folder * diff --git a/browser/src/Services/Explorer/ExplorerSplit.tsx b/browser/src/Services/Explorer/ExplorerSplit.tsx index d2810cb321..8bc8fb9122 100644 --- a/browser/src/Services/Explorer/ExplorerSplit.tsx +++ b/browser/src/Services/Explorer/ExplorerSplit.tsx @@ -9,14 +9,12 @@ import { Provider } from "react-redux" import { Store } from "redux" import { FileSystemWatcher } from "./../../Services/FileSystemWatcher" +import * as Oni from "oni-api" import { Event } from "oni-types" -import { CallbackCommand, CommandManager } from "./../../Services/CommandManager" -import { Configuration } from "./../../Services/Configuration" -import { EditorManager } from "./../../Services/EditorManager" +import { CallbackCommand } from "./../../Services/CommandManager" // TODO: Discuss: Move to API? import { getInstance as NotificationsInstance } from "./../../Services/Notifications" import { windowManager } from "./../../Services/WindowManager" -import { IWorkspace } from "./../../Services/Workspace" import { createStore, getPathForNode, IExplorerState } from "./ExplorerStore" @@ -39,32 +37,27 @@ export class ExplorerSplit { return "Explorer" } - constructor( - private _configuration: Configuration, - private _workspace: IWorkspace, - private _commandManager: CommandManager, - private _editorManager: EditorManager, - ) { + constructor(private _oni: Oni.Plugin.Api) { this._store = createStore({ notifications: NotificationsInstance() }) this._initializeFileSystemWatcher() - this._workspace.onDirectoryChanged.subscribe(newDirectory => { + this._oni.workspace.onDirectoryChanged.subscribe(newDirectory => { this._store.dispatch({ type: "SET_ROOT_DIRECTORY", rootPath: newDirectory, }) if (this._watcher) { - this._watcher.unwatch(this._workspace.activeWorkspace) + this._watcher.unwatch(this._oni.workspace.activeWorkspace) this._watcher.watch(newDirectory) } }) - if (this._workspace.activeWorkspace) { + if (this._oni.workspace.activeWorkspace) { this._store.dispatch({ type: "SET_ROOT_DIRECTORY", - rootPath: this._workspace.activeWorkspace, + rootPath: this._oni.workspace.activeWorkspace, }) } } @@ -99,10 +92,14 @@ export class ExplorerSplit { ) } + public locateFile = (filePath: string) => { + this._store.dispatch({ type: "SELECT_FILE", filePath }) + } + private _initializeFileSystemWatcher(): void { - if (this._configuration.getValue("explorer.autoRefresh")) { + if (this._oni.configuration.getValue("explorer.autoRefresh")) { this._watcher = new FileSystemWatcher({ - target: this._workspace.activeWorkspace, + target: this._oni.workspace.activeWorkspace, options: { ignoreInitial: true, ignored: "**/node_modules" }, }) @@ -123,7 +120,7 @@ export class ExplorerSplit { } private _initialiseExplorerCommands(): void { - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.delete.persist", null, @@ -131,7 +128,7 @@ export class ExplorerSplit { () => !this._inputInProgress() && this._onDeleteItem({ persist: true }), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.delete", null, @@ -139,82 +136,82 @@ export class ExplorerSplit { () => !this._inputInProgress() && this._onDeleteItem({ persist: false }), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.yank", - "Yank Selected Item", + "Explorer: Yank Selected Item", "Select a file to move", () => !this._inputInProgress() && this._onYankItem(), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.undo", - "Undo last explorer action", + "Explorer: Undo Last Action", null, () => !this._inputInProgress() && this._onUndoItem(), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.paste", - "Move/Paste Selected Item", + "Explorer: Move/Paste Selected Item", "Paste the last yanked item", () => !this._inputInProgress() && this._onPasteItem(), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.refresh", - "Explorer: Refresh the tree", + "Explorer: Refresh The Tree", "Updates the explorer with the latest state on the file system", () => !this._inputInProgress() && this._refresh(), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.create.file", - "Create A New File in the Explorer", + "Explorer: Create A New File", null, () => !this._inputInProgress() && this._onCreateNode({ type: "file" }), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.create.folder", - "Create A New File in the Explorer", + "Explorer: Create A New Directory", null, () => !this._inputInProgress() && this._onCreateNode({ type: "folder" }), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.expand.directory", - "Expand a selected directory", + "Explorer: Expand Selected Directory", null, () => !this._inputInProgress() && this._toggleDirectory("expand"), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.collapse.directory", - "Collapse selected directory", + "Explorer: Collapse Selected Directory", null, () => !this._inputInProgress() && this._toggleDirectory("collapse"), ), ) - this._commandManager.registerCommand( + this._oni.commands.registerCommand( new CallbackCommand( "explorer.rename", - "Rename the selected file/folder", + "Explorer: Rename Selected File/Folder", null, () => !this._inputInProgress() && this._renameItem(), ), @@ -223,6 +220,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 = getPathForNode(this._getSelectedItem()) + if (selectedPath === fileToSelect) { + this._store.dispatch({ type: "SELECT_FILE_SUCCESS" }) + } + } } private _onOpenItem(id?: string): void { @@ -236,7 +241,7 @@ export class ExplorerSplit { switch (selectedItem.type) { case "file": - this._editorManager.activeEditor.openFile(selectedItem.filePath) + this._oni.editors.activeEditor.openFile(selectedItem.filePath) // FIXME: the editor manager is not a windowSplit aka this // Should be being called with an ID not an active editor windowManager.focusSplit("oni.window.0") diff --git a/browser/src/Services/Explorer/ExplorerStore.ts b/browser/src/Services/Explorer/ExplorerStore.ts index e235927aa7..4562425e6b 100644 --- a/browser/src/Services/Explorer/ExplorerStore.ts +++ b/browser/src/Services/Explorer/ExplorerStore.ts @@ -107,7 +107,7 @@ export interface IExplorerState { rootFolder: IFolderState expandedFolders: ExpandedFolders - + fileToSelect: string hasFocus: boolean register: IRegisterState } @@ -115,6 +115,7 @@ export interface IExplorerState { 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[] => @@ -444,6 +468,11 @@ const Actions = { children: sortedFilesAndFolders, } }, + + selectFile: (filePath: string): ISelectFileAction => ({ + type: "SELECT_FILE", + filePath, + }), } // Yank, Paste Delete register ============================= @@ -613,6 +642,20 @@ export const hasFocusReducer: Reducer = ( } } +export const selectFileReducer: Reducer = ( + 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 = ( state: IExplorerState = DefaultExplorerState, action: ExplorerAction, @@ -622,6 +665,7 @@ export const reducer: Reducer = ( 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 +964,44 @@ 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) => { + const rootPath = store.getState().rootFolder.fullPath + + // We need to resolve any symlinks, since the buffer and workspace path can otherwise + // appear to be unrelated (at least on OSX). + return fromPromise( + Promise.all([fileSystem.realpath(rootPath), fileSystem.realpath(filePath)]), + ).flatMap(([realRootPath, realFilePath]): ExplorerAction[] => { + const relPath = path.relative(realRootPath, realFilePath) + // Can only select files in the workspace. + if (relPath.startsWith("..") || path.isAbsolute(relPath)) { + const failure: ISelectFileFailAction = { + type: "SELECT_FILE_FAIL", + reason: `File is not in workspace: ${filePath}`, + } + return [failure] + } + // Get the list of directories to expand in the Explorer. + const relDirectoryPath = path.relative(realRootPath, path.dirname(realFilePath)) + 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: realFilePath, + } + actions.push(pending) + return actions + }) + }) + export const createNodeEpic: ExplorerEpic = (action$, store, { fileSystem }) => action$.ofType("CREATE_NODE_COMMIT").mergeMap(({ name }: ICreateNodeCommitAction) => { const { @@ -927,11 +1009,10 @@ export const createNodeEpic: ExplorerEpic = (action$, store, { fileSystem }) => create: { nodeType }, }, } = store.getState() - const shouldExpand = Actions.expandDirectory(path.dirname(name)) const createFileOrFolder = nodeType === "file" ? fileSystem.writeFile(name) : fileSystem.mkdir(name) return fromPromise(createFileOrFolder) - .flatMap(() => [Actions.createNode({ nodeType, name }), shouldExpand, Actions.refresh]) + .flatMap(() => [Actions.createNode({ nodeType, name }), Actions.selectFile(name)]) .catch(error => [Actions.createNodeFail(error.message)]) }) @@ -946,6 +1027,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 +1067,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 +1102,7 @@ export const createStore = ({ undoEpic, deleteEpic, expandDirectoryEpic, + selectFileEpic, notificationEpic, ), { dependencies: { fileSystem, notifications } }, diff --git a/browser/src/Services/Explorer/ExplorerView.tsx b/browser/src/Services/Explorer/ExplorerView.tsx index eda0be8b6b..31addceef1 100644 --- a/browser/src/Services/Explorer/ExplorerView.tsx +++ b/browser/src/Services/Explorer/ExplorerView.tsx @@ -21,7 +21,7 @@ import { DragAndDrop, Droppeable } from "./../DragAndDrop" import { FileIcon } from "./../FileIcon" import * as ExplorerSelectors from "./ExplorerSelectors" -import { IExplorerState } from "./ExplorerStore" +import { getPathForNode, IExplorerState } from "./ExplorerStore" type Node = ExplorerSelectors.ExplorerNode @@ -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 { 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 = getPathForNode(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, } diff --git a/browser/src/Services/Explorer/index.tsx b/browser/src/Services/Explorer/index.tsx index 3a20ad474f..922bf54d67 100644 --- a/browser/src/Services/Explorer/index.tsx +++ b/browser/src/Services/Explorer/index.tsx @@ -4,21 +4,18 @@ * Entry point for explorer-related features */ -import { CommandManager } from "./../CommandManager" +import * as Oni from "oni-api" + +import { CallbackCommand } from "./../CommandManager" import { Configuration } from "./../Configuration" -import { EditorManager } from "./../EditorManager" import { SidebarManager } from "./../Sidebar" -import { IWorkspace } from "./../../Services/Workspace" - import { ExplorerSplit } from "./ExplorerSplit" export const activate = ( - commandManager: CommandManager, + oni: Oni.Plugin.Api, configuration: Configuration, - editorManager: EditorManager, sidebarManager: SidebarManager, - workspace: IWorkspace, ) => { configuration.registerSetting("explorer.autoRefresh", { description: @@ -27,20 +24,33 @@ export const activate = ( defaultValue: false, }) - sidebarManager.add( - "files-o", - new ExplorerSplit(configuration, workspace, commandManager, editorManager), - ) + const explorerSplit: ExplorerSplit = new ExplorerSplit(oni) + sidebarManager.add("files-o", explorerSplit) - const toggleExplorer = () => { - sidebarManager.toggleVisibilityById("oni.sidebar.explorer") - } + const explorerId = "oni.sidebar.explorer" - commandManager.registerCommand({ - command: "explorer.toggle", - name: "Explorer: Toggle Visibility", - detail: "Toggles the explorer in the sidebar", - execute: toggleExplorer, - enabled: () => !!workspace.activeWorkspace, - }) + oni.commands.registerCommand( + new CallbackCommand( + "explorer.toggle", + "Explorer: Toggle Visibility", + "Toggles the explorer in the sidebar", + () => sidebarManager.toggleVisibilityById(explorerId), + () => !!oni.workspace.activeWorkspace, + ), + ) + + oni.commands.registerCommand( + new CallbackCommand( + "explorer.locate.buffer", + "Explorer: Locate Current Buffer", + "Locate current buffer in file tree", + () => { + if (sidebarManager.activeEntryId !== explorerId || !sidebarManager.isVisible) { + sidebarManager.setActiveEntry(explorerId) + } + explorerSplit.locateFile(oni.editors.activeEditor.activeBuffer.filePath) + }, + () => !!oni.workspace.activeWorkspace, + ), + ) } diff --git a/browser/src/Services/InputManager.ts b/browser/src/Services/InputManager.ts index b6c1b16160..f011904e63 100644 --- a/browser/src/Services/InputManager.ts +++ b/browser/src/Services/InputManager.ts @@ -125,7 +125,7 @@ export class InputManager implements Oni.Input.InputManager { } // Returns an array of keys bound to a command - public getBoundKeys(command: string): string[] { + public getBoundKeys = (command: string): string[] => { return Object.keys(this._boundKeys).reduce( (prev: string[], currentValue: string) => { const bindings = this._boundKeys[currentValue] diff --git a/browser/src/Services/Language/LanguageClientStatusBar.tsx b/browser/src/Services/Language/LanguageClientStatusBar.tsx index 43fed3bd17..07d90c8ad3 100644 --- a/browser/src/Services/Language/LanguageClientStatusBar.tsx +++ b/browser/src/Services/Language/LanguageClientStatusBar.tsx @@ -15,8 +15,8 @@ export class LanguageClientStatusBar { private _item: Oni.StatusBarItem private _fileType: string - constructor(private _statusBar: Oni.StatusBar) { - this._item = this._statusBar.createItem(0, "oni.status.fileType") + constructor(private _oni: Oni.Plugin.Api) { + this._item = this._oni.statusBar.createItem(0, "oni.status.fileType") } public show(fileType: string): void { diff --git a/browser/src/Services/Language/LanguageManager.ts b/browser/src/Services/Language/LanguageManager.ts index 38b13bb752..1e77552324 100644 --- a/browser/src/Services/Language/LanguageManager.ts +++ b/browser/src/Services/Language/LanguageManager.ts @@ -24,8 +24,6 @@ import { LanguageClientState, LanguageClientStatusBar } from "./LanguageClientSt import { listenForWorkspaceEdits } from "./Workspace" -import { IWorkspace } from "./../Workspace" - import * as Utility from "./../../Utility" import * as Helpers from "./../../Plugins/Api/LanguageClient/LanguageClientHelpers" @@ -42,18 +40,12 @@ export class LanguageManager { private _languageClientStatusBar: LanguageClientStatusBar private _currentTrackedFile: string = null - constructor( - private _configuration: Oni.Configuration, - private _editorManager: Oni.EditorManager, - private _pluginManager: PluginManager, - private _statusBar: Oni.StatusBar, - private _workspace: IWorkspace, - ) { - this._languageClientStatusBar = new LanguageClientStatusBar(this._statusBar) + constructor(private _oni: Oni.Plugin.Api) { + this._languageClientStatusBar = new LanguageClientStatusBar(_oni) - this._editorManager.anyEditor.onBufferEnter.subscribe(async () => this._onBufferEnter()) + this._oni.editors.anyEditor.onBufferEnter.subscribe(async () => this._onBufferEnter()) - this._editorManager.anyEditor.onBufferLeave.subscribe( + this._oni.editors.anyEditor.onBufferLeave.subscribe( (bufferInfo: Oni.EditorBufferEventArgs) => { const { language, filePath } = bufferInfo @@ -70,7 +62,7 @@ export class LanguageManager { }, ) - this._editorManager.anyEditor.onBufferChanged.subscribe( + this._oni.editors.anyEditor.onBufferChanged.subscribe( async (change: Oni.EditorBufferChangedEventArgs) => { const { language, filePath } = change.buffer @@ -110,7 +102,7 @@ export class LanguageManager { }, ) - this._editorManager.anyEditor.onBufferSaved.subscribe( + this._oni.editors.anyEditor.onBufferSaved.subscribe( (bufferInfo: Oni.EditorBufferEventArgs) => { const { language, filePath } = bufferInfo @@ -149,7 +141,7 @@ export class LanguageManager { return null }) - listenForWorkspaceEdits(this, this._workspace) + listenForWorkspaceEdits(this, this._oni) } public getCapabilitiesForLanguage(language: string): Promise { @@ -163,7 +155,7 @@ export class LanguageManager { } public getTokenRegex(language: string): RegExp { - const languageSpecificTokenRegex = this._configuration.getValue( + const languageSpecificTokenRegex = this._oni.configuration.getValue( `language.${language}.tokenRegex`, ) as RegExp @@ -179,7 +171,7 @@ export class LanguageManager { } public getCompletionTriggerCharacters(language: string): string[] { - const languageSpecificTriggerChars = this._configuration.getValue( + const languageSpecificTriggerChars = this._oni.configuration.getValue( `language.${language}.completionTriggerCharacters`, ) as string[] @@ -314,24 +306,25 @@ export class LanguageManager { // If there is already a buffer open matching this language, // we should send a buffer open event if ( - this._editorManager.activeEditor.activeBuffer && - this._editorManager.activeEditor.activeBuffer.language === language + this._oni.editors.activeEditor.activeBuffer && + this._oni.editors.activeEditor.activeBuffer.language === language ) { this._onBufferEnter() } } private async _onBufferEnter(): Promise { - if (!this._editorManager.activeEditor.activeBuffer) { + if (!this._oni.editors.activeEditor.activeBuffer) { Log.warn("[LanguageManager] No active buffer on buffer enter") return } - const buffer = this._editorManager.activeEditor.activeBuffer + const buffer = this._oni.editors.activeEditor.activeBuffer const { language, filePath } = buffer if (!language && filePath) { - const languages = this._pluginManager.getAllContributionsOfType< + const pluginManager = this._oni.plugins as PluginManager // TODO: Refactor API + const languages = pluginManager.getAllContributionsOfType< Capabilities.ILanguageContribution >(contributes => contributes.languages) const extension = path.extname(filePath) @@ -358,7 +351,10 @@ export class LanguageManager { } } - if (buffer.lineCount > this._configuration.getValue("editor.maxLinesForLanguageServices")) { + if ( + buffer.lineCount > + this._oni.configuration.getValue("editor.maxLinesForLanguageServices") + ) { this._languageClientStatusBar.setStatus(LanguageClientState.NotAvailable) Log.info( "[LanguageManager] Not sending 'didOpen' because file line count exceeds limit.", @@ -372,9 +368,9 @@ export class LanguageManager { "textDocument/didOpen", async () => { this._currentTrackedFile = filePath - const lines = await this._editorManager.activeEditor.activeBuffer.getLines() + const lines = await this._oni.editors.activeEditor.activeBuffer.getLines() const text = lines.join(os.EOL) - const version = this._editorManager.activeEditor.activeBuffer.version + const version = this._oni.editors.activeEditor.activeBuffer.version this._languageClientStatusBar.setStatus(LanguageClientState.Active) return Helpers.pathToTextDocumentItemParams(filePath, language, text, version) }, @@ -409,7 +405,7 @@ export class LanguageManager { } private async _simulateFakeLag(): Promise { - const delay = this._configuration.getValue("debug.fakeLag.languageServer") as number + const delay = this._oni.configuration.getValue("debug.fakeLag.languageServer") as number if (!delay) { return } else { @@ -432,20 +428,8 @@ const logDebug = (args: any) => { let _languageManager: LanguageManager = null -export const activate = ( - configuration: Oni.Configuration, - editorManager: Oni.EditorManager, - pluginManager: PluginManager, - statusBar: Oni.StatusBar, - workspace: IWorkspace, -): void => { - _languageManager = new LanguageManager( - configuration, - editorManager, - pluginManager, - statusBar, - workspace, - ) +export const activate = (oni: Oni.Plugin.Api): void => { + _languageManager = new LanguageManager(oni) } export const getInstance = (): LanguageManager => { diff --git a/browser/src/Services/Language/SignatureHelp.ts b/browser/src/Services/Language/SignatureHelp.ts index 92c291b9b5..75e009cda9 100644 --- a/browser/src/Services/Language/SignatureHelp.ts +++ b/browser/src/Services/Language/SignatureHelp.ts @@ -21,15 +21,17 @@ import * as SignatureHelp from "./SignatureHelpView" export const initUI = ( latestCursorAndBufferInfo$: Observable, modeChanged$: Observable, + onScroll$: Observable, toolTips: IToolTipsProvider, ) => { const signatureHelpToolTipName = "signature-help-tool-tip" + onScroll$.subscribe(_ => toolTips.hideToolTip(signatureHelpToolTipName)) // Show signature help as the cursor moves latestCursorAndBufferInfo$ - .flatMap(async val => { - return showSignatureHelp(val.language, val.filePath, val.cursorLine, val.cursorColumn) - }) + .flatMap(val => + showSignatureHelp(val.language, val.filePath, val.cursorLine, val.cursorColumn), + ) .subscribe(result => { if (result) { toolTips.showToolTip(signatureHelpToolTipName, SignatureHelp.render(result), { diff --git a/browser/src/Services/Language/Workspace.ts b/browser/src/Services/Language/Workspace.ts index fe1b960ee5..cf5c8aeff8 100644 --- a/browser/src/Services/Language/Workspace.ts +++ b/browser/src/Services/Language/Workspace.ts @@ -4,16 +4,13 @@ * Handles workspace/ messages */ +import * as Oni from "oni-api" import * as types from "vscode-languageserver-types" -import { IWorkspace } from "./../Workspace" - import { LanguageManager } from "./LanguageManager" -export const listenForWorkspaceEdits = ( - languageManager: LanguageManager, - workspace: IWorkspace, -) => { +export const listenForWorkspaceEdits = (languageManager: LanguageManager, oni: Oni.Plugin.Api) => { + const workspace = oni.workspace languageManager.handleLanguageServerRequest("workspace/applyEdit", async (args: any) => { const payload: types.WorkspaceEdit = args.payload.edit.changes await workspace.applyEdits(payload) diff --git a/browser/src/Services/Language/addInsertModeLanguageFunctionality.ts b/browser/src/Services/Language/addInsertModeLanguageFunctionality.ts index 73afb75443..378d8bc13a 100644 --- a/browser/src/Services/Language/addInsertModeLanguageFunctionality.ts +++ b/browser/src/Services/Language/addInsertModeLanguageFunctionality.ts @@ -26,11 +26,12 @@ export interface ILatestCursorAndBufferInfo { export const addInsertModeLanguageFunctionality = ( cursorMoved$: Observable, modeChanged$: Observable, + onScroll$: Observable, toolTips: IToolTipsProvider, ) => { const latestCursorAndBufferInfo$: Observable< ILatestCursorAndBufferInfo - > = cursorMoved$.auditTime(10).mergeMap(async cursorPos => { + > = cursorMoved$.mergeMap(async cursorPos => { const editor = editorManager.activeEditor const buffer = editor.activeBuffer @@ -45,5 +46,5 @@ export const addInsertModeLanguageFunctionality = ( } }) - SignatureHelp.initUI(latestCursorAndBufferInfo$, modeChanged$, toolTips) + SignatureHelp.initUI(latestCursorAndBufferInfo$, modeChanged$, onScroll$, toolTips) } diff --git a/browser/src/Services/Learning/LearningPane.tsx b/browser/src/Services/Learning/LearningPane.tsx index e287a16c65..75c7062dff 100644 --- a/browser/src/Services/Learning/LearningPane.tsx +++ b/browser/src/Services/Learning/LearningPane.tsx @@ -169,6 +169,7 @@ export class LearningPaneView extends PureComponentWithDisposeTracking< const tutorialItems = (selectedId: string) => this.state.tutorialInfo.map(t => ( } diff --git a/browser/src/Services/Menu/Filter/index.ts b/browser/src/Services/Menu/Filter/index.ts index 7fbff4a4fb..a98a30ecde 100644 --- a/browser/src/Services/Menu/Filter/index.ts +++ b/browser/src/Services/Menu/Filter/index.ts @@ -1,13 +1,12 @@ -// import * as Oni from "oni-api" -import * as OniNext from "../../../Plugins/Api/Oni" +import * as Oni from "oni-api" import { filter as fuseFilter } from "./FuseFilter" import { filter as noFilter } from "./NoFilter" import { filter as RegExFilter } from "./RegExFilter" import { filter as vscodeFilter } from "./VSCodeFilter" -class Filters implements OniNext.IMenuFilters { - private _filters = new Map() +class Filters implements Oni.Menu.IMenuFilters { + private _filters = new Map() constructor() { this._filters @@ -18,11 +17,11 @@ class Filters implements OniNext.IMenuFilters { .set("vscode", vscodeFilter) } - public getDefault(): OniNext.IMenuFilter { + public getDefault(): Oni.Menu.IMenuFilter { return this.getByName("default") } - public getByName(name: string): OniNext.IMenuFilter { + public getByName(name: string): Oni.Menu.IMenuFilter { return this._filters.has(name) ? this._filters.get(name) : this.getDefault() } @@ -31,6 +30,6 @@ class Filters implements OniNext.IMenuFilters { const _instance = new Filters() -export function getInstance(owner: string): OniNext.IMenuFilters { +export function getInstance(owner: string): Oni.Menu.IMenuFilters { return _instance } diff --git a/browser/src/Services/Menu/MenuComponent.tsx b/browser/src/Services/Menu/MenuComponent.tsx index 3436b5c08a..5ac4af1aee 100644 --- a/browser/src/Services/Menu/MenuComponent.tsx +++ b/browser/src/Services/Menu/MenuComponent.tsx @@ -8,7 +8,6 @@ import * as Oni from "oni-api" import { styled } from "../../UI/components/common" import { HighlightTextByIndex } from "./../../UI/components/HighlightText" -// import { Visible } from "./../../UI/components/Visible" import { Icon, IconSize } from "./../../UI/Icon" import { focusManager } from "./../FocusManager" diff --git a/browser/src/Services/Metadata.ts b/browser/src/Services/Metadata.ts index a37181d0e5..1fe179aaaf 100644 --- a/browser/src/Services/Metadata.ts +++ b/browser/src/Services/Metadata.ts @@ -4,7 +4,8 @@ * Provides information about Oni's pkg */ -import * as fs from "fs" +import { readFile } from "fs-extra" +import * as Log from "oni-core-logging" import * as os from "os" import * as path from "path" @@ -15,24 +16,15 @@ export interface IMetadata { export const getMetadata = async (): Promise => { const packageMetadata = path.join(__dirname, "package.json") - - return new Promise((resolve, reject) => { - fs.readFile(packageMetadata, "utf8", (err: NodeJS.ErrnoException, data: string) => { - if (err) { - reject(err) - return - } - - const pkg = JSON.parse(data) - - const metadata = { - name: pkg.name, - version: pkg.version, - } - - resolve(metadata) - }) - }) + try { + const data = await readFile(packageMetadata, "utf8") + const pkg = JSON.parse(data) + const metadata = { name: pkg.name, version: pkg.version } + return metadata + } catch (e) { + Log.warn(`Oni Error: failed to fetch Oni package metadata because ${e.message}`) + return { name: null, version: null } + } } export const showAboutMessage = async () => { diff --git a/browser/src/Services/Search/SearchPaneView.tsx b/browser/src/Services/Search/SearchPaneView.tsx index 47058ff209..a361a985bc 100644 --- a/browser/src/Services/Search/SearchPaneView.tsx +++ b/browser/src/Services/Search/SearchPaneView.tsx @@ -4,6 +4,7 @@ * Entry point for search-related features */ +import * as Oni from "oni-api" import * as React from "react" import { IDisposable, IEvent } from "oni-types" @@ -12,8 +13,6 @@ import { Workspace } from "./../Workspace" export * from "./SearchProvider" -import * as SearchApi from "./../../Plugins/Api/Search" // TODO: Import oni-api instead - import styled from "styled-components" import { SearchTextBox } from "./SearchTextBox" @@ -31,7 +30,7 @@ export interface ISearchPaneViewProps { onFocus: IEvent focusImmediately?: boolean - onSearchOptionsChanged: (opts: SearchApi.Options) => void + onSearchOptionsChanged: (opts: Oni.Search.Options) => void } export interface ISearchPaneViewState { diff --git a/browser/src/Services/Search/SearchProvider.ts b/browser/src/Services/Search/SearchProvider.ts index 33525918a3..981583b384 100644 --- a/browser/src/Services/Search/SearchProvider.ts +++ b/browser/src/Services/Search/SearchProvider.ts @@ -2,13 +2,13 @@ import { Event, IEvent } from "oni-types" import { configuration } from "./../Configuration" -import * as SearchApi from "./../../Plugins/Api/Search" // TODO: Import oni-api instead +import * as Oni from "oni-api" import { FinderProcess } from "./FinderProcess" import * as RipGrep from "./RipGrep" -class NullSearchQuery implements SearchApi.Query { - public _onSearchResults = new Event() +class NullSearchQuery implements Oni.Search.Query { + public _onSearchResults = new Event() public start(): void { return undefined @@ -18,17 +18,17 @@ class NullSearchQuery implements SearchApi.Query { return undefined } - public get onSearchResults(): IEvent { + public get onSearchResults(): IEvent { return this._onSearchResults } } -export class Search implements SearchApi.ISearch { - public get nullSearch(): SearchApi.Query { +export class Search implements Oni.Search.ISearch { + public get nullSearch(): Oni.Search.Query { return new NullSearchQuery() } - public findInFile(opts: SearchApi.Options): SearchApi.Query { + public findInFile(opts: Oni.Search.Options): Oni.Search.Query { const commandParts = [ RipGrep.getCommand(), "--ignore-case", @@ -42,7 +42,7 @@ export class Search implements SearchApi.ISearch { return new SearchQuery(commandParts.join(" "), parseRipGrepLine) } - public findInPath(opts: SearchApi.Options): SearchApi.Query { + public findInPath(opts: Oni.Search.Options): Oni.Search.Query { const commandParts = [ RipGrep.getCommand(), ...RipGrep.getArguments(configuration.getValue("oni.exclude")), @@ -54,7 +54,7 @@ export class Search implements SearchApi.ISearch { } } -function parseRipGrepLine(ripGrepResult: string): SearchApi.ResultItem { +function parseRipGrepLine(ripGrepResult: string): Oni.Search.ResultItem { if (!ripGrepResult || ripGrepResult.length === 0) { return null } @@ -75,7 +75,7 @@ function parseRipGrepLine(ripGrepResult: string): SearchApi.ResultItem { } } -function parseRipGrepFilesLine(line: string): SearchApi.ResultItem { +function parseRipGrepFilesLine(line: string): Oni.Search.ResultItem { if (!line || line.length === 0) { return null } @@ -88,15 +88,15 @@ function parseRipGrepFilesLine(line: string): SearchApi.ResultItem { } } -type IParseLine = (line: string) => SearchApi.ResultItem +type IParseLine = (line: string) => Oni.Search.ResultItem -class SearchQuery implements SearchApi.Query { - private _onSearchResults = new Event() +class SearchQuery implements Oni.Search.Query { + private _onSearchResults = new Event() private _finderProcess: FinderProcess - private _items: SearchApi.ResultItem[] = [] + private _items: Oni.Search.ResultItem[] = [] - public get onSearchResults(): IEvent { + public get onSearchResults(): IEvent { return this._onSearchResults } diff --git a/browser/src/Services/Search/index.tsx b/browser/src/Services/Search/index.tsx index e77faf1052..a6d26f94a9 100644 --- a/browser/src/Services/Search/index.tsx +++ b/browser/src/Services/Search/index.tsx @@ -1,9 +1,6 @@ import * as Oni from "oni-api" import * as Log from "oni-core-logging" -import * as OniImpl from "./../../Plugins/Api/Oni" // TODO: Import oni-api instead -import * as SearchApi from "./../../Plugins/Api/Search" // TODO: Import oni-api instead - import { Workspace } from "./../Workspace" import * as React from "react" @@ -24,9 +21,9 @@ export class SearchPane { private _onSearchCompleted = new Event() private _shouldFocusAutomatically: boolean = false - private _currentQuery: SearchApi.Query + private _currentQuery: Oni.Search.Query - private _searchOptionsObservable = new Subject() + private _searchOptionsObservable = new Subject() public get id(): string { return "oni.sidebar.search" @@ -36,11 +33,8 @@ export class SearchPane { return "Search" } - constructor( - private _onFocusEvent: IEvent, - private _oni: OniImpl.Oni, // TODO: Change to Oni.Plugin.Api - ) { - this._searchOptionsObservable.auditTime(100).subscribe((opts: SearchApi.Options) => { + constructor(private _onFocusEvent: IEvent, private _oni: Oni.Plugin.Api) { + this._searchOptionsObservable.auditTime(100).subscribe((opts: Oni.Search.Options) => { this._startNewSearch(opts) }) @@ -82,11 +76,11 @@ export class SearchPane { ) } - private _onSearchOptionsChanged(searchOpts: SearchApi.Options): void { + private _onSearchOptionsChanged(searchOpts: Oni.Search.Options): void { this._searchOptionsObservable.next(searchOpts) } - private _startNewSearch(searchOpts: SearchApi.Options): void { + private _startNewSearch(searchOpts: Oni.Search.Options): void { if (this._currentQuery) { this._currentQuery.cancel() } @@ -99,17 +93,22 @@ export class SearchPane { this._onSearchStarted.dispatch() - const query = this._oni.search.findInFile(searchOpts) - - query.start() - + const query = (this._currentQuery = this._oni.search.findInFile(searchOpts)) + const toQuickFixItem = (r: Oni.Search.ResultItem) => { + return { + filename: r.fileName, + lnum: r.line, + col: r.column, + text: r.text.trim(), + } + } query.onSearchResults.subscribe(result => { if (result.isComplete) { this._onSearchCompleted.dispatch() + this._oni.populateQuickFix(result.items.map(toQuickFixItem)) } }) - - this._currentQuery = query + query.start() } } @@ -125,7 +124,7 @@ export function activate(oni: any): any { const searchAllFiles = () => { sidebarManager.toggleVisibilityById("oni.sidebar.search") // TODO: Use oni-api instead - // TODO: Add sidebar.setActiveEntry to the API and use oniApi instead of oni + // TODO: Add sidebar.setActiveEntry to the API and use oni as Oni (API) // oni.sidebar.setActiveEntry("oni.sidebar.search") onFocusEvent.dispatch() } diff --git a/browser/src/Services/Sessions/SessionManager.ts b/browser/src/Services/Sessions/SessionManager.ts new file mode 100644 index 0000000000..f12c35dcc7 --- /dev/null +++ b/browser/src/Services/Sessions/SessionManager.ts @@ -0,0 +1,181 @@ +import * as fs from "fs-extra" +import { Editor, EditorManager, Plugin } from "oni-api" +import { IEvent } from "oni-types" +import * as path from "path" + +import { SidebarManager } from "../Sidebar" +import { SessionActions, SessionsPane, store } from "./" +import { getPersistentStore, IPersistentStore } from "./../../PersistentStore" +import { getUserConfigFolderPath } from "./../../Services/Configuration/UserConfiguration" + +export interface ISession { + name: string + id: string + file: string + directory: string + updatedAt?: string + workspace: string + // can be use to save other metadata for restoration like statusbar info or sidebar info etc + metadata?: { [key: string]: any } +} + +export interface ISessionService { + sessionsDir: string + allSessions: ISession[] + persistSession(sessionName: string): Promise + restoreSession(sessionName: string): Promise +} + +export interface UpdatedOni extends Plugin.Api { + editors: UpdatedEditorManager +} + +interface UpdatedEditorManager extends EditorManager { + activeEditor: UpdatedEditor +} + +interface UpdatedEditor extends Editor { + onQuit: IEvent + persistSession(sessionDetails: ISession): Promise + restoreSession(sessionDetails: ISession): Promise + getCurrentSession(): Promise +} + +/** + * Class SessionManager + * + * Provides a service to manage oni session i.e. buffers, screen layout etc. + * + */ +export class SessionManager implements ISessionService { + private _store = store({ sessionManager: this, fs }) + private get _sessionsDir() { + const defaultDirectory = path.join(getUserConfigFolderPath(), "sessions") + const userDirectory = this._oni.configuration.getValue( + "experimental.sessions.directory", + ) + const directory = userDirectory || defaultDirectory + return directory + } + + constructor( + private _oni: UpdatedOni, + private _sidebarManager: SidebarManager, + private _persistentStore: IPersistentStore<{ [sessionName: string]: ISession }>, + ) { + fs.ensureDirSync(this.sessionsDir) + const enabled = this._oni.configuration.getValue("experimental.sessions.enabled") + if (enabled) { + this._store.dispatch({ type: "POPULATE_SESSIONS" }) + this._sidebarManager.add( + "save", + new SessionsPane({ store: this._store, commands: this._oni.commands }), + ) + } + this._setupSubscriptions() + } + + public get allSessions() { + const state = this._store.getState() + return state.sessions + } + + public get sessionsDir() { + return this._sessionsDir + } + + public async updateOniSession(name: string, value: Partial) { + const persistedSessions = await this._persistentStore.get() + if (name in persistedSessions) { + this._persistentStore.set({ + ...persistedSessions, + [name]: { ...persistedSessions[name], ...value }, + }) + } + } + + public async createOniSession(sessionName: string) { + const persistedSessions = await this._persistentStore.get() + const file = this._getSessionFilename(sessionName) + + const session: ISession = { + file, + id: sessionName, + name: sessionName, + directory: this.sessionsDir, + workspace: this._oni.workspace.activeWorkspace, + metadata: null, + } + + this._persistentStore.set({ ...persistedSessions, [sessionName]: session }) + + return session + } + + /** + * Retrieve or Create a persistent Oni Session + * + * @name getSessionFromStore + * @function + * @param {string} sessionName The name of the session + * @returns {ISession} The session metadata object + */ + public async getSessionFromStore(name: string) { + const sessions = await this._persistentStore.get() + if (name in sessions) { + return sessions[name] + } + return this.createOniSession(name) + } + + public persistSession = async (sessionName: string) => { + const sessionDetails = await this.getSessionFromStore(sessionName) + await this._oni.editors.activeEditor.persistSession(sessionDetails) + return sessionDetails + } + + public deleteSession = async (sessionName: string) => { + await this._persistentStore.delete(sessionName) + } + + public getCurrentSession = async () => { + const filepath = await this._oni.editors.activeEditor.getCurrentSession() + if (!filepath) { + return null + } + const [name] = path.basename(filepath).split(".") + return filepath.includes(this._sessionsDir) ? this.getSessionFromStore(name) : null + } + + public restoreSession = async (name: string) => { + const sessionDetails = await this.getSessionFromStore(name) + await this._oni.editors.activeEditor.restoreSession(sessionDetails) + const session = await this.getCurrentSession() + return session + } + + private _getSessionFilename(name: string) { + return path.join(this.sessionsDir, `${name}.vim`) + } + + private _setupSubscriptions() { + this._oni.editors.activeEditor.onBufferEnter.subscribe(() => { + this._store.dispatch(SessionActions.updateCurrentSession()) + }) + this._oni.editors.activeEditor.onQuit.subscribe(() => { + this._store.dispatch(SessionActions.updateCurrentSession()) + }) + } +} + +function init() { + let instance: SessionManager + return { + getInstance: () => instance, + activate: (oni: Plugin.Api, sidebarManager: SidebarManager) => { + const persistentStore = getPersistentStore("sessions", {}, 1) + instance = new SessionManager(oni as UpdatedOni, sidebarManager, persistentStore) + }, + } +} +export const { activate, getInstance } = init() diff --git a/browser/src/Services/Sessions/Sessions.tsx b/browser/src/Services/Sessions/Sessions.tsx new file mode 100644 index 0000000000..f37748ce9d --- /dev/null +++ b/browser/src/Services/Sessions/Sessions.tsx @@ -0,0 +1,228 @@ +import * as path from "path" +import * as React from "react" +import { connect } from "react-redux" + +import SectionTitle from "../../UI/components/SectionTitle" +import { Icon } from "../../UI/Icon" + +import styled, { css, sidebarItemSelected, withProps } from "../../UI/components/common" +import TextInputView from "../../UI/components/LightweightText" +import { VimNavigator } from "../../UI/components/VimNavigator" +import { getTimeSince } from "../../Utility" +import { ISession, ISessionState, SessionActions } from "./" + +interface IStateProps { + sessions: ISession[] + active: boolean + creating: boolean + selected: ISession +} + +interface ISessionActions { + populateSessions: () => void + updateSelection: (selected: string) => void + getAllSessions: (sessions: ISession[]) => void + updateSession: (session: ISession) => void + restoreSession: (session: string) => void + persistSession: (session: string) => void + createSession: () => void + cancelCreating: () => void +} + +interface IConnectedProps extends IStateProps, ISessionActions {} + +interface ISessionItem { + session: ISession + isSelected: boolean + onClick: () => void +} + +export const Container = styled.div` + padding: 0 1em; +` + +const SessionItem: React.SFC = ({ session, isSelected, onClick }) => { + const truncatedWorkspace = session.workspace + .split(path.sep) + .slice(-2) + .join(path.sep) + + return ( + +
+ + Name: {session.name} + +
+
Workspace: {truncatedWorkspace}
+ {
Last updated: {getTimeSince(new Date(session.updatedAt))} ago
} + + ) +} + +const inputStyles = css` + background-color: transparent; + width: 100%; + font-family: inherit; + font-size: inherit; + color: ${p => p.theme["sidebar.foreground"]}; +` + +const ListItem = withProps>(styled.li)` + box-sizing: border-box; + padding: 0.5em 1em; + ${sidebarItemSelected}; +` + +const List = styled.ul` + list-style-type: none; + padding: 0; + margin: 0; +` + +interface IState { + sessionName: string + showAll: boolean +} + +interface IIDs { + input: string + title: string +} + +export class Sessions extends React.PureComponent { + public readonly _ID: Readonly = { + input: "new_session", + title: "title", + } + + public state = { + sessionName: "", + showAll: true, + } + + public async componentDidMount() { + this.props.populateSessions() + } + + public updateSelection = (selected: string) => { + this.props.updateSelection(selected) + } + + public handleSelection = async (id: string) => { + const { sessionName } = this.state + const inputSelected = id === this._ID.input + const isTitle = id === this._ID.title + const isReadonlyField = id in this._ID + switch (true) { + case inputSelected && this.props.creating: + await this.props.persistSession(sessionName) + break + case inputSelected && !this.props.creating: + this.props.createSession() + break + case isTitle: + this.setState({ showAll: !this.state.showAll }) + break + case isReadonlyField: + break + default: + await this.props.restoreSession(id) + break + } + } + + public restoreSession = async (selected: string) => { + if (selected) { + await this.props.restoreSession(selected) + } + } + + public handleChange: React.ChangeEventHandler = evt => { + const { value } = evt.currentTarget + this.setState({ sessionName: value }) + } + + public persistSession = async () => { + const { sessionName } = this.state + if (sessionName) { + await this.props.persistSession(sessionName) + } + } + + public handleCancel = () => { + if (this.props.creating) { + this.props.cancelCreating() + } + this.setState({ sessionName: "" }) + } + + public render() { + const { showAll } = this.state + const { sessions, active, creating } = this.props + const ids = [this._ID.title, this._ID.input, ...sessions.map(({ id }) => id)] + return ( + ( + + this.handleSelection(selectedId)} + /> + {showAll && ( + <> + + {creating ? ( + + ) : ( +
this.handleSelection(selectedId)}> + Create a new session +
+ )} + + {sessions.length ? ( + sessions.map((session, idx) => ( + { + updateSelection(session.id) + this.handleSelection(session.id) + }} + /> + )) + ) : ( + No Sessions Saved + )} + + )} + + )} + /> + ) + } +} + +const mapStateToProps = ({ sessions, selected, active, creating }: ISessionState): IStateProps => ({ + sessions, + active, + creating, + selected, +}) + +export default connect(mapStateToProps, SessionActions)(Sessions) diff --git a/browser/src/Services/Sessions/SessionsPane.tsx b/browser/src/Services/Sessions/SessionsPane.tsx new file mode 100644 index 0000000000..218019ea03 --- /dev/null +++ b/browser/src/Services/Sessions/SessionsPane.tsx @@ -0,0 +1,71 @@ +import { Commands } from "oni-api" +import * as React from "react" +import { Provider } from "react-redux" + +import { ISessionStore, Sessions } from "./" + +interface SessionPaneProps { + commands: Commands.Api + store: ISessionStore +} + +/** + * Class SessionsPane + * + * A Side bar pane for Oni's Session Management + * + */ +export default class SessionsPane { + private _store: ISessionStore + private _commands: Commands.Api + + constructor({ store, commands }: SessionPaneProps) { + this._commands = commands + this._store = store + + this._setupCommands() + } + + get id() { + return "oni.sidebar.sessions" + } + + public get title() { + return "Sessions" + } + + public enter() { + this._store.dispatch({ type: "ENTER" }) + } + + public leave() { + this._store.dispatch({ type: "LEAVE" }) + } + + public render() { + return ( + + + + ) + } + + private _isActive = () => { + const state = this._store.getState() + return state.active && !state.creating + } + + private _deleteSession = () => { + this._store.dispatch({ type: "DELETE_SESSION" }) + } + + private _setupCommands() { + this._commands.registerCommand({ + command: "oni.sessions.delete", + name: "Sessions: Delete the current session", + detail: "Delete the current or selected session", + enabled: this._isActive, + execute: this._deleteSession, + }) + } +} diff --git a/browser/src/Services/Sessions/SessionsStore.ts b/browser/src/Services/Sessions/SessionsStore.ts new file mode 100644 index 0000000000..739b424893 --- /dev/null +++ b/browser/src/Services/Sessions/SessionsStore.ts @@ -0,0 +1,303 @@ +import "rxjs" + +import * as fsExtra from "fs-extra" +import * as path from "path" +import { Store } from "redux" +import { combineEpics, createEpicMiddleware, Epic, ofType } from "redux-observable" +import { from } from "rxjs/observable/from" +import { auditTime, catchError, filter, flatMap } from "rxjs/operators" + +import { ISession, SessionManager } from "./" +import { createStore as createReduxStore } from "./../../Redux" + +export interface ISessionState { + sessions: ISession[] + selected: ISession + currentSession: ISession + active: boolean + creating: boolean +} + +const DefaultState: ISessionState = { + sessions: [], + selected: null, + active: false, + creating: false, + currentSession: null, +} + +interface IGenericAction { + type: N + payload?: T +} + +export type ISessionStore = Store + +export type IUpdateMultipleSessions = IGenericAction<"GET_ALL_SESSIONS", { sessions: ISession[] }> +export type IUpdateSelection = IGenericAction<"UPDATE_SELECTION", { selected: string }> +export type IUpdateSession = IGenericAction<"UPDATE_SESSION", { session: ISession }> +export type IRestoreSession = IGenericAction<"RESTORE_SESSION", { sessionName: string }> +export type IPersistSession = IGenericAction<"PERSIST_SESSION", { sessionName: string }> +export type IPersistSessionSuccess = IGenericAction<"PERSIST_SESSION_SUCCESS"> +export type IPersistSessionFailed = IGenericAction<"PERSIST_SESSION_FAILED", { error: Error }> +export type IRestoreSessionError = IGenericAction<"RESTORE_SESSION_ERROR", { error: Error }> +export type IDeleteSession = IGenericAction<"DELETE_SESSION"> +export type IDeleteSessionSuccess = IGenericAction<"DELETE_SESSION_SUCCESS"> +export type IDeleteSessionFailed = IGenericAction<"DELETE_SESSION_FAILED"> +export type IUpdateCurrentSession = IGenericAction<"UPDATE_CURRENT_SESSION"> +export type ISetCurrentSession = IGenericAction<"SET_CURRENT_SESSION", { session: ISession }> +export type IPopulateSessions = IGenericAction<"POPULATE_SESSIONS"> +export type ICreateSession = IGenericAction<"CREATE_SESSION"> +export type ICancelCreateSession = IGenericAction<"CANCEL_NEW_SESSION"> +export type IEnter = IGenericAction<"ENTER"> +export type ILeave = IGenericAction<"LEAVE"> + +export type ISessionActions = + | IUpdateMultipleSessions + | ICancelCreateSession + | IRestoreSessionError + | IUpdateCurrentSession + | IPopulateSessions + | IUpdateSelection + | IUpdateSession + | IPersistSession + | IPersistSessionSuccess + | IPersistSessionFailed + | IDeleteSession + | IDeleteSessionSuccess + | IDeleteSessionFailed + | IRestoreSession + | ISetCurrentSession + | ICreateSession + | IEnter + | ILeave + +export const SessionActions = { + persistSessionSuccess: () => ({ type: "PERSIST_SESSION_SUCCESS" } as IPersistSessionSuccess), + populateSessions: () => ({ type: "POPULATE_SESSIONS" } as IPopulateSessions), + deleteSession: () => ({ type: "DELETE_SESSION" } as IDeleteSession), + cancelCreating: () => ({ type: "CANCEL_NEW_SESSION" } as ICancelCreateSession), + createSession: () => ({ type: "CREATE_SESSION" } as ICreateSession), + updateCurrentSession: () => ({ type: "UPDATE_CURRENT_SESSION" } as IUpdateCurrentSession), + deleteSessionSuccess: () => ({ type: "DELETE_SESSION_SUCCESS" } as IDeleteSessionSuccess), + + updateSession: (session: ISession) => ({ type: "UPDATE_SESSION", session } as IUpdateSession), + setCurrentSession: (session: ISession) => + ({ type: "SET_CURRENT_SESSION", payload: { session } } as ISetCurrentSession), + + deleteSessionFailed: (error: Error) => + ({ type: "DELETE_SESSION_FAILED", error } as IDeleteSessionFailed), + + persistSessionFailed: (error: Error) => + ({ type: "PERSIST_SESSION_FAILED", error } as IPersistSessionFailed), + + updateSelection: (selected: string) => + ({ type: "UPDATE_SELECTION", payload: { selected } } as IUpdateSelection), + + getAllSessions: (sessions: ISession[]) => + ({ + type: "GET_ALL_SESSIONS", + payload: { sessions }, + } as IUpdateMultipleSessions), + + persistSession: (sessionName: string) => + ({ + type: "PERSIST_SESSION", + payload: { sessionName }, + } as IPersistSession), + + restoreSessionError: (error: Error) => + ({ + type: "RESTORE_SESSION_ERROR", + payload: { error }, + } as IRestoreSessionError), + + restoreSession: (sessionName: string) => + ({ + type: "RESTORE_SESSION", + payload: { sessionName }, + } as IRestoreSession), +} + +type SessionEpic = Epic + +export const persistSessionEpic: SessionEpic = (action$, store, { sessionManager }) => + action$.pipe( + ofType("PERSIST_SESSION"), + auditTime(200), + flatMap((action: IPersistSession) => { + return from(sessionManager.persistSession(action.payload.sessionName)).pipe( + flatMap(session => { + return [ + SessionActions.cancelCreating(), + SessionActions.persistSessionSuccess(), + SessionActions.setCurrentSession(session), + SessionActions.populateSessions(), + ] + }), + catchError(error => [SessionActions.persistSessionFailed(error)]), + ) + }), + ) + +const updateCurrentSessionEpic: SessionEpic = (action$, store, { fs, sessionManager }) => { + return action$.pipe( + ofType("UPDATE_CURRENT_SESSION"), + auditTime(200), + flatMap(() => + from(sessionManager.getCurrentSession()).pipe( + filter(session => !!session), + flatMap(currentSession => [SessionActions.persistSession(currentSession.name)]), + catchError(error => [SessionActions.persistSessionFailed(error)]), + ), + ), + ) +} + +const deleteSessionEpic: SessionEpic = (action$, store, { fs, sessionManager }) => + action$.pipe( + ofType("DELETE_SESSION"), + flatMap(() => { + const { selected, currentSession } = store.getState() + const sessionToDelete = selected || currentSession + return from( + fs + .remove(sessionToDelete.file) + .then(() => sessionManager.deleteSession(sessionToDelete.name)), + ).pipe( + flatMap(() => [ + SessionActions.deleteSessionSuccess(), + SessionActions.populateSessions(), + ]), + catchError(error => { + return [SessionActions.deleteSessionFailed(error)] + }), + ) + }), + ) + +const restoreSessionEpic: SessionEpic = (action$, store, { sessionManager }) => + action$.pipe( + ofType("RESTORE_SESSION"), + flatMap((action: IRestoreSession) => + from(sessionManager.restoreSession(action.payload.sessionName)).pipe( + flatMap(session => [ + SessionActions.setCurrentSession(session), + SessionActions.populateSessions(), + ]), + ), + ), + catchError(error => [SessionActions.restoreSessionError(error)]), + ) + +export const fetchSessionsEpic: SessionEpic = (action$, store, { fs, sessionManager }) => + action$.pipe( + ofType("POPULATE_SESSIONS"), + flatMap((action: IPopulateSessions) => { + return from( + fs.readdir(sessionManager.sessionsDir).then(async dir => { + const metadata = await Promise.all( + dir.map(async file => { + const filepath = path.join(sessionManager.sessionsDir, file) + // use fs.stat mtime to figure when last a file was modified + const { mtime } = await fs.stat(filepath) + const [name] = file.split(".") + return { + name, + file: filepath, + updatedAt: mtime.toUTCString(), + } + }), + ) + + const sessions = Promise.all( + metadata.map(async ({ file, name, updatedAt }) => { + const savedSession = await sessionManager.getSessionFromStore(name) + await sessionManager.updateOniSession(name, { updatedAt }) + return { ...savedSession, updatedAt } + }), + ) + return sessions + }), + ).flatMap(sessions => [SessionActions.getAllSessions(sessions)]) + }), + ) + +const findSelectedSession = (sessions: ISession[], selected: string) => + sessions.find(session => session.id === selected) + +const updateSessions = (sessions: ISession[], newSession: ISession) => + sessions.map(session => (session.id === newSession.id ? newSession : session)) + +function reducer(state: ISessionState, action: ISessionActions) { + switch (action.type) { + case "UPDATE_SESSION": + return { + ...state, + sessions: updateSessions(state.sessions, action.payload.session), + } + case "GET_ALL_SESSIONS": + return { + ...state, + sessions: action.payload.sessions, + } + case "CREATE_SESSION": + return { + ...state, + creating: true, + } + case "DELETE_SESSION_SUCCESS": + return { + ...state, + currentSession: null, + } + case "SET_CURRENT_SESSION": + return { + ...state, + currentSession: action.payload.session, + } + case "CANCEL_NEW_SESSION": + return { + ...state, + creating: false, + } + case "ENTER": + return { + ...state, + active: true, + } + case "LEAVE": + return { + ...state, + active: false, + } + case "UPDATE_SELECTION": + return { + ...state, + selected: findSelectedSession(state.sessions, action.payload.selected), + } + default: + return state + } +} + +interface Dependencies { + fs: typeof fsExtra + sessionManager: SessionManager +} + +const createStore = (dependencies: Dependencies) => + createReduxStore("sessions", reducer, DefaultState, [ + createEpicMiddleware( + combineEpics( + fetchSessionsEpic, + persistSessionEpic, + restoreSessionEpic, + updateCurrentSessionEpic, + deleteSessionEpic, + ), + { dependencies }, + ), + ]) + +export default createStore diff --git a/browser/src/Services/Sessions/index.ts b/browser/src/Services/Sessions/index.ts new file mode 100644 index 0000000000..27c354b905 --- /dev/null +++ b/browser/src/Services/Sessions/index.ts @@ -0,0 +1,5 @@ +export * from "./SessionManager" +export * from "./SessionsStore" +export { default as SessionsPane } from "./SessionsPane" +export { default as Sessions } from "./Sessions" +export { default as store } from "./SessionsStore" diff --git a/browser/src/Services/Snippets/SnippetSession.ts b/browser/src/Services/Snippets/SnippetSession.ts index e5e84bc522..b604e4272b 100644 --- a/browser/src/Services/Snippets/SnippetSession.ts +++ b/browser/src/Services/Snippets/SnippetSession.ts @@ -14,7 +14,6 @@ import { Event, IEvent } from "oni-types" import { OniSnippet, OniSnippetPlaceholder } from "./OniSnippet" import { BufferIndentationInfo, IBuffer } from "./../../Editor/BufferManager" -import { IEditor } from "./../../Editor/Editor" import { SnippetVariableResolver } from "./SnippetVariableResolver" @@ -129,7 +128,7 @@ export class SnippetSession { return this._snippet.getLines() } - constructor(private _editor: IEditor, private _snippetString: string) {} + constructor(private _editor: Oni.Editor, private _snippetString: string) {} public async start(): Promise { this._buffer = this._editor.activeBuffer as IBuffer diff --git a/browser/src/Services/UnhandledErrorMonitor.ts b/browser/src/Services/UnhandledErrorMonitor.ts index 5db1e31c09..016b96791c 100644 --- a/browser/src/Services/UnhandledErrorMonitor.ts +++ b/browser/src/Services/UnhandledErrorMonitor.ts @@ -28,7 +28,7 @@ export class UnhandledErrorMonitor { } constructor() { - window.addEventListener("unhandledrejection", (evt: any) => { + window.addEventListener("unhandledrejection", (evt: PromiseRejectionEvent) => { if (!this._started) { this._queuedRejections.push(evt.reason) } diff --git a/browser/src/Services/VersionControl/VersionControlBlameLayer.tsx b/browser/src/Services/VersionControl/VersionControlBlameLayer.tsx new file mode 100644 index 0000000000..0f21be600f --- /dev/null +++ b/browser/src/Services/VersionControl/VersionControlBlameLayer.tsx @@ -0,0 +1,386 @@ +import { pathExists } from "fs-extra" +import { Buffer, BufferLayer, Commands, Configuration } from "oni-api" +import { warn } from "oni-core-logging" +import * as React from "react" +import { Transition } from "react-transition-group" +import { Position } from "vscode-languageserver-types" + +import { LayerContextWithCursor } from "../../Editor/NeovimEditor/NeovimBufferLayersView" +import styled, { pixel, textOverflow, withProps } from "../../UI/components/common" +import { getTimeSince } from "../../Utility" +import { VersionControlProvider } from "./" +import { Blame as IBlame } from "./VersionControlProvider" + +type TransitionStates = "entering" | "entered" | "exiting" + +interface IBlamePosition { + top: number + left: number + hide: boolean +} + +interface ICanFit { + canFit: boolean + message: string + position: IBlamePosition +} + +interface ILineDetails { + nextSpacing: number + lastEmptyLine: number +} + +export interface IProps extends LayerContextWithCursor { + getBlame: (lineOne: number, lineTwo: number) => Promise + timeout: number + cursorScreenLine: number + cursorBufferLine: number + currentLine: string + mode: "auto" | "manual" + fontFamily: string + setupCommand: (callback: () => void) => void +} + +export interface IState { + blame: IBlame + showBlame: boolean + currentLineContent: string + currentCursorBufferLine: number + error: Error +} + +interface IContainerProps { + height: number + top: number + left: number + fontFamily: string + hide: boolean + timeout: number + animationState: TransitionStates +} + +const getOpacity = (state: TransitionStates) => { + const transitionStyles = { + entering: 0, + entered: 0.5, + exiting: 0, + } + return transitionStyles[state] +} + +export const BlameContainer = withProps(styled.div).attrs({ + style: ({ top, left }: IContainerProps) => ({ + top: pixel(top), + left: pixel(left), + }), +})` + ${p => p.hide && `visibility: hidden`}; + width: auto; + box-sizing: border-box; + position: absolute; + font-style: italic; + font-family: ${p => p.fontFamily}; + color: ${p => p.theme["menu.foreground"]}; + opacity: ${p => getOpacity(p.animationState)}; + transition: opacity ${p => p.timeout}ms ease-in-out; + height: ${p => pixel(p.height)}; + line-height: ${p => pixel(p.height)}; + right: 3em; + ${textOverflow} +` + +const BlameDetails = styled.span` + color: inherit; + width: 100%; +` + +// CurrentLine - the string in the current line +// CursorLine - The 0 based position of the cursor in the file i.e. at line 30 this will be 29 +// CursorBufferLine - The 1 based position of the cursor in the file i.e. at line 30 it will be 30 +// CursorScreenLine - the position of the cursor within the visible lines so if line 30 is at the +// top of the viewport it will be 0 + +export class Blame extends React.PureComponent { + // Reset show blame to false when props change - do it here so it happens before rendering + // hide if the current line has changed or if the text of the line has changed + // aka input is in progress or if there is an empty line + public static getDerivedStateFromProps(nextProps: IProps, prevState: IState) { + const lineNumberChanged = nextProps.cursorBufferLine !== prevState.currentCursorBufferLine + const lineContentChanged = prevState.currentLineContent !== nextProps.currentLine + if ( + (prevState.showBlame && (lineNumberChanged || lineContentChanged)) || + !nextProps.currentLine + ) { + return { + showBlame: false, + blame: prevState.blame, + currentLineContent: nextProps.currentLine, + currentCursorBufferLine: nextProps.cursorBufferLine, + } + } + return null + } + + public state: IState = { + error: null, + blame: null, + showBlame: null, + currentLineContent: this.props.currentLine, + currentCursorBufferLine: this.props.cursorBufferLine, + } + + private _timeout: any + private readonly DURATION = 300 + private readonly LEFT_OFFSET = 4 + + public async componentDidMount() { + const { cursorBufferLine, mode } = this.props + await this.updateBlame(cursorBufferLine, cursorBufferLine) + if (mode === "auto") { + this.resetTimer() + } + this.props.setupCommand(() => { + const { showBlame } = this.state + this.setState({ showBlame: !showBlame }) + }) + } + + public async componentDidUpdate(prevProps: IProps, prevState: IState) { + const { cursorBufferLine, currentLine, mode } = this.props + if (prevProps.cursorBufferLine !== cursorBufferLine && currentLine) { + await this.updateBlame(cursorBufferLine, cursorBufferLine) + if (mode === "auto") { + return this.resetTimer() + } + } + } + + public componentWillUnmount() { + clearTimeout(this._timeout) + } + + public componentDidCatch(error: Error) { + warn(`Oni VCS Blame layer failed because: ${error.message}`) + this.setState({ error }) + } + + public resetTimer = () => { + clearTimeout(this._timeout) + this._timeout = setTimeout(() => { + if (this.props.currentLine) { + this.setState({ showBlame: true }) + } + }, this.props.timeout) + } + + public getLastEmptyLine() { + const { cursorLine, visibleLines, topBufferLine } = this.props + const lineDetails: ILineDetails = { + lastEmptyLine: null, + nextSpacing: null, + } + for ( + let currentBufferLine = cursorLine; + currentBufferLine >= topBufferLine; + currentBufferLine-- + ) { + const screenLine = currentBufferLine - topBufferLine + const line = visibleLines[screenLine] + if (!line.length) { + const nextLine = visibleLines[screenLine + 1] + lineDetails.lastEmptyLine = currentBufferLine + // search for index of first non-whitespace character which is equivalent + // to the whitespace count + lineDetails.nextSpacing = nextLine.search(/\S/) + break + } + } + return lineDetails + } + + public calculatePosition(canFit: boolean) { + const { cursorLine, cursorScreenLine, visibleLines } = this.props + const currentLine = visibleLines[cursorScreenLine] + const character = currentLine && currentLine.length + this.LEFT_OFFSET + + if (canFit) { + return this.getPosition({ line: cursorLine, character }) + } + + const { lastEmptyLine, nextSpacing } = this.getLastEmptyLine() + + if (lastEmptyLine) { + return this.getPosition({ line: lastEmptyLine - 1, character: nextSpacing }) + } + + return this.getPosition() + } + + // TODO: possibly add a caching strategy so a new call isn't made each time or + // get a blame for the entire file and store it + public updateBlame = async (lineOne: number, lineTwo: number) => { + const outOfBounds = this.isOutOfBounds(lineOne, lineTwo) + const blame = !outOfBounds ? await this.props.getBlame(lineOne, lineTwo) : null + this.setState({ blame }) + } + + public formatCommitDate(timestamp: string) { + return new Date(parseInt(timestamp, 10) * 1000) + } + + public getPosition(positionToRender?: Position): IBlamePosition { + const emptyPosition: IBlamePosition = { + hide: true, + top: null, + left: null, + } + if (!positionToRender) { + return emptyPosition + } + const position = this.props.bufferToPixel(positionToRender) + if (!position) { + return emptyPosition + } + return { + hide: false, + top: position.pixelY, + left: position.pixelX, + } + } + + public isOutOfBounds = (...lines: number[]) => { + return lines.some( + line => !line || line > this.props.bottomBufferLine || line < this.props.topBufferLine, + ) + } + + public getBlameText = (numberOfTruncations = 0) => { + const { blame } = this.state + if (!blame) { + return null + } + const { author, hash, committer_time } = blame + const formattedDate = this.formatCommitDate(committer_time) + const timeSince = `${getTimeSince(formattedDate)} ago` + const formattedHash = hash.slice(0, 4).toUpperCase() + + const words = blame.summary.split(" ") + const message = words.slice(0, words.length - numberOfTruncations).join(" ") + + const symbol = "…" + const summary = numberOfTruncations && words.length > 2 ? message.concat(symbol) : message + + return words.length < 2 + ? `${author}, ${timeSince}` + : `${author}, ${timeSince}, ${summary} #${formattedHash}` + } + + // Recursively calls get blame text if the message will not fit onto the screen up + // to a limit of 6 times each time removing one word from the blame message + // if after 6 attempts the message is still not small enougth then we render the popup + public canFit = (truncationAmount = 0): ICanFit => { + const { visibleLines, dimensions, cursorScreenLine } = this.props + const message = this.getBlameText(truncationAmount) + const currentLine = visibleLines[cursorScreenLine] || "" + const canFit = dimensions.width > currentLine.length + message.length + this.LEFT_OFFSET + + if (!canFit && truncationAmount <= 6) { + return this.canFit(truncationAmount + 1) + } + const truncatedOrFullMessage = canFit ? message : this.getBlameText() + return { + canFit, + message: truncatedOrFullMessage, + position: this.calculatePosition(canFit), + } + } + + public render() { + const { blame, showBlame, error } = this.state + if (!blame || !showBlame || error) { + return null + } + const { message, position } = this.canFit() + return ( + + {(state: TransitionStates) => ( + + {message} + + )} + + ) + } +} + +export default class VersionControlBlameLayer implements BufferLayer { + constructor( + private _buffer: Buffer, + private _vcsProvider: VersionControlProvider, + private _configuration: Configuration, + private _commands: Commands.Api, + ) {} + + public getBlame = async (lineOne: number, lineTwo: number) => { + const fileExists = await pathExists(this._buffer.filePath) + return ( + fileExists && + this._vcsProvider.getBlame({ file: this._buffer.filePath, lineOne, lineTwo }) + ) + } + + get id() { + return "vcs.blame" + } + + public setupCommand = (callback: () => void) => { + this._commands.registerCommand({ + command: "experimental.vcs.blame.toggleBlame", + name: null, + detail: null, + enabled: this._isActive, + execute: callback, + }) + } + + public getConfigOpts() { + const fontFamily = this._configuration.getValue("editor.fontFamily") + const timeout = this._configuration.getValue("experimental.vcs.blame.timeout") + const mode = this._configuration.getValue<"auto" | "manual">("experimental.vcs.blame.mode") + + return { timeout, mode, fontFamily } + } + + public render(context: LayerContextWithCursor) { + const cursorBufferLine = context.cursorLine + 1 + const cursorScreenLine = cursorBufferLine - context.topBufferLine + const config = this.getConfigOpts() + const activated = this._isActive() + return ( + activated && ( + + ) + ) + } + + private _isActive() { + return this._vcsProvider && this._vcsProvider.isActivated + } +} diff --git a/browser/src/Services/VersionControl/VersionControlManager.tsx b/browser/src/Services/VersionControl/VersionControlManager.tsx index 0eb8fdfa4c..abfbae4072 100644 --- a/browser/src/Services/VersionControl/VersionControlManager.tsx +++ b/browser/src/Services/VersionControl/VersionControlManager.tsx @@ -2,14 +2,15 @@ import { capitalize } from "lodash" import * as Oni from "oni-api" import * as Log from "oni-core-logging" import { IDisposable } from "oni-types" +import * as PQueue from "p-queue" import * as React from "react" import { store, SupportedProviders, VersionControlPane, VersionControlProvider } from "./" +import getBufferLayerInstance from "./../../Editor/NeovimEditor/BufferLayerManager" import { Notifications } from "./../../Services/Notifications" import { Branch } from "./../../UI/components/VersionControl/Branch" -import { MenuManager } from "./../Menu" import { SidebarManager } from "./../Sidebar" -import { IWorkspace } from "./../Workspace" +import VersionControlBlameLayer from "./VersionControlBlameLayer" interface ISendNotificationsArgs { detail: string @@ -27,16 +28,13 @@ export class VersionControlManager { private _vcsStatusItem: Oni.StatusBarItem private _subscriptions: IDisposable[] = [] private _providers = new Map() + private _bufferLayerManager = getBufferLayerInstance() + private _queue = new PQueue() constructor( - private _workspace: IWorkspace, - private _editorManager: Oni.EditorManager, - private _statusBar: Oni.StatusBar, - private _menu: MenuManager, - private _commands: Oni.Commands.Api, + private _oni: Oni.Plugin.Api, private _sidebar: SidebarManager, private _notifications: Notifications, - private _configuration: Oni.Configuration, ) {} public get providers() { @@ -55,7 +53,7 @@ export class VersionControlManager { await this._activateVCSProvider(provider) } - this._workspace.onDirectoryChanged.subscribe(async dir => { + this._oni.workspace.onDirectoryChanged.subscribe(async dir => { const providerToUse = await this.getCompatibleProvider(dir) await this.handleProviderStatus(providerToUse) }) @@ -67,13 +65,14 @@ export class VersionControlManager { const notification = this._notifications.createItem() notification.setContents(args.title, args.detail) notification.setExpiration(expiration) - notification.setLevel(args.level) + notification.setLevel(args.level) // TODO: Integrate setLevel into API notification.show() } - public deactivateProvider(): void { + public async deactivateProvider() { + await this._queue.onIdle() this._vcsProvider.deactivate() - this._subscriptions.map(s => s.dispose()) + this._subscriptions.map(sub => sub && sub.dispose()) if (this._vcsStatusItem) { this._vcsStatusItem.hide() } @@ -91,10 +90,10 @@ export class VersionControlManager { case isSameProvider: break case noCompatibleProvider: - this.deactivateProvider() + await this.deactivateProvider() break case newReplacementProvider: - this.deactivateProvider() + await this.deactivateProvider() await this._activateVCSProvider(newProvider) break case compatibleProvider: @@ -123,8 +122,8 @@ export class VersionControlManager { private _activateVCSProvider = async (provider: VersionControlProvider) => { this._vcs = provider.name this._vcsProvider = provider - await this._initialize() provider.activate() + await this._initialize() } private async _initialize() { @@ -132,22 +131,34 @@ export class VersionControlManager { await this._updateBranchIndicator() this._setupSubscriptions() - const hasVcsSidebar = this._sidebar.entries.some(({ id }) => id.includes("vcs")) - const enabled = this._configuration.getValue("experimental.vcs.sidebar") + const hasVcsSidebar = this._oni.sidebar.entries.some(({ id }) => id.includes("vcs")) + const enabled = this._oni.configuration.getValue("experimental.vcs.sidebar") if (!hasVcsSidebar && enabled) { const vcsPane = new VersionControlPane( - this._editorManager, - this._workspace, + this._oni, this._vcsProvider, this.sendNotification, - this._commands, - this._sidebar, + this._sidebar, // TODO: Refactor API store, ) - this._sidebar.add("code-fork", vcsPane) + this._sidebar.add("code-fork", vcsPane) // TODO: Refactor API } + // TODO: this should only be active if this is a file under version control + this._bufferLayerManager.addBufferLayer( + buffer => + this._oni.configuration.getValue("experimental.vcs.blame.enabled") && + !!buffer.filePath, + buf => + new VersionControlBlameLayer( + buf, + this._vcsProvider, + this._oni.configuration, + this._oni.commands, + ), + ) + this._registerCommands() } catch (e) { Log.warn(`Failed to initialise provider, because, ${e.message}`) @@ -156,43 +167,45 @@ export class VersionControlManager { private _setupSubscriptions() { this._subscriptions = [ - this._editorManager.activeEditor.onBufferEnter.subscribe(async () => { - await this._updateBranchIndicator() + this._oni.editors.activeEditor.onBufferEnter.subscribe(async () => { + await this._queue.add(this._updateBranchIndicator) }), this._vcsProvider.onBranchChanged.subscribe(async newBranch => { - await this._updateBranchIndicator(newBranch) - await this._editorManager.activeEditor.neovim.command("e!") + await this._queue.add(async () => { + await this._updateBranchIndicator(newBranch) + await this._oni.editors.activeEditor.neovim.command("e!") + }) }), - this._editorManager.activeEditor.onBufferSaved.subscribe(async () => { - await this._updateBranchIndicator() + this._oni.editors.activeEditor.onBufferSaved.subscribe(async () => { + await this._queue.add(this._updateBranchIndicator) }), - (this._workspace as any).onFocusGained.subscribe(async () => { - await this._updateBranchIndicator() + (this._oni.workspace as any).onFocusGained.subscribe(async () => { + await this._queue.add(this._updateBranchIndicator) }), ] } private _registerCommands = () => { const toggleVCS = () => { - this._sidebar.toggleVisibilityById("oni.sidebar.vcs") + this._sidebar.toggleVisibilityById("oni.sidebar.vcs") // TODO: Refactor API } - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: "vcs.sidebar.toggle", name: "Version Control: Toggle Visibility", detail: "Toggles the vcs pane in the sidebar", execute: toggleVCS, - enabled: () => this._configuration.getValue("experimental.vcs.sidebar"), + enabled: () => this._oni.configuration.getValue("experimental.vcs.sidebar"), }) - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: `vcs.fetch`, name: "Fetch the selected branch", detail: "", execute: this._fetchBranch, }) - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: `vcs.branches`, name: `Local ${capitalize(this._vcs)} Branches`, detail: "Open a menu with a list of all local branches", @@ -205,11 +218,10 @@ export class VersionControlManager { return } else if (!this._vcsStatusItem) { const vcsId = `oni.status.${this._vcs}` - this._vcsStatusItem = this._statusBar.createItem(1, vcsId) + this._vcsStatusItem = this._oni.statusBar.createItem(1, vcsId) } try { - // FIXME: there is race condition on deactivation of the provider const branch = await this._vcsProvider.getBranch() const diff = await this._vcsProvider.getDiff() @@ -237,7 +249,7 @@ export class VersionControlManager { this._vcsProvider.getLocalBranches(), ]) - this._menuInstance = this._menu.create() + this._menuInstance = this._oni.menu.create() if (!branches) { return @@ -277,7 +289,7 @@ export class VersionControlManager { if (this._menuInstance.isOpen() && this._menuInstance.selectedItem) { try { await this._vcsProvider.fetchBranchFromRemote({ - currentDir: this._workspace.activeWorkspace, + currentDir: this._oni.workspace.activeWorkspace, branch: this._menuInstance.selectedItem.label, }) } catch (e) { @@ -292,25 +304,11 @@ function init() { let Provider: VersionControlManager const Activate = ( - workspace: IWorkspace, - editorManager: Oni.EditorManager, - statusBar: Oni.StatusBar, - commands: Oni.Commands.Api, - menu: MenuManager, + oni: Oni.Plugin.Api, sidebar: SidebarManager, notifications: Notifications, - configuration: Oni.Configuration, ): void => { - Provider = new VersionControlManager( - workspace, - editorManager, - statusBar, - menu, - commands, - sidebar, - notifications, - configuration, - ) + Provider = new VersionControlManager(oni, sidebar, notifications) } const GetInstance = () => { diff --git a/browser/src/Services/VersionControl/VersionControlPane.tsx b/browser/src/Services/VersionControl/VersionControlPane.tsx index e8dd09952b..3dcddd2dc3 100644 --- a/browser/src/Services/VersionControl/VersionControlPane.tsx +++ b/browser/src/Services/VersionControl/VersionControlPane.tsx @@ -1,14 +1,13 @@ import * as capitalize from "lodash/capitalize" import * as Oni from "oni-api" import * as Log from "oni-core-logging" +import * as path from "path" import * as React from "react" import { Provider, Store } from "react-redux" import { SidebarManager } from "../Sidebar" import { VersionControlProvider, VersionControlView } from "./" -import { IWorkspace } from "./../Workspace" import { ISendVCSNotification } from "./VersionControlManager" -import { Commits } from "./VersionControlProvider" import { ProviderActions, VersionControlState } from "./VersionControlStore" export interface IDsMap { @@ -37,49 +36,24 @@ export default class VersionControlPane { } constructor( - private _editorManager: Oni.EditorManager, - private _workspace: IWorkspace, + private _oni: Oni.Plugin.Api, private _vcsProvider: VersionControlProvider, private _sendNotification: ISendVCSNotification, - private _commands: Oni.Commands.Api, private _sidebarManager: SidebarManager, private _store: Store, ) { this._registerCommands() - this._editorManager.activeEditor.onBufferSaved.subscribe(async () => { - if (this._isVisible()) { - await this.getStatus() - } - }) - - this._editorManager.activeEditor.onBufferEnter.subscribe(async () => { - if (this._isVisible()) { - await this.getStatus() - } - }) - - this._workspace.onDirectoryChanged.subscribe(async () => { - if (this._isVisible()) { - await this.getStatus() - } - }) - - this._vcsProvider.onBranchChanged.subscribe(async () => { - if (this._isVisible()) { - await this.getStatus() - } - }) - - this._vcsProvider.onStagedFilesChanged.subscribe(async () => { - if (this._isVisible()) { - await this.getStatus() - } - }) + this._oni.workspace.onDirectoryChanged.subscribe(this._refresh) + this._vcsProvider.onFileStatusChanged.subscribe(this._refresh) + this._vcsProvider.onBranchChanged.subscribe(this._getStatusIfVisible) + this._vcsProvider.onStagedFilesChanged.subscribe(this._getStatusIfVisible) + this._oni.editors.activeEditor.onBufferSaved.subscribe(this._getStatusIfVisible) + this._oni.editors.activeEditor.onBufferEnter.subscribe(this._getStatusIfVisible) this._vcsProvider.onPluginActivated.subscribe(async () => { this._store.dispatch({ type: "ACTIVATE" }) - await this.getStatus() + await this._refresh() }) this._vcsProvider.onPluginDeactivated.subscribe(() => { @@ -89,7 +63,7 @@ export default class VersionControlPane { public async enter() { this._store.dispatch({ type: "ENTER" }) - await this.getStatus() + await this._refresh() } public leave() { @@ -104,67 +78,75 @@ export default class VersionControlPane { return status } - public handleCommitResult = (summary: Commits) => { - return summary - ? this._store.dispatch({ type: "COMMIT_SUCCESS", payload: { commit: summary } }) - : this._store.dispatch({ type: "COMMIT_FAIL" }) - } - - public commitFile = async (messages: string[], files: string[]) => { + public commit = async (messages: string[], files?: string[]) => { let summary = null + const { status } = this._store.getState() + const filesToCommit = files || status.staged + this._dispatchLoading(true) try { - this._dispatchLoading(true) - summary = await this._vcsProvider.commitFiles(messages, files) + summary = await this._vcsProvider.commitFiles(messages, filesToCommit) + this._store.dispatch({ type: "COMMIT_SUCCESS", payload: { commit: summary } }) } catch (e) { this._sendNotification({ detail: e.message, level: "warn", title: `Error Commiting ${files[0]}`, }) + this._store.dispatch({ type: "COMMIT_FAIL" }) } finally { - this.handleCommitResult(summary) - await this.getStatus() + await this._refresh() this._dispatchLoading(false) } } - public commitFiles = async (messages: string[]) => { - const { - status: { staged }, - } = this._store.getState() - - let summary = null + public stageFile = async (file: string) => { try { - this._dispatchLoading(true) - summary = await this._vcsProvider.commitFiles(messages, staged) + await this._vcsProvider.stageFile(file) } catch (e) { this._sendNotification({ detail: e.message, level: "warn", - title: "Error Commiting Files", + title: "Error Staging File", expiration: 8_000, }) - } finally { - this.handleCommitResult(summary) - await this.getStatus() + } + } + + public getLogs = async () => { + this._dispatchLoading(true) + const logs = await this._vcsProvider.getLogs() + if (logs) { + this._store.dispatch({ type: "LOG", payload: { logs } }) this._dispatchLoading(false) + return logs } + return null } - public stageFile = async (file: string) => { - const { activeWorkspace } = this._workspace + public uncommitFile = async (sha: string) => { try { - await this._vcsProvider.stageFile(file, activeWorkspace) - } catch (e) { + await this._vcsProvider.uncommit() + await this._refresh() + } catch (error) { this._sendNotification({ - detail: e.message, + title: "Unable to revert last commit", + detail: error.message, level: "warn", - title: "Error Staging File", - expiration: 8_000, }) } } + public unstageFile = async () => { + const { + selected, + status: { staged }, + } = this._store.getState() + + if (!this._isReadonlyField(selected) && staged.includes(selected)) { + await this._vcsProvider.unstage([selected]) + } + } + public setError = async (e: Error) => { Log.warn(`version control pane failed to render due to ${e.message}`) this._store.dispatch({ type: "ERROR" }) @@ -175,16 +157,20 @@ export default class VersionControlPane { } public handleSelection = async (selected: string) => { - const { status } = this._store.getState() - const commitAll = selected === "commit_all" && !!status.staged.length + const { status, logs } = this._store.getState() switch (true) { case status.untracked.includes(selected): case status.modified.includes(selected): await this.stageFile(selected) break + case logs && logs.latest && logs.latest.hash === selected: + await this.uncommitFile(selected) + break case status.staged.includes(selected): - case commitAll: - this._store.dispatch({ type: "COMMIT_START" }) + this._store.dispatch({ type: "COMMIT_START", payload: { files: [selected] } }) + break + case selected === "commit_all" && !!status.staged.length: + this._store.dispatch({ type: "COMMIT_START", payload: { files: status.staged } }) break default: break @@ -196,10 +182,9 @@ export default class VersionControlPane { @@ -207,6 +192,16 @@ export default class VersionControlPane { ) } + private _refresh = async () => { + await Promise.all([this.getStatus(), this.getLogs()]) + } + + private _getStatusIfVisible = async () => { + if (this._isVisible()) { + await this._refresh() + } + } + private _dispatchLoading = (loading: boolean, type: ProviderActions = "commit") => { this._store.dispatch({ type: "LOADING", payload: { loading, type } }) } @@ -236,7 +231,7 @@ export default class VersionControlPane { } private _registerCommands() { - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: "vcs.commitAll", detail: "Commit all staged files", name: "Version Control: Commit all", @@ -244,12 +239,12 @@ export default class VersionControlPane { execute: async () => { const currentMessage = this._getCurrentCommitMessage() if (currentMessage.length) { - await this.commitFiles(currentMessage) + await this.commit(currentMessage) } }, }) - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: "vcs.openFile", detail: null, name: null, @@ -257,22 +252,29 @@ export default class VersionControlPane { execute: async () => { const { selected } = this._store.getState() if (!this._isReadonlyField(selected)) { - await this._editorManager.openFile(selected) + const filePath = path.join(this._oni.workspace.activeWorkspace, selected) + await this._oni.editors.openFile(filePath) } }, }) - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: "vcs.refresh", - detail: "Refresh Version Control pane", - name: "Version Control: Refresh pane", + detail: null, + name: null, enabled: this._hasFocus, - execute: async () => { - await this.getStatus() - }, + execute: this._refresh, + }) + + this._oni.commands.registerCommand({ + command: "vcs.unstage", + detail: null, + name: null, + enabled: () => this._hasFocus() && !this._isCommiting(), + execute: this.unstageFile, }) - this._commands.registerCommand({ + this._oni.commands.registerCommand({ command: "vcs.showHelp", detail: null, name: null, diff --git a/browser/src/Services/VersionControl/VersionControlProvider.ts b/browser/src/Services/VersionControl/VersionControlProvider.ts index 00fc876f86..609c63be29 100644 --- a/browser/src/Services/VersionControl/VersionControlProvider.ts +++ b/browser/src/Services/VersionControl/VersionControlProvider.ts @@ -4,6 +4,7 @@ import { BranchSummary, FetchResult } from "simple-git/promise" export enum Statuses { staged, committed, + modified, } export type FileStatusChangedEvent = Array<{ @@ -27,6 +28,27 @@ export interface StatusResult { remoteTrackingBranch: string } +export interface BlameArgs { + lineOne: number + lineTwo: number + file: string +} + +export interface Blame { + author: string + author_mail: string + author_time: string + author_tz: string + committer: string + committer_mail: string + committer_time: string + committer_tz: string + filename: string + hash: string + line: { originalLine: string; finalLine: string; numberOfLines: string } + summary: string +} + export interface VersionControlProvider { // Events onFileStatusChanged: IEvent @@ -42,11 +64,15 @@ export interface VersionControlProvider { canHandleWorkspace(dir?: string): Promise getStatus(): Promise getRoot(): Promise + getBlame(args: BlameArgs): Promise getDiff(): Promise getBranch(): Promise + getLogs(file?: string): Promise getLocalBranches(): Promise changeBranch(branch: string): Promise - stageFile(file: string, projectRoot?: string): Promise + stageFile(file: string): Promise + unstage(files: string[]): Promise + uncommit(sha?: string): Promise commitFiles(message: string[], files?: string[]): Promise fetchBranchFromRemote(args: { branch: string @@ -90,6 +116,21 @@ export interface Commits { } } +export interface DefaultLogFields { + hash: string + date: string + message: string + author_name: string + author_email: string +} + +export interface ListLogSummary { + all: ReadonlyArray + total: number + latest: T +} + +export type Logs = ListLogSummary export type Summary = StatusResult export type SupportedProviders = "git" | "svn" export default VersionControlProvider diff --git a/browser/src/Services/VersionControl/VersionControlStore.ts b/browser/src/Services/VersionControl/VersionControlStore.ts index c91f6ae7dd..5e50e4f869 100644 --- a/browser/src/Services/VersionControl/VersionControlStore.ts +++ b/browser/src/Services/VersionControl/VersionControlStore.ts @@ -1,11 +1,12 @@ import { createStore as createReduxStore } from "./../../Redux" -import { Commits, StatusResult } from "./VersionControlProvider" +import { Commits, Logs, StatusResult } from "./VersionControlProvider" export interface PrevCommits extends Commits { message: string } interface ICommit { + files: string[] active: boolean message: string[] previousCommits: PrevCommits[] @@ -19,6 +20,7 @@ export interface VersionControlState { type: ProviderActions } selected: string + logs: Logs status: StatusResult commit: ICommit hasFocus: boolean @@ -40,6 +42,11 @@ export const DefaultState: VersionControlState = { type: null, }, selected: null, + logs: { + all: [], + total: null, + latest: null, + }, status: { currentBranch: null, staged: [], @@ -53,6 +60,7 @@ export const DefaultState: VersionControlState = { behind: null, }, commit: { + files: [], message: [], active: false, previousCommits: [], @@ -74,7 +82,8 @@ type IEnterAction = IGenericAction<"ENTER"> type ILeaveAction = IGenericAction<"LEAVE"> type IErrorAction = IGenericAction<"ERROR"> type IStatusAction = IGenericAction<"STATUS", { status: StatusResult }> -type ICommitStartAction = IGenericAction<"COMMIT_START"> +type ILogAction = IGenericAction<"LOG", { logs: Logs }> +type ICommitStartAction = IGenericAction<"COMMIT_START", { files: string[] }> type ICommitCancelAction = IGenericAction<"COMMIT_CANCEL"> type ICommitSuccessAction = IGenericAction<"COMMIT_SUCCESS", { commit: Commits }> type ICommitFailAction = IGenericAction<"COMMIT_FAIL"> @@ -84,6 +93,7 @@ type IAction = | IToggleHelpAction | ISelectAction | IStatusAction + | ILogAction | IEnterAction | ILeaveAction | IErrorAction @@ -98,9 +108,14 @@ type IAction = export interface IVersionControlActions { cancelCommit: () => ICommitCancelAction updateCommitMessage: (message: string[]) => IUpdateCommitMessageAction + setLoading: (isLoading: boolean) => ILoadingAction } export const VersionControlActions: IVersionControlActions = { + setLoading: (isLoading: boolean, type = "commit") => ({ + type: "LOADING", + payload: { loading: isLoading, type }, + }), cancelCommit: () => ({ type: "COMMIT_CANCEL" }), updateCommitMessage: (message: string[]) => ({ type: "UPDATE_COMMIT_MESSAGE", @@ -123,16 +138,24 @@ export function reducer(state: VersionControlState, action: IAction) { case "SELECT": return { ...state, selected: action.payload.selected } case "COMMIT_START": - return { ...state, commit: { ...state.commit, active: true } } + return { + ...state, + commit: { ...state.commit, files: action.payload.files, active: true }, + } case "COMMIT_CANCEL": - return { ...state, commit: { ...state.commit, message: [], active: false } } + return { ...state, commit: { ...state.commit, message: [], active: false, files: [] } } case "COMMIT_SUCCESS": const { message: [message], } = state.commit return { ...state, + loading: { + active: false, + type: null, + }, commit: { + files: [], message: [] as string[], active: false, previousCommits: [ @@ -144,9 +167,14 @@ export function reducer(state: VersionControlState, action: IAction) { case "COMMIT_FAIL": return { ...state, + loading: { + active: false, + type: null, + }, commit: { ...state.commit, - message: [] as string[], + files: [], + message: [], active: false, }, } @@ -159,6 +187,11 @@ export function reducer(state: VersionControlState, action: IAction) { ...state, status: action.payload.status, } + case "LOG": + return { + ...state, + logs: action.payload.logs, + } case "DEACTIVATE": return { ...state, diff --git a/browser/src/Services/VersionControl/VersionControlView.tsx b/browser/src/Services/VersionControl/VersionControlView.tsx index d0f9715564..253bb821d8 100644 --- a/browser/src/Services/VersionControl/VersionControlView.tsx +++ b/browser/src/Services/VersionControl/VersionControlView.tsx @@ -2,14 +2,14 @@ import * as React from "react" import { connect } from "react-redux" import { styled } from "./../../UI/components/common" +import { SectionTitle, Title } from "./../../UI/components/SectionTitle" import CommitsSection from "./../../UI/components/VersionControl/Commits" import Help from "./../../UI/components/VersionControl/Help" -import { SectionTitle, Title } from "./../../UI/components/VersionControl/SectionTitle" import StagedSection from "./../../UI/components/VersionControl/Staged" import VersionControlStatus from "./../../UI/components/VersionControl/Status" import { VimNavigator } from "./../../UI/components/VimNavigator" import { IDsMap } from "./VersionControlPane" -import { StatusResult } from "./VersionControlProvider" +import { Logs, StatusResult } from "./VersionControlProvider" import { PrevCommits, ProviderActions, @@ -24,6 +24,7 @@ const StatusContainer = styled.div` interface IStateProps { loading: boolean + filesToCommit: string[] loadingSection: ProviderActions status: StatusResult hasFocus: boolean @@ -34,21 +35,22 @@ interface IStateProps { selectedItem: string commits: PrevCommits[] showHelp: boolean + logs: Logs } interface IDispatchProps { cancelCommit: () => void updateCommitMessage: (message: string[]) => void + setLoading: (loading: boolean) => void } interface IProps { IDs: IDsMap setError?: (e: Error) => void - getStatus?: () => Promise - commitOne?: (message: string[], files: string[]) => Promise - commitAll?: (message: string[]) => Promise + commit?: (message: string[], files?: string[]) => Promise updateSelection?: (selection: string) => void handleSelection?: (selection: string) => void + getStatus: () => void } type ConnectedProps = IProps & IStateProps & IDispatchProps @@ -100,12 +102,12 @@ export class VersionControlView extends React.Component { public handleCommitOne = async () => { const { message, selectedItem } = this.props - await this.props.commitOne(message, [selectedItem]) + await this.props.commit(message, [selectedItem]) } public handleCommitAll = async () => { const { message } = this.props - await this.props.commitAll(message) + await this.props.commit(message) } public handleCommitCancel = () => { @@ -123,9 +125,9 @@ export class VersionControlView extends React.Component { this.props.selectedItem === id public getIds = () => { - const { commits, status, IDs } = this.props + const { logs, status, IDs } = this.props const { modified, staged, untracked } = status - const commitSHAs = commits.map(({ commit }) => commit) + const commitSHAs = logs.all.slice(0, 1).map(({ hash }) => hash) const ids = [ IDs.commits, ...this.insertIf(this.state.commits, commitSHAs), @@ -146,21 +148,24 @@ export class VersionControlView extends React.Component { const warning = error || inactive const { IDs, - commits, + logs, showHelp, loading, committing, + filesToCommit, loadingSection, status: { modified, staged, untracked }, } = this.props + const commitInProgress = loading && loadingSection === "commit" + return warning ? ( {warning} ) : ( <> - + {!showHelp ? To show help press "?" : } { this.toggleVisibility(IDs.commits)} /> { icon="plus-circle" files={staged} selectedId={selectedId} - committing={committing} + filesToCommit={filesToCommit} selectedToCommit={this.isSelected} visible={this.state.staged} - loading={loading && loadingSection === "commit"} + loading={commitInProgress} handleSelection={this.props.handleSelection} toggleVisibility={() => this.toggleVisibility(IDs.staged)} handleCommitOne={this.handleCommitOne} @@ -227,9 +232,11 @@ const mapStateToProps = (state: VersionControlState): IStateProps => ({ message: state.commit.message, selectedItem: state.selected, commits: state.commit.previousCommits, + filesToCommit: state.commit.files, showHelp: state.help.active, loading: state.loading.active, loadingSection: state.loading.type, + logs: state.logs, }) const ConnectedGitComponent = connect( diff --git a/browser/src/Services/Workspace/Workspace.ts b/browser/src/Services/Workspace/Workspace.ts index c87764520f..5dccad3b32 100644 --- a/browser/src/Services/Workspace/Workspace.ts +++ b/browser/src/Services/Workspace/Workspace.ts @@ -32,12 +32,7 @@ import { WorkspaceConfiguration } from "./WorkspaceConfiguration" const fsStat = promisify(stat) -// Candidate interface to promote to Oni API -export interface IWorkspace extends Oni.Workspace.Api { - applyEdits(edits: types.WorkspaceEdit): Promise -} - -export class Workspace implements IWorkspace { +export class Workspace implements Oni.Workspace.Api { private _onDirectoryChangedEvent = new Event() private _onFocusGainedEvent = new Event() private _onFocusLostEvent = new Event() diff --git a/browser/src/Services/Workspace/WorkspaceConfiguration.ts b/browser/src/Services/Workspace/WorkspaceConfiguration.ts index 1a834dc63a..2c6d045612 100644 --- a/browser/src/Services/Workspace/WorkspaceConfiguration.ts +++ b/browser/src/Services/Workspace/WorkspaceConfiguration.ts @@ -5,12 +5,12 @@ */ import * as fs from "fs" +import * as Oni from "oni-api" import * as path from "path" import * as Log from "oni-core-logging" import { Configuration } from "./../Configuration" -import { IWorkspace } from "./Workspace" export const getWorkspaceConfigurationPath = (workspacePath: string): string => { return path.join(workspacePath, ".oni", "config.js") @@ -25,7 +25,7 @@ export class WorkspaceConfiguration { constructor( private _configuration: Configuration, - private _workspace: IWorkspace, + private _workspace: Oni.Workspace.Api, private _fs: typeof fs = fs, ) { this._checkWorkspaceConfiguration() diff --git a/browser/src/UI/components/BufferScrollBar.tsx b/browser/src/UI/components/BufferScrollBar.tsx index da3a4639cc..9c20dcadd9 100644 --- a/browser/src/UI/components/BufferScrollBar.tsx +++ b/browser/src/UI/components/BufferScrollBar.tsx @@ -2,10 +2,9 @@ import * as React from "react" import * as uniqBy from "lodash/uniqBy" import styled from "styled-components" -import { bufferScrollBarSize } from "./common" +import { bufferScrollBarSize, pixel, withProps } from "./common" import { editorManager } from "./../../Services/EditorManager" -import { EmptyArray } from "./../../Utility" export interface IBufferScrollBarProps { windowId: number @@ -27,8 +26,12 @@ export interface IScrollBarMarker { color: string } -const ScrollBarContainer = styled.div` - position: absolute; +const ScrollBarContainer = withProps>(styled.div).attrs({ + style: ({ height }: Partial) => ({ + height: pixel(height), + }), +})` + position: fixed; top: 0px; bottom: 0px; right: 0px; @@ -37,8 +40,17 @@ const ScrollBarContainer = styled.div` border-bottom: 1px solid black; pointer-events: auto; ` +interface IScrollBarWindow { + height: number + top: number +} -const ScrollBarWindow = styled.div` +const ScrollBarWindow = withProps(styled.div).attrs({ + style: ({ top, height }: IScrollBarWindow) => ({ + top: pixel(top), + height: pixel(height), + }), +})` position: absolute; width: ${bufferScrollBarSize}; background-color: rgba(200, 200, 200, 0.2); @@ -46,17 +58,34 @@ const ScrollBarWindow = styled.div` border-bottom: 1px solid rgba(255, 255, 255, 0.1); pointer-events: none; ` +interface IMarkerElement { + height: string + top: number + color: string +} + +export const MarkerElement = withProps(styled.div).attrs({ + style: ({ height, top }: IMarkerElement) => ({ + top: pixel(top), + height, + }), +})` + background-color: ${p => p.color}; + width: 100%; + position: absolute; + pointer-events: none; +` export class BufferScrollBar extends React.PureComponent< IBufferScrollBarProps, IBufferScrollBarState > { - public state = { - scrollBarTop: 0, + public static defaultProps: Partial = { + markers: [], } - constructor(props: any) { - super(props) + public state: IBufferScrollBarState = { + scrollBarTop: 0, } public setLine = (y: number) => { @@ -89,45 +118,48 @@ export class BufferScrollBar extends React.PureComponent< document.removeEventListener("mouseup", this.endScroll, true) } - public render(): JSX.Element { - if (!this.props.visible) { - return null - } - - const windowHeight = - (this.props.windowBottomLine - this.props.windowTopLine + 1) / - this.props.bufferSize * - this.props.height - const windowTop = (this.props.windowTopLine - 1) / this.props.bufferSize * this.props.height - - const windowStyle: React.CSSProperties = { - top: windowTop + "px", - height: windowHeight + "px", - } - - const markers = this.props.markers || EmptyArray + public calculateWindowDimensions() { + const { windowBottomLine, windowTopLine, bufferSize, height } = this.props + const windowHeight = (windowBottomLine - windowTopLine + 1) / bufferSize * height + const windowTop = (windowTopLine - 1) / bufferSize * height + return { windowHeight, windowTop } + } - const uniqueMarkers = uniqBy(markers, m => m.id) - const markerElements = uniqueMarkers.map(m => { - const line = m.line + public renderMarkers() { + // Only show one marker per line in the scroll bar + const uniqueMarkers = uniqBy(this.props.markers, ({ line }) => line) + const markerElements = uniqueMarkers.map(({ line, color }) => { const pos = line / this.props.bufferSize * this.props.height const size = "2px" - const markerStyle: React.CSSProperties = { - position: "absolute", - top: pos + "px", - height: size, - backgroundColor: m.color, - width: "100%", - pointerEvents: "none", - } - - return
+ return ( + + ) }) + return markerElements + } + + public render() { + if (!this.props.visible) { + return null + } + + const markerElements = this.renderMarkers() + const { windowHeight, windowTop } = this.calculateWindowDimensions() return ( - - + + {markerElements} ) diff --git a/browser/src/UI/components/Error.tsx b/browser/src/UI/components/Error.tsx index 1ca2e19ee3..7e95a50ce4 100644 --- a/browser/src/UI/components/Error.tsx +++ b/browser/src/UI/components/Error.tsx @@ -32,9 +32,9 @@ export const Errors = (props: IErrorsProps) => { return null } - const markers = errors.map(e => { + const markers = errors.map((error, idx) => { const screenSpaceStart = props.bufferToScreen( - types.Position.create(e.range.start.line, e.range.start.character), + types.Position.create(error.range.start.line, error.range.start.character), ) if (!screenSpaceStart) { return null @@ -46,42 +46,52 @@ export const Errors = (props: IErrorsProps) => { const pixelPosition = props.screenToPixel({ screenX: 0, screenY }) const pixelY = pixelPosition.pixelY - padding / 2 - return - }) - - const squiggles = errors.filter(e => e && e.range && e.range.start && e.range.end).map(e => { - const lineNumber = e.range.start.line - const column = e.range.start.character - const endColumn = e.range.end.character - - const startPosition = props.bufferToScreen(types.Position.create(lineNumber, column)) - - if (!startPosition) { - return null - } - - const endPosition = props.bufferToScreen(types.Position.create(lineNumber, endColumn)) - - if (!endPosition) { - return null - } - - const pixelStart = props.screenToPixel(startPosition) - const pixelEnd = props.screenToPixel(endPosition) - const pixelWidth = pixelEnd.pixelX - pixelStart.pixelX - const normalizedPixelWidth = pixelWidth === 0 ? props.fontWidthInPixels : pixelWidth - return ( - ) }) + const squiggles = errors + .filter(e => e && e.range && e.range.start && e.range.end) + .map((error, idx) => { + const lineNumber = error.range.start.line + const column = error.range.start.character + const endColumn = error.range.end.character + + const startPosition = props.bufferToScreen(types.Position.create(lineNumber, column)) + + if (!startPosition) { + return null + } + + const endPosition = props.bufferToScreen(types.Position.create(lineNumber, endColumn)) + + if (!endPosition) { + return null + } + + const pixelStart = props.screenToPixel(startPosition) + const pixelEnd = props.screenToPixel(endPosition) + const pixelWidth = pixelEnd.pixelX - pixelStart.pixelX + const normalizedPixelWidth = pixelWidth === 0 ? props.fontWidthInPixels : pixelWidth + + return ( + + ) + }) + return (
{markers} @@ -97,7 +107,7 @@ interface IErrorMarkerProps { } const ErrorMarker = (props: IErrorMarkerProps) => ( - + ) diff --git a/browser/src/UI/components/LightweightText.tsx b/browser/src/UI/components/LightweightText.tsx index 16bae99731..851ce6a13e 100644 --- a/browser/src/UI/components/LightweightText.tsx +++ b/browser/src/UI/components/LightweightText.tsx @@ -32,6 +32,10 @@ const WordRegex = /[$_a-zA-Z0-9]/i * common functionality (like focus management, key handling) */ export class TextInputView extends React.PureComponent { + public static defaultProps = { + InputComponent: Input, + } + private _element: HTMLInputElement public componentDidMount(): void { @@ -48,7 +52,7 @@ export class TextInputView extends React.PureComponent } const defaultValue = this.props.defaultValue || "" - const { InputComponent = Input } = this.props + const { InputComponent } = this.props return (
diff --git a/browser/src/UI/components/VersionControl/SectionTitle.tsx b/browser/src/UI/components/SectionTitle.tsx similarity index 79% rename from browser/src/UI/components/VersionControl/SectionTitle.tsx rename to browser/src/UI/components/SectionTitle.tsx index 9475270d85..94f0ae057a 100644 --- a/browser/src/UI/components/VersionControl/SectionTitle.tsx +++ b/browser/src/UI/components/SectionTitle.tsx @@ -1,7 +1,7 @@ import * as React from "react" -import Caret from "./../Caret" -import { sidebarItemSelected, styled, withProps } from "./../common" +import Caret from "./Caret" +import { sidebarItemSelected, styled, withProps } from "./common" export const Title = styled.h4` margin: 0; @@ -25,7 +25,7 @@ interface IProps { testId: string } -const VCSSectionTitle: React.SFC = props => ( +const SidebarSectionTitle: React.SFC = props => ( {props.title.toUpperCase()} @@ -33,4 +33,4 @@ const VCSSectionTitle: React.SFC = props => ( ) -export default VCSSectionTitle +export default SidebarSectionTitle diff --git a/browser/src/UI/components/SidebarItemView.tsx b/browser/src/UI/components/SidebarItemView.tsx index cd1529f8db..28e80a03d6 100644 --- a/browser/src/UI/components/SidebarItemView.tsx +++ b/browser/src/UI/components/SidebarItemView.tsx @@ -42,7 +42,7 @@ const SidebarItemStyleWrapper = withProps(styled.div)` justify-content: center; align-items: center; padding-top: 4px; - padding-bottom: 4px; + padding-bottom: 3px; position: relative; cursor: pointer; @@ -52,7 +52,7 @@ const SidebarItemStyleWrapper = withProps(styled.div)` flex: 0 0 auto; width: 20px; text-align: center; - margin-right: 7px; + margin-right: 1px; } .name { @@ -82,7 +82,7 @@ const SidebarItemBackground = withProps(styled.div)` bottom: 0px; ` -const INDENT_AMOUNT = 6 +const INDENT_AMOUNT = 12 export class SidebarItemView extends React.PureComponent { public render(): JSX.Element { diff --git a/browser/src/UI/components/VersionControl/Commits.tsx b/browser/src/UI/components/VersionControl/Commits.tsx index d62bc57bd9..153da57963 100644 --- a/browser/src/UI/components/VersionControl/Commits.tsx +++ b/browser/src/UI/components/VersionControl/Commits.tsx @@ -1,11 +1,12 @@ import * as React from "react" -import { PrevCommits } from "./../../../Services/VersionControl/VersionControlStore" +import { Logs } from "../../../Services/VersionControl/VersionControlProvider" import { sidebarItemSelected, styled, withProps } from "./../../../UI/components/common" -import VCSSectionTitle from "./SectionTitle" +import { formatDate } from "./../../../Utility" +import VCSSectionTitle from "./../SectionTitle" interface ICommitsSection { - commits: PrevCommits[] + commits: Logs["all"] selectedId: string titleId: string visibility: boolean @@ -17,6 +18,9 @@ const List = styled.ul` list-style: none; margin: 0; padding: 0; + overflow-y: auto; + overflow-x: hidden; + max-height: 30em; ` export const ListItem = withProps<{ isSelected?: boolean }>(styled.li)` ${({ isSelected }) => isSelected && sidebarItemSelected}; @@ -27,9 +31,15 @@ const Detail = styled.p` margin: 0.4rem 0; ` +const Container = styled.div` + width: 100%; + max-height: 20em; + overflow: hidden; +` + const CommitsSection: React.SFC = ({ commits, ...props }) => { return ( -
+ = ({ commits, ...props }) => { {commits.map(prevCommit => ( props.onClick(prevCommit.commit)} - isSelected={props.selectedId === prevCommit.commit} + key={prevCommit.hash} + onClick={() => props.onClick(prevCommit.hash)} + isSelected={props.selectedId === prevCommit.hash} > {prevCommit.message} - {prevCommit.commit} - Deletions: {prevCommit.summary.deletions} - Insertions: {prevCommit.summary.insertions} + {prevCommit.hash.slice(0, 6)} + {formatDate(prevCommit.date)} + {prevCommit.author_email} + {prevCommit.author_name} ))} ) : null} -
+ ) } diff --git a/browser/src/UI/components/VersionControl/Help.tsx b/browser/src/UI/components/VersionControl/Help.tsx index ecf0fa7c44..8ce2874a48 100644 --- a/browser/src/UI/components/VersionControl/Help.tsx +++ b/browser/src/UI/components/VersionControl/Help.tsx @@ -1,33 +1,58 @@ import * as React from "react" -import { SectionTitle, Title } from "./SectionTitle" - -// TODO: Get this from command API -const commands = [ - { - key: "ctrl-r", - explanation: "Refresh the VCS Pane", - }, - { - key: "e", - explanation: "Open the selected file", - }, +import { inputManager } from "../../../Services/InputManager" +import styled from "../common" +import { SectionTitle, Title } from "./../SectionTitle" + +const sidebarCommands = [ + { command: "vcs.openFile", description: "Open the currently selected file" }, + { command: "vcs.unstage", description: "Unstage the currently selected file" }, + { command: "vcs.commitAll", description: "Commit all staged files" }, + { command: "vcs.refresh", description: "Manually refresh vcs pane" }, + { command: "vcs.sidebar.toggle", description: "Toggle vcs pane" }, ] +const getBoundKeys = (commands = sidebarCommands) => { + return commands.map(({ command, ...rest }) => ({ + key: inputManager.getBoundKeys(command)[0] || "Unbound", + ...rest, + })) +} + +const HelpContainer = styled.div`` + +const CommandExplainer = styled.div` + padding: 0 0.5em; +` + +export const Description = styled.p` + margin: 0.5em 0; +` + +const Command = styled.span` + color: ${p => p.theme["highlight.mode.insert.foreground"]}; + background-color: ${p => p.theme["highlight.mode.insert.background"]}; +` + +const wrapInBrackets = (str: string) => { + return str.startsWith("<") && str.endsWith(">") ? str : `<${str}>` +} -const Help: React.SFC<{ showHelp: boolean }> = ({ showHelp }) => - showHelp && ( -
+const Help: React.SFC<{}> = props => { + const commands = getBoundKeys() + return ( + Help? {commands.map(command => ( -
-

- {command.key} - {command.explanation} -

-
+ + + {command.description} - {wrapInBrackets(command.key)} + + ))} -
+ ) +} export default Help diff --git a/browser/src/UI/components/VersionControl/Staged.tsx b/browser/src/UI/components/VersionControl/Staged.tsx index e140eb9213..40aa90e96b 100644 --- a/browser/src/UI/components/VersionControl/Staged.tsx +++ b/browser/src/UI/components/VersionControl/Staged.tsx @@ -1,10 +1,10 @@ import * as React from "react" import styled, { Center, sidebarItemSelected, withProps } from "../common" +import SectionTitle from "../SectionTitle" import { LoadingSpinner } from "./../../../UI/components/LoadingSpinner" import CommitMessage from "./CommitMessage" import File from "./File" -import SectionTitle from "./SectionTitle" const Explainer = styled.div` width: 100%; @@ -21,7 +21,7 @@ interface IProps { icon: string loading: boolean handleSelection: (id: string) => void - committing?: boolean + filesToCommit: string[] toggleVisibility: () => void handleCommitMessage: (evt: React.ChangeEvent) => void handleCommitOne: () => void @@ -81,8 +81,9 @@ const StagedSection: React.SFC = props => { {props.visible && props.files.map(file => { const isSelected = file === props.selectedId + const isLoading = props.filesToCommit.includes(file) && props.loading return ( - + {props.selectedToCommit(file) ? ( void onSelected?: (selectedId: string) => void - render: (selectedId: string) => JSX.Element + render: (selectedId: string, updateSelection: (id: string) => void) => JSX.Element style?: React.CSSProperties + idToSelect?: string } export interface IVimNavigatorState { @@ -65,6 +66,10 @@ export class VimNavigator extends React.PureComponent { + this.setState({ selectedId: id }) + } + public render() { const inputElement = (
@@ -84,7 +89,9 @@ export class VimNavigator extends React.PureComponent -
{this.props.render(this.state.selectedId)}
+
+ {this.props.render(this.state.selectedId, this.updateSelection)} +
{this.props.active ? inputElement : null}
) @@ -127,16 +134,7 @@ export class VimNavigator extends React.PureComponent { 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 +144,19 @@ export class VimNavigator extends React.PureComponent {({ height, width }) => { - // return
{width}{height}
const items = layoutFromSplitInfo(this.props.split, width, height) const vals: JSX.Element[] = Object.values(items).map(item => { const style = rectangleToStyleProperties(item.rectangle, height) return ( -
+
-export type Css = styledComponents.InterpolationValue[] | styledComponents.Styles[] +export type Css = + | styledComponents.InterpolationValue[] + | Array>> type FlexDirection = "flex-start" | "flex-end" | "center" | "space-between" @@ -77,9 +79,21 @@ export const StackLayer = styled<{ zIndex?: number | string }, "div">("div")` ${p => p.zIndex && `z-index: ${p.zIndex}`}; ` +type GetBorder = ( + args: { + isSelected?: boolean + borderSize?: string + theme?: styledComponents.ThemeProps + }, +) => string + +export const getSelectedBorder: GetBorder = ({ isSelected, borderSize = "1px", theme }) => + isSelected + ? `${borderSize} solid ${theme["highlight.mode.normal.background"]}` + : `${borderSize} solid transparent` + export const sidebarItemSelected = css` - border: ${(p: any) => - p.isSelected && `1px solid ${p.theme["highlight.mode.normal.background"]}`}; + border: ${getSelectedBorder}; ` export type StyledFunction = styledComponents.ThemedStyledFunction @@ -129,6 +143,12 @@ const tint = (base: string, mix: string, degree: number = 0.1) => const fontSizeSmall = `font-size: 0.9em;` +export const textOverflow = css` + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +` + const fallBackFonts = ` Consolas, Menlo, diff --git a/browser/src/Utility.ts b/browser/src/Utility.ts index 9a6ba0db62..07841a4817 100644 --- a/browser/src/Utility.ts +++ b/browser/src/Utility.ts @@ -258,3 +258,45 @@ export function ignoreWhilePendingPromise( export const parseJson5 = (text: string): T => { return JSON5.parse(text) as T } + +export const formatDate = (dateStr: string) => { + const options: Intl.DateTimeFormatOptions = { + weekday: "long", + year: "numeric", + month: "long", + day: "numeric", + hour: "numeric", + minute: "numeric", + } + const date = new Date(dateStr) + return date.toLocaleDateString("en-US", options) +} + +// Courtesy of https://stackoverflow.com/questions/3177836 +// /how-to-format-time-since-xxx-e-g-4-minutes-ago-similar-to-stack-exchange-site +export const getTimeSince = (date: Date) => { + const currentDate = Date.now() + const seconds = Math.floor((currentDate - date.getTime()) / 1000) + let interval = Math.floor(seconds / 31536000) + + if (interval > 1) { + return interval + " years" + } + interval = Math.floor(seconds / 2592000) + if (interval > 1) { + return interval + " months" + } + interval = Math.floor(seconds / 86400) + if (interval > 1) { + return interval + " days" + } + interval = Math.floor(seconds / 3600) + if (interval > 1) { + return interval + " hours" + } + interval = Math.floor(seconds / 60) + if (interval > 1) { + return interval + " minutes" + } + return Math.floor(seconds) + " seconds" +} diff --git a/browser/src/neovim/NeovimInstance.ts b/browser/src/neovim/NeovimInstance.ts index 6f4c9dbaf6..208ce294f5 100644 --- a/browser/src/neovim/NeovimInstance.ts +++ b/browser/src/neovim/NeovimInstance.ts @@ -560,6 +560,15 @@ export class NeovimInstance extends EventEmitter implements INeovimInstance { return this.command(`e! ${fileName}`) } + /** + * closeAllBuffers + * + * silently close all open buffers + */ + public async closeAllBuffers() { + await this.command(`silent! %bdelete`) + } + /** * getInitVimPath * return the init vim path with no check to ensure existence diff --git a/browser/src/neovim/NeovimWindowManager.ts b/browser/src/neovim/NeovimWindowManager.ts index 59294eacc5..c9e7d05d27 100644 --- a/browser/src/neovim/NeovimWindowManager.ts +++ b/browser/src/neovim/NeovimWindowManager.ts @@ -23,6 +23,10 @@ import { NeovimInstance } from "./index" import * as Utility from "./../Utility" +interface NeovimWindow { + id: number +} + export interface NeovimTabPageState { tabId: number activeWindow: NeovimActiveWindowState @@ -88,7 +92,6 @@ export class NeovimWindowManager extends Utility.Disposable { this.trackDisposable(this._neovimInstance.onScroll.subscribe(updateScroll)) const shouldMeasure$: Observable = this._scrollObservable - .auditTime(25) .map((evt: EventContext) => ({ version: evt.version, bufferTotalLines: evt.bufferTotalLines, @@ -102,10 +105,9 @@ export class NeovimWindowManager extends Utility.Disposable { shouldMeasure$ .withLatestFrom(this._scrollObservable) - .switchMap((args: [any, EventContext]) => { - const [, evt] = args - return Observable.defer(() => this._remeasure(evt)) - }) + .switchMap(([, evt]: [any, EventContext]) => + Observable.defer(() => this._remeasure(evt)), + ) .subscribe((tabState: NeovimTabPageState) => { if (tabState) { this._onWindowStateChangedEvent.dispatch(tabState) @@ -124,9 +126,10 @@ export class NeovimWindowManager extends Utility.Disposable { private async _remeasure(context: EventContext): Promise { const tabNumber = context.tabNumber - const allWindows = await this._neovimInstance.request("nvim_tabpage_list_wins", [ - tabNumber, - ]) + const allWindows = await this._neovimInstance.request( + "nvim_tabpage_list_wins", + [tabNumber], + ) const activeWindow = await this._remeasureActiveWindow(context.windowNumber, context) @@ -136,11 +139,9 @@ export class NeovimWindowManager extends Utility.Disposable { const inactiveWindowIds = allWindows.filter(w => w.id !== context.windowNumber) - const windowPromise = await inactiveWindowIds.map(async (window: any) => { - return this._remeasureInactiveWindow(window.id) - }) - - const inactiveWindows = await Promise.all(windowPromise) + const inactiveWindows = await Promise.all( + inactiveWindowIds.map(window => this._remeasureInactiveWindow(window.id)), + ) return { tabId: tabNumber, diff --git a/browser/test/Editor/NeovimEditor/BufferManagerTest.ts b/browser/test/Editor/NeovimEditor/BufferManagerTest.ts deleted file mode 100644 index cf2e72684e..0000000000 --- a/browser/test/Editor/NeovimEditor/BufferManagerTest.ts +++ /dev/null @@ -1,80 +0,0 @@ -import * as assert from "assert" - -import { BufferManager, InactiveBuffer } from "./../../../src/Editor/BufferManager" - -describe("Buffer Manager Tests", () => { - const neovim = {} as any - const actions = {} as any - const store = {} as any - const manager = new BufferManager(neovim, actions, store) - const event = { - bufferFullPath: "/test/file", - bufferTotalLines: 2, - bufferNumber: 1, - modified: false, - hidden: false, - listed: true, - version: 1, - line: 0, - column: 0, - byte: 8, - filetype: "js", - tabNumber: 1, - windowNumber: 1, - wincol: 10, - winline: 25, - windowTopLine: 0, - windowBottomLine: 200, - windowWidth: 100, - windowHeight: 100, - tabstop: 8, - shiftwidth: 2, - comments: "://,ex:*/", - } - - const inactive1 = { - bufferNumber: 2, - bufferFullPath: "/test/two", - filetype: "js", - buftype: "", - modified: false, - hidden: false, - listed: true, - version: 1, - } - - it("Should correctly set buffer variables", () => { - manager.updateBufferFromEvent(event) - const buffer = manager.getBufferById("1") - assert(buffer.tabstop === 8, "tabstop is set correctly") - assert(buffer.shiftwidth === 2, "shiftwidth is set correctly") - assert(buffer.comment.defaults.includes("//"), "comments are set correctly") - assert(buffer.comment.end.includes("*/"), "comments are set correctly") - }) - - it("Should correctly populate the buffer list", () => { - manager.updateBufferFromEvent(event) - manager.populateBufferList({ - current: event, - existingBuffers: [inactive1], - }) - - const buffers = manager.getBuffers() - assert(buffers.length === 2, "Two buffers were added") - assert( - buffers.find(buffer => buffer instanceof InactiveBuffer), - "One of the buffers is an inactive buffer", - ) - }) - - it("Should correctly format a comment string (based on neovim &comment option)", () => { - manager.updateBufferFromEvent(event) - const buffer = manager.getBufferById("1") - const comment = "s1:/*,ex:*/,://,b:#,:%" - const formatted = buffer.formatCommentOption(comment) - assert(formatted.start.includes("/*"), "Correctly parses a comment string") - assert(formatted.end.includes("*/"), "Correctly parses a comment string") - assert(formatted.defaults.includes("//"), "Correctly parses a comment string") - assert(formatted.defaults.includes("#"), "Correctly parses a comment string") - }) -}) diff --git a/browser/test/Mocks/MockPersistentStore.ts b/browser/test/Mocks/MockPersistentStore.ts index e94c68c2c0..4e60bd3cbf 100644 --- a/browser/test/Mocks/MockPersistentStore.ts +++ b/browser/test/Mocks/MockPersistentStore.ts @@ -18,4 +18,13 @@ export class MockPersistentStore implements IPersistentStore { public async get(): Promise { return this._state } + + public async delete(key: string): Promise { + this._state[key] = undefined + return this._state + } + + public has(key: string) { + return !!this._state[key] + } } diff --git a/browser/test/Mocks/index.ts b/browser/test/Mocks/index.ts index 1e9d656d2e..e5f879778f 100644 --- a/browser/test/Mocks/index.ts +++ b/browser/test/Mocks/index.ts @@ -8,7 +8,7 @@ export * from "./MockBuffer" export * from "./neovim/MockNeovimInstance" export * from "./MockPersistentStore" -export * from "./MockPluginManager" +import { MockPluginManager } from "./MockPluginManager" export * from "./MockThemeLoader" import * as Oni from "oni-api" @@ -18,11 +18,11 @@ import * as types from "vscode-languageserver-types" import { Editor } from "./../../src/Editor/Editor" +import { EditorManager } from "./../../src/Services/EditorManager" import * as Language from "./../../src/Services/Language" import { createCompletablePromise, ICompletablePromise } from "./../../src/Utility" import { TokenColor } from "./../../src/Services/TokenColors" -import { IWorkspace } from "./../../src/Services/Workspace" export class MockWindowSplit { public get id(): string { @@ -50,7 +50,7 @@ export class MockTokenColors { import { MockBuffer } from "./MockBuffer" -export class MockConfiguration { +export class MockConfiguration implements Oni.Configuration { private _currentConfigurationFiles: string[] = [] private _onConfigurationChanged = new Event() @@ -72,6 +72,10 @@ export class MockConfiguration { this._configurationValues[key] = value } + public setValues(): void { + throw Error("Not yet implemented") + } + public addConfigurationFile(filePath: string): void { this._currentConfigurationFiles = [...this._currentConfigurationFiles, filePath] } @@ -87,7 +91,7 @@ export class MockConfiguration { } } -export class MockWorkspace implements IWorkspace { +export class MockWorkspace implements Oni.Workspace.Api { private _activeWorkspace: string = null private _onDirectoryChangedEvent = new Event() private _onFocusGainedEvent = new Event() @@ -153,6 +157,10 @@ export class MockEditor extends Editor { private _activeBuffer: MockBuffer = null private _currentSelection: types.Range = null + public init(filesToOpen: string[]): void { + throw new Error("Not implemented") + } + public get activeBuffer(): Oni.Buffer { return this._activeBuffer as any } @@ -173,6 +181,10 @@ export class MockEditor extends Editor { this.notifyBufferEnter(buffer as any) } + public render(): JSX.Element { + throw new Error("Not implemented") + } + public async setSelection(range: types.Range): Promise { this._currentSelection = range } @@ -257,3 +269,114 @@ export class MockHoverRequestor extends MockRequestor return this.get(language, filePath, line, column) } } + +export class MockOni implements Oni.Plugin.Api { + private _editorManager = new EditorManager() + private _pluginManager = new MockPluginManager() + private _statusBar = new MockStatusBar() + private _workspace = new MockWorkspace() + + constructor(private _configuration: Oni.Configuration = new MockConfiguration()) { + this._editorManager.setActiveEditor(new MockEditor()) + } + + get automation(): Oni.Automation.Api { + throw Error("Not yet implemented") + } + + get colors(): Oni.IColors { + throw Error("Not yet implemented") + } + + get commands(): Oni.Commands.Api { + throw Error("Not yet implemented") + } + + get configuration(): Oni.Configuration { + return this._configuration + } + + get contextMenu(): any /* TODO */ { + throw Error("Not yet implemented") + } + + get diagnostics(): Oni.Plugin.Diagnostics.Api { + throw Error("Not yet implemented") + } + + get editors(): Oni.EditorManager { + return this._editorManager + } + + get filter(): Oni.Menu.IMenuFilters { + throw Error("Not yet implemented") + } + + get input(): Oni.Input.InputManager { + throw Error("Not yet implemented") + } + + get language(): any /* TODO */ { + throw Error("Not yet implemented") + } + + get log(): any /* TODO */ { + throw Error("Not yet implemented") + } + + get notifications(): Oni.Notifications.Api { + throw Error("Not yet implemented") + } + + get overlays(): Oni.Overlays.Api { + throw Error("Not yet implemented") + } + + get plugins(): Oni.IPluginManager { + return this._pluginManager + } + + get search(): Oni.Search.ISearch { + throw Error("Not yet implemented") + } + + get sidebar(): Oni.Sidebar.Api { + throw Error("Not yet implemented") + } + + get ui(): Oni.Ui.IUi { + throw Error("Not yet implemented") + } + + get menu(): Oni.Menu.Api { + throw Error("Not yet implemented") + } + + get process(): Oni.Process { + throw Error("Not yet implemented") + } + + get recorder(): Oni.Recorder { + throw Error("Not yet implemented") + } + + get snippets(): Oni.Snippets.SnippetManager { + throw Error("Not yet implemented") + } + + get statusBar(): Oni.StatusBar { + return this._statusBar + } + + get windows(): Oni.IWindowManager { + throw Error("Not yet implemented") + } + + get workspace(): Oni.Workspace.Api { + return this._workspace + } + + public populateQuickFix(entries: Oni.QuickFixEntry[]): void { + throw Error("Not yet implemented") + } +} diff --git a/browser/test/Services/Explorer/ExplorerFileSystemTests.ts b/browser/test/Services/Explorer/ExplorerFileSystemTests.ts index a9875d01e6..89516f8230 100644 --- a/browser/test/Services/Explorer/ExplorerFileSystemTests.ts +++ b/browser/test/Services/Explorer/ExplorerFileSystemTests.ts @@ -136,6 +136,9 @@ describe("readdir", () => { exists(targetPath: string, callback: any) { assert.fail("Should not be used") }, + realpath(targetPath: string) { + assert.fail("Should not be used") + }, } as any) const expected = [ diff --git a/browser/test/Services/Explorer/ExplorerStoreTests.ts b/browser/test/Services/Explorer/ExplorerStoreTests.ts index f58d0a1ded..f6ed842916 100644 --- a/browser/test/Services/Explorer/ExplorerStoreTests.ts +++ b/browser/test/Services/Explorer/ExplorerStoreTests.ts @@ -8,16 +8,27 @@ import * as path from "path" import { Store } from "redux" import configureMockStore, { MockStoreCreator } from "redux-mock-store" import { ActionsObservable, combineEpics, createEpicMiddleware } from "redux-observable" +import * as sinon from "sinon" import * as ExplorerFileSystem from "./../../../src/Services/Explorer/ExplorerFileSystem" import { ExplorerNode } from "./../../../src/Services/Explorer/ExplorerSelectors" import * as ExplorerState from "./../../../src/Services/Explorer/ExplorerStore" +import { Notification } from "./../../../src/Services/Notifications/Notification" import { Notifications } from "./../../../src/Services/Notifications/Notifications" import * as clone from "lodash/clone" import * as head from "lodash/head" import * as TestHelpers from "./../../TestHelpers" +const MemoryFileSystem = require("memory-fs") // tslint:disable-line +// Monkey patch realpath since it doesn't exist in memory-fs. +MemoryFileSystem.prototype.realpath = ( + fullPath: string, + callback: (err: any, fullPath: string) => void, +) => { + callback(null, fullPath) +} + export class MockedFileSystem implements ExplorerFileSystem.IFileSystem { public promises: Array> @@ -37,6 +48,12 @@ export class MockedFileSystem implements ExplorerFileSystem.IFileSystem { return promise } + public realpath(fullPath: string): Promise { + const promise = this._inner.realpath(fullPath) + this.promises.push(promise) + return promise + } + public async canPersistNode() { return true } @@ -52,29 +69,36 @@ export class MockedFileSystem implements ExplorerFileSystem.IFileSystem { // tslint:enable } -const rootEpic = combineEpics(ExplorerState.clearYankRegisterEpic, ExplorerState.pasteEpic) +const mockFileSystem = (): MockedFileSystem => { + const memoryFileSystem = new MemoryFileSystem() + const fileSystem = new MockedFileSystem( + new ExplorerFileSystem.FileSystem(memoryFileSystem as any), + ) + return fileSystem +} -const epicMiddleware = createEpicMiddleware(rootEpic, { - dependencies: { - fileSystem: MockedFileSystem as any, - notifications: {} as Notifications, - }, -}) +const mockStoreFactory = ( + epics: any[], + notifications = {} as Notifications, + fileSystem: ExplorerFileSystem.IFileSystem = mockFileSystem(), +): MockStoreCreator => { + const rootEpic = combineEpics(...epics) -const MemoryFileSystem = require("memory-fs") // tslint:disable-line -const mockStore: MockStoreCreator = configureMockStore([ - epicMiddleware, -]) + const epicMiddleware = createEpicMiddleware(rootEpic, { + dependencies: { fileSystem, notifications }, + }) -describe("ExplorerStore", () => { - let fileSystem: any - let store: Store - let explorerFileSystem: MockedFileSystem + const mockStore: MockStoreCreator = configureMockStore([ + epicMiddleware, + ]) + return mockStore +} + +describe("ExplorerStore", () => { const rootPath = path.normalize(path.join(TestHelpers.getRootDirectory(), "a", "test", "dir")) const filePath = path.join(rootPath, "file.txt") const target = { filePath, id: "1" } - const epicStore = mockStore({ ...ExplorerState.DefaultExplorerState }) const pasted1 = { type: "file", @@ -109,25 +133,25 @@ describe("ExplorerStore", () => { sources: [pasted1], } as ExplorerState.IPasteAction - beforeEach(() => { - fileSystem = new MemoryFileSystem() - fileSystem.mkdirpSync(rootPath) - fileSystem.writeFileSync(filePath, "Hello World") - - explorerFileSystem = new MockedFileSystem( - new ExplorerFileSystem.FileSystem(fileSystem as any), - ) - store = ExplorerState.createStore({ - fileSystem: explorerFileSystem, - notifications: {} as any, - }) - }) + describe("SET_ROOT_DIRECTORY", () => { + let store: Store + let explorerFileSystem: MockedFileSystem - afterEach(() => { - epicMiddleware.replaceEpic(rootEpic) - }) + beforeEach(() => { + let fileSystem: any + fileSystem = new MemoryFileSystem() + fileSystem.mkdirpSync(rootPath) + fileSystem.writeFileSync(filePath, "Hello World") + + explorerFileSystem = new MockedFileSystem( + new ExplorerFileSystem.FileSystem(fileSystem as any), + ) + store = ExplorerState.createStore({ + fileSystem: explorerFileSystem, + notifications: {} as any, + }) + }) - describe("SET_ROOT_DIRECTORY", () => { it("expands directory automatically", async () => { store.dispatch({ type: "SET_ROOT_DIRECTORY", @@ -148,20 +172,111 @@ describe("ExplorerStore", () => { }) }) + describe("selectFileReducer", () => { + it("returns state unchanged if action is not recognized", () => { + const state = ExplorerState.selectFileReducer("shouldn't change", { + type: "UNRECOGNISED", + filePath: "not me", + }) + assert.equal(state, "shouldn't change") + }) + + it("flags pending file to select in state when given pending action", () => { + const state = ExplorerState.selectFileReducer("should change", { + type: "SELECT_FILE_PENDING", + filePath: "change to me", + }) + assert.equal(state, "change to me") + }) + + it("resets pending file to select in state when given success action", () => { + const state = ExplorerState.selectFileReducer("should change", { + type: "SELECT_FILE_SUCCESS", + }) + assert.equal(state, null) + }) + }) + + describe("selectFileEpic", () => { + let epicStore: any + + beforeEach(() => { + epicStore = mockStoreFactory([ExplorerState.selectFileEpic])({ + ...ExplorerState.DefaultExplorerState, + rootFolder: { type: "folder", fullPath: rootPath }, + }) + }) + + it("dispatches actions to expand folders and select file", async () => { + const fileToSelect = path.normalize(path.join(rootPath, "dir1", "dir2", "file.cpp")) + epicStore.dispatch({ type: "SELECT_FILE", filePath: fileToSelect }) + await TestHelpers.waitForAllAsyncOperations() + const actions = epicStore.getActions() + assert.deepStrictEqual(actions, [ + { type: "SELECT_FILE", filePath: fileToSelect }, + { + type: "EXPAND_DIRECTORY", + directoryPath: path.normalize(path.join(rootPath, "dir1")), + }, + { + type: "EXPAND_DIRECTORY", + directoryPath: path.normalize(path.join(rootPath, "dir1", "dir2")), + }, + { type: "SELECT_FILE_PENDING", filePath: fileToSelect }, + ]) + }) + + it("dispatches failure if target is not in workspace", async () => { + const fileToSelect = path.normalize(path.join(TestHelpers.getRootDirectory(), "other")) + epicStore.dispatch({ type: "SELECT_FILE", filePath: fileToSelect }) + await TestHelpers.waitForAllAsyncOperations() + const actions = epicStore.getActions() + assert.deepStrictEqual(actions, [ + { type: "SELECT_FILE", filePath: fileToSelect }, + { type: "SELECT_FILE_FAIL", reason: "File is not in workspace: " + fileToSelect }, + ]) + }) + }) + + describe("notificationEpic", () => { + let epicStore: any + let notifications: any + let notification: any + + beforeEach(() => { + notifications = sinon.createStubInstance(Notifications) + notification = sinon.createStubInstance(Notification) + notifications.createItem.returns(notification) + epicStore = mockStoreFactory([ExplorerState.notificationEpic], notifications as any)({ + ...ExplorerState.DefaultExplorerState, + rootFolder: { type: "folder", fullPath: rootPath }, + }) + }) + + it("notifies on failing to select a file in explorer", () => { + epicStore.dispatch({ type: "SELECT_FILE_FAIL", reason: "broken" }) + const actions = epicStore.getActions() + + assert(notification.setContents.calledWith("Select Failed", "broken")) + assert(notification.setLevel.calledWith("warn")) + assert(notification.setExpiration.calledWith(5_000)) + assert(notification.show.calledWith()) + assert(notification.show.calledAfter(notification.setContents)) + assert(notification.show.calledAfter(notification.setLevel)) + assert(notification.show.calledAfter(notification.setExpiration)) + assert.deepStrictEqual(actions, [ + { type: "SELECT_FILE_FAIL", reason: "broken" }, + { type: "NOTIFICATION_SENT", typeOfNotification: "SELECT_FILE_FAIL" }, + ]) + }) + }) + describe("YANK_AND_PASTE_EPICS", async () => { - const fs = { - move: async (source, dest) => null, - readdir: () => null as any, - exists: async file => true, - persistNode: async file => null, - restoreNode: async file => null, - deleteNode: file => null, - canPersistNode: async (file, size) => true, - moveNodesBack: async collection => null, - writeFile: async name => null, - mkdir: async name => null, - } as ExplorerFileSystem.IFileSystem + let fs: any + beforeEach(() => { + fs = new MockedFileSystem(new ExplorerFileSystem.FileSystem(new MemoryFileSystem())) + }) const notifications = { _id: 0, _overlay: null, @@ -177,12 +292,17 @@ describe("ExplorerStore", () => { }), } as any + const mockStore = mockStoreFactory([ + ExplorerState.pasteEpic, + ExplorerState.clearYankRegisterEpic, + ]) + it("dispatches a clear register action after a minute", async () => { + const epicStore = mockStore({ ...ExplorerState.DefaultExplorerState }) epicStore.dispatch({ type: "YANK", target }) const actions = epicStore.getActions() await TestHelpers.waitForAllAsyncOperations() - // three because an init action is sent first - await assert.ok(actions.length === 3) + await assert.equal(actions.length, 2) const clearedRegister = !!actions.find(action => action.type === "CLEAR_REGISTER") assert.ok(clearedRegister) }) @@ -245,15 +365,12 @@ describe("ExplorerStore", () => { persist: true, } as ExplorerState.IDeleteAction) + sinon.stub(fs, "persistNode").throws(new Error("Doesnt work")) + const expected = [{ type: "DELETE_FAIL", reason: "Doesnt work" }] ExplorerState.deleteEpic(action$, null, { - fileSystem: { - ...fs, - persistNode: async node => { - throw new Error("Doesnt work") - }, - }, + fileSystem: fs, notifications, }) .toArray() @@ -464,7 +581,7 @@ describe("ExplorerStore", () => { .subscribe(actualAction => assert.deepEqual(actualAction, expected)) }) - it("Should return a create node success action if a creation is committed", () => { + it("Should return a create node success action if a creation is committed", async () => { const action$ = ActionsObservable.of({ type: "CREATE_NODE_COMMIT", name: "/test/dir/file.txt", @@ -487,16 +604,21 @@ describe("ExplorerStore", () => { const expected = [ { type: "CREATE_NODE_SUCCESS", nodeType: "file", name: "/test/dir/file.txt" }, - { type: "EXPAND_DIRECTORY", directoryPath: "/test/dir" }, - { type: "REFRESH" }, + { type: "SELECT_FILE", filePath: "/test/dir/file.txt" }, ] - ExplorerState.createNodeEpic(action$, createState, { fileSystem: fs, notifications }) + return ExplorerState.createNodeEpic(action$, createState, { + fileSystem: fs, + notifications, + }) .toArray() - .subscribe(actualActions => assert.deepEqual(actualActions, expected)) + .toPromise() + .then(actualActions => { + assert.deepEqual(actualActions, expected) + }) }) - it("Should return an error action if a creation fails", () => { + it("Should return an error action if a creation fails", async () => { const action$ = ActionsObservable.of({ type: "CREATE_NODE_COMMIT", name: "/test/dir/file.txt", @@ -519,7 +641,7 @@ describe("ExplorerStore", () => { const expected = [{ type: "CREATE_NODE_FAIL", reason: "Duplicate" }] - ExplorerState.createNodeEpic(action$, createState, { + return ExplorerState.createNodeEpic(action$, createState, { fileSystem: { ...fs, writeFile: async folderpath => { @@ -529,7 +651,8 @@ describe("ExplorerStore", () => { notifications, }) .toArray() - .subscribe(actualActions => { + .toPromise() + .then(actualActions => { assert.deepEqual(actualActions, expected) }) }) diff --git a/browser/test/Services/Language/LanguageManagerTests.ts b/browser/test/Services/Language/LanguageManagerTests.ts index 77c0485249..054487866a 100644 --- a/browser/test/Services/Language/LanguageManagerTests.ts +++ b/browser/test/Services/Language/LanguageManagerTests.ts @@ -8,7 +8,6 @@ import * as sinon from "sinon" import { Event } from "oni-types" -import { EditorManager } from "./../../../src/Services/EditorManager" import * as Language from "./../../../src/Services/Language" import * as Mocks from "./../../Mocks" @@ -44,16 +43,13 @@ export class MockLanguageClient implements Language.ILanguageClient { describe("LanguageManager", () => { // Mocks - let mockConfiguration: Mocks.MockConfiguration - let mockEditor: Mocks.MockEditor - let editorManager: EditorManager - let mockWorkspace: Mocks.MockWorkspace + let mockOni: Mocks.MockOni // Class under test let languageManager: Language.LanguageManager beforeEach(() => { - mockConfiguration = new Mocks.MockConfiguration({ + const mockConfiguration = new Mocks.MockConfiguration({ "editor.quickInfo.delay": 500, "editor.quickInfo.enabled": true, "status.priority": { @@ -64,21 +60,9 @@ describe("LanguageManager", () => { "oni.status.git": 2, }, }) + mockOni = new Mocks.MockOni(mockConfiguration) - editorManager = new EditorManager() - mockEditor = new Mocks.MockEditor() - editorManager.setActiveEditor(mockEditor) - mockWorkspace = new Mocks.MockWorkspace() - - const mockStatusBar = new Mocks.MockStatusBar() - - languageManager = new Language.LanguageManager( - mockConfiguration as any, - editorManager, - new Mocks.MockPluginManager() as any, - mockStatusBar, - mockWorkspace, - ) + languageManager = new Language.LanguageManager(mockOni) }) it("sends didOpen request if language server is registered after enter event", async () => { @@ -86,6 +70,7 @@ describe("LanguageManager", () => { // This can happen if a plugin registers a language server, because we spin // up the editors before initializing plugins. const mockBuffer = new Mocks.MockBuffer("javascript", "test.js", ["a", "b", "c"]) + const mockEditor = mockOni.editors.activeEditor as Mocks.MockEditor mockEditor.simulateBufferEnter(mockBuffer) const mockLanguageClient = new MockLanguageClient() diff --git a/extensions/oni-plugin-markdown-preview/package.json b/extensions/oni-plugin-markdown-preview/package.json index a890d11ac3..acd23614c0 100644 --- a/extensions/oni-plugin-markdown-preview/package.json +++ b/extensions/oni-plugin-markdown-preview/package.json @@ -23,6 +23,7 @@ "tbd-dependencies": { "marked": "^0.4.0", "dompurify": "1.0.2", + "highlight.js": "^9.12.0", "oni-types": "^0.0.4", "oni-api": "^0.0.9" }, @@ -31,6 +32,7 @@ "rimraf": "^2.6.2" }, "tbd-devDependencies": { + "@types/highlight.js": "^9.12.2", "typescript": "2.5.3", "rimraf": "2.6.2" } diff --git a/extensions/oni-plugin-markdown-preview/src/index.tsx b/extensions/oni-plugin-markdown-preview/src/index.tsx index cf5479ecf3..d87cfdf003 100644 --- a/extensions/oni-plugin-markdown-preview/src/index.tsx +++ b/extensions/oni-plugin-markdown-preview/src/index.tsx @@ -1,6 +1,7 @@ import { EventCallback, IDisposable, IEvent } from "oni-types" import * as dompurify from "dompurify" +import * as hljs from "highlight.js" import * as marked from "marked" import * as Oni from "oni-api" import * as React from "react" @@ -84,6 +85,9 @@ class MarkdownPreview extends React.PureComponent +