[background-tips] Add service API for tip registration and redistribute tips #1417
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,156 +1,184 @@ | ||
| const _ = require("underscore-plus"); | ||
| const { CompositeDisposable, Disposable } = require("atom"); | ||
|
|
||
| const TEMPLATE = `\ | ||
| <ul class="centered background-message"> | ||
| <li class="message"></li> | ||
| </ul>\ | ||
| `; | ||
|
|
||
| module.exports = class BackgroundTipsElement { | ||
| constructor(main) { | ||
| this.main = main; | ||
| this.element = document.createElement("background-tips"); | ||
| this.index = -1; | ||
| this.workspaceCenter = atom.workspace.getCenter(); | ||
|
|
||
| this.startDelay = 1000; | ||
| this.displayDuration = 10000; | ||
| this.fadeDuration = 300; | ||
|
|
||
| this.renderedTips = []; | ||
| this.tipsRendered = false; | ||
|
|
||
| this.disposables = new CompositeDisposable(); | ||
|
|
||
| const visibilityCallback = () => this.updateVisibility(); | ||
|
|
||
| this.disposables.add(this.workspaceCenter.onDidAddPane(visibilityCallback)); | ||
| this.disposables.add( | ||
| this.workspaceCenter.onDidDestroyPane(visibilityCallback) | ||
| ); | ||
| this.disposables.add( | ||
| this.workspaceCenter.onDidChangeActivePaneItem(visibilityCallback) | ||
| ); | ||
|
|
||
| atom.getCurrentWindow().on("blur", visibilityCallback); | ||
| atom.getCurrentWindow().on("focus", visibilityCallback); | ||
|
|
||
| this.disposables.add( | ||
| new Disposable(() => | ||
| atom.getCurrentWindow().removeListener("blur", visibilityCallback) | ||
| ) | ||
| ); | ||
| this.disposables.add( | ||
| new Disposable(() => | ||
| atom.getCurrentWindow().removeListener("focus", visibilityCallback) | ||
| ) | ||
| ); | ||
|
|
||
| this.startTimeout = setTimeout(() => this.start(), this.startDelay); | ||
| } | ||
|
|
||
| destroy() { | ||
| this.stop(); | ||
| this.disposables.dispose(); | ||
| } | ||
|
|
||
| attach() { | ||
| this.element.innerHTML = TEMPLATE; | ||
| this.message = this.element.querySelector(".message"); | ||
|
|
||
| const paneView = atom.views.getView(this.workspaceCenter.getActivePane()); | ||
| const itemViews = paneView.querySelector(".item-views"); | ||
| let top = 0; | ||
| if (itemViews && itemViews.offsetTop) { | ||
| top = itemViews.offsetTop; | ||
| } | ||
|
|
||
| this.element.style.top = top + "px"; | ||
| paneView.appendChild(this.element); | ||
| } | ||
|
|
||
| detach() { | ||
| this.element.remove(); | ||
| } | ||
|
|
||
| updateVisibility() { | ||
| if (this.shouldBeAttached()) { | ||
| this.start(); | ||
| } else { | ||
| this.stop(); | ||
| } | ||
| } | ||
|
|
||
| shouldBeAttached() { | ||
| return ( | ||
| this.workspaceCenter.getPanes().length === 1 && | ||
| this.workspaceCenter.getActivePaneItem() == null && | ||
| atom.getCurrentWindow().isFocused() | ||
| ); | ||
| } | ||
|
|
||
| start() { | ||
| if (!this.shouldBeAttached() || this.interval != null) return; | ||
| this.renderTips(); | ||
| this.randomizeIndex(); | ||
| this.attach(); | ||
| this.showNextTip(); | ||
| this.interval = setInterval(() => this.showNextTip(), this.displayDuration); | ||
| } | ||
|
|
||
| stop() { | ||
| this.element.remove(); | ||
| if (this.interval != null) { | ||
| clearInterval(this.interval); | ||
| } | ||
|
|
||
| clearTimeout(this.startTimeout); | ||
| clearTimeout(this.nextTipTimeout); | ||
| this.interval = null; | ||
| } | ||
|
|
||
| randomizeIndex() { | ||
| const len = this.renderedTips.length; | ||
| this.index = len > 0 ? Math.round(Math.random() * len) % len : 0; | ||
| } | ||
|
|
||
| showNextTip() { | ||
| if (this.renderedTips.length === 0) return; | ||
| this.index = ++this.index % this.renderedTips.length; | ||
| this.message.classList.remove("fade-in"); | ||
| this.nextTipTimeout = setTimeout(() => { | ||
| this.message.innerHTML = this.renderedTips[this.index]; | ||
| this.message.classList.add("fade-in"); | ||
| }, this.fadeDuration); | ||
| } | ||
|
|
||
| renderTips() { | ||
| if (this.tipsRendered) return; | ||
| const tips = this.main.getTips(); | ||
| this.renderedTips = tips.map((tip) => this.renderTip(tip)); | ||
| this.tipsRendered = true; | ||
| } | ||
|
|
||
| tipsChanged() { | ||
| this.tipsRendered = false; | ||
| if (this.interval != null) { | ||
| this.renderTips(); | ||
| this.index = Math.min(this.index, this.renderedTips.length - 1); | ||
| } | ||
| } | ||
|
|
||
| renderTip(str) { | ||
| str = str.replace(/\{(.+)\}/g, (match, command) => { | ||
| let binding, scope; | ||
| const scopeAndCommand = command.split(">"); | ||
| if (scopeAndCommand.length > 1) { | ||
| [scope, command] = scopeAndCommand; | ||
| } | ||
| const bindings = atom.keymaps.findKeyBindings({ | ||
| command: command.trim(), | ||
| }); | ||
|
|
||
| if (scope) { | ||
| for (binding of bindings) { | ||
| if (binding.selector === scope) break; | ||
| } | ||
| } else { | ||
| binding = this.getKeyBindingForCurrentPlatform(bindings); | ||
| } | ||
|
|
||
| if (binding && binding.keystrokes) { | ||
| const keystrokeLabel = _.humanizeKeystroke(binding.keystrokes).replace( | ||
| /\s+/g, | ||
| " " | ||
| ); | ||
| return `<span class="keystroke">${keystrokeLabel}</span>`; | ||
| } else { | ||
| return command; | ||
| } | ||
| }); | ||
| return str; | ||
| } | ||
|
|
||
| getKeyBindingForCurrentPlatform(bindings) { | ||
| if (!bindings || !bindings.length) return; | ||
| for (let binding of bindings) { | ||
| if (binding.selector.indexOf(process.platform) !== -1) { | ||
| return binding; | ||
| } | ||
| } | ||
| return bindings[0]; | ||
| } | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,36 @@ | ||
| const { Disposable } = require("atom"); | ||
| const BackgroundTipsView = require("./background-tips-view"); | ||
|
|
||
| module.exports = { | ||
| activate() { | ||
| this.defaultTips = require("./tips"); | ||
| this.addedTips = new Set(); | ||
| this.backgroundTipsView = new BackgroundTipsView(this); | ||
| }, | ||
|
|
||
| deactivate() { | ||
| this.backgroundTipsView.destroy(); | ||
| this.addedTips.clear(); | ||
| }, | ||
|
|
||
| getTips() { | ||
| let all = [...this.defaultTips]; | ||
| for (const tips of this.addedTips) { | ||
| all = all.concat(tips); | ||
| } | ||
| return all; | ||
| }, | ||
|
|
||
| provideBackgroundTips() { | ||
| return { | ||
| addTips: (tips) => { | ||
| this.addedTips.add(tips); | ||
| this.backgroundTipsView.tipsChanged(); | ||
| return new Disposable(() => { | ||
| this.addedTips.delete(tips); | ||
| this.backgroundTipsView.tipsChanged(); | ||
| }); | ||
| }, | ||
| }; | ||
| }, | ||
| }; | ||
|
Member
There was a problem hiding this comment. I know it might be somewhat antithetical to this PR, but we may want to leave the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,5 @@ | ||
| module.exports = [ | ||
| "Split your editor into multiple panes with {pane:split-right-and-copy-active-item}", | ||
| "You can move lines of text up and down with {editor:move-line-up} and {editor:move-line-down}", | ||
| "Toggle line comments quickly with {editor:toggle-line-comments}", | ||
| ]; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't test this at the moment. But with storing all acquired tips in a
Setwhat are the chances we would retain tips after a package has been disabled in our current session? If this is still an issue, we could consider that still not even loading them after a reload is a huge improvement from previous behavior, but was just curious considering the goals of this PR.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are right, the service is too simple now. I will prepare new commits today that will handle lifecycle of tips better.