Put misspelling decorations in their owm marker layer

Author: maxbrunsfeld

lib/corrections-view.coffee

@@ -24,7 +24,7 @@ class CorrectionsView extends SelectListView
     @cancel()
     return unless correction
     @editor.transact =>
-      @editor.selectMarker(@marker)
+      @editor.setSelectedBufferRange(@marker.getRange())
       @editor.insertText(correction)
 
   cancelled: ->

lib/main.coffee

@@ -14,11 +14,13 @@ module.exports =
       description: 'List of scopes for languages which will be checked for misspellings. See [the README](https://github.com/atom/spell-check#spell-check-package-) for more information on finding the correct scope for a specific language.'
 
   activate: ->
-    @disposable = atom.workspace.observeTextEditors(addViewToEditor)
+    @viewsByEditor = new WeakMap
+    @disposable = atom.workspace.observeTextEditors (editor) =>
+      SpellCheckView ?= require './spell-check-view'
+      @viewsByEditor.set(editor, new SpellCheckView(editor))
+
+  misspellingMarkersForEditor: (editor) ->
+    @viewsByEditor.get(editor).markerLayer.getMarkers()
 
   deactivate: ->
     @disposable.dispose()
-
-addViewToEditor = (editor) ->
-  SpellCheckView ?= require './spell-check-view'
-  new SpellCheckView(editor)

lib/misspelling-view.coffee

@@ -1,6 +1,8 @@
 SpellChecker = require 'spellchecker'
 
 module.exports = ({id, text}) ->
+  console.log("SPELL CHECKING!!", id)
+
   SpellChecker.add("GitHub")
   SpellChecker.add("github")
 

lib/spell-check-handler.coffee

@@ -1,21 +1,29 @@
 _ = require 'underscore-plus'
 {CompositeDisposable} = require 'atom'
-MisspellingView = require './misspelling-view'
 SpellCheckTask = require './spell-check-task'
 
+CorrectionsView = null
+SpellChecker = null
+
 module.exports =
 class SpellCheckView
   @content: ->
     @div class: 'spell-check'
 
   constructor: (@editor) ->
     @disposables = new CompositeDisposable
-    @views = []
     @task = new SpellCheckTask()
+    @initializeMarkerLayer()
+
+    @correctMisspellingCommand = atom.commands.add atom.views.getView(@editor), 'spell-check:correct-misspelling', =>
+      if marker = @markerLayer.findMarkers({containsPoint: @editor.getCursorBufferPosition()})[0]
+        CorrectionsView ?= require './corrections-view'
+        @correctionsView?.destroy()
+        @correctionsView = new CorrectionsView(@editor, @getCorrections(marker), marker)
 
     @task.onDidSpellCheck (misspellings) =>
-      @destroyViews()
-      @addViews(misspellings) if @buffer?
+      @detroyMarkers()
+      @addMarkers(misspellings) if @buffer?
 
     @disposables.add @editor.onDidChangePath =>
       @subscribeToBuffer()
@@ -33,13 +41,25 @@ class SpellCheckView
 
     @disposables.add @editor.onDidDestroy(@destroy.bind(this))
 
+  initializeMarkerLayer: ->
+    @markerLayer = @editor.getBuffer().addMarkerLayer()
+    @markerLayerDecoration = @editor.decorateMarkerLayer(@markerLayer, {
+      type: 'highlight',
+      class: 'spell-check-misspelling',
+      deprecatedRegionClass: 'misspelling'
+    })
+
   destroy: ->
     @unsubscribeFromBuffer()
     @disposables.dispose()
     @task.terminate()
+    @markerLayer.destroy()
+    @markerLayerDecoration.destroy()
+    @correctMisspellingCommand.dispose()
+    @correctionsView?.remove()
 
   unsubscribeFromBuffer: ->
-    @destroyViews()
+    @detroyMarkers()
 
     if @buffer?
       @bufferDisposable.dispose()
@@ -57,18 +77,28 @@ class SpellCheckView
     grammar = @editor.getGrammar().scopeName
     _.contains(atom.config.get('spell-check.grammars'), grammar)
 
-  destroyViews: ->
-    while view = @views.shift()
-      view.destroy()
+  detroyMarkers: ->
+    @markerLayer.destroy()
+    @markerLayerDecoration.destroy()
+    @initializeMarkerLayer()
 
-  addViews: (misspellings) ->
+  addMarkers: (misspellings) ->
     for misspelling in misspellings
-      view = new MisspellingView(misspelling, @editor)
-      @views.push(view)
+      @markerLayer.markRange(misspelling,
+        invalidate: 'touch',
+        replicate: 'false',
+        persistent: false,
+        maintainHistory: false,
+      )
 
   updateMisspellings: ->
     # Task::start can throw errors atom/atom#3326
     try
       @task.start(@buffer.getText())
     catch error
       console.warn('Error starting spell check task', error.stack ? error)
+
+  getCorrections: (marker) ->
+    SpellChecker ?= require 'spellchecker'
+    misspelling = @editor.getTextInBufferRange(marker.getRange())
+    corrections = SpellChecker.getCorrectionsForMisspelling(misspelling)

lib/spell-check-view.coffee

@@ -1,8 +1,11 @@
 describe "Spell check", ->
-  [workspaceElement, editor, editorElement] = []
+  [workspaceElement, editor, editorElement, spellCheckModule] = []
 
-  textForDecoration = ({marker}) ->
-    editor.getTextInBufferRange(marker.getBufferRange())
+  textForMarker = (marker) ->
+    editor.getTextInBufferRange(marker.getRange())
+
+  getMisspellingMarkers = ->
+    spellCheckModule.misspellingMarkersForEditor(editor)
 
   beforeEach ->
     workspaceElement = atom.views.getView(atom.workspace)
@@ -20,7 +23,8 @@ describe "Spell check", ->
       atom.workspace.open('sample.js')
 
     waitsForPromise ->
-      atom.packages.activatePackage('spell-check')
+      atom.packages.activatePackage('spell-check').then ({mainModule}) ->
+        spellCheckModule = mainModule
 
     runs ->
       jasmine.attachToDOM(workspaceElement)
@@ -31,67 +35,67 @@ describe "Spell check", ->
     editor.setText("This middle of thiss\nsentencts\n\nhas issues and the \"edn\" 'dsoe' too")
     atom.config.set('spell-check.grammars', ['source.js'])
 
-    decorations = null
-
+    misspellingMarkers = null
     waitsFor ->
-      decorations = editor.getHighlightDecorations(class: 'spell-check-misspelling')
-      decorations.length > 0
-
+      misspellingMarkers = getMisspellingMarkers()
+      misspellingMarkers.length > 0
 
     runs ->
-      expect(decorations.length).toBe 4
-      expect(textForDecoration(decorations[0])).toEqual "thiss"
-      expect(textForDecoration(decorations[1])).toEqual "sentencts"
-      expect(textForDecoration(decorations[2])).toEqual "edn"
-      expect(textForDecoration(decorations[3])).toEqual "dsoe"
+      expect(misspellingMarkers.length).toBe 4
+      expect(textForMarker(misspellingMarkers[0])).toEqual "thiss"
+      expect(textForMarker(misspellingMarkers[1])).toEqual "sentencts"
+      expect(textForMarker(misspellingMarkers[2])).toEqual "edn"
+      expect(textForMarker(misspellingMarkers[3])).toEqual "dsoe"
 
   it "doesn't consider our company's name to be a spelling error", ->
     editor.setText("GitHub (aka github): Where codez are built.")
     atom.config.set('spell-check.grammars', ['source.js'])
 
-    decorations = null
-
+    misspellingMarkers = null
     waitsFor ->
-      decorations = editor.getHighlightDecorations(class: 'spell-check-misspelling')
-      decorations.length > 0
+      misspellingMarkers = getMisspellingMarkers()
+      misspellingMarkers.length > 0
 
     runs ->
-      expect(decorations.length).toBe 1
-      expect(textForDecoration(decorations[0])).toBe "codez"
+      expect(misspellingMarkers.length).toBe 1
+      expect(textForMarker(misspellingMarkers[0])).toBe "codez"
 
   it "hides decorations when a misspelled word is edited", ->
     editor.setText('notaword')
     advanceClock(editor.getBuffer().getStoppedChangingDelay())
     atom.config.set('spell-check.grammars', ['source.js'])
 
-    decorations = null
+    misspellingMarkers = null
     waitsFor ->
-      decorations = editor.getHighlightDecorations(class: 'spell-check-misspelling')
-      decorations.length > 0
+      misspellingMarkers = getMisspellingMarkers()
+      misspellingMarkers.length > 0
 
     runs ->
-      expect(decorations.length).toBe 1
+      expect(misspellingMarkers.length).toBe 1
       editor.moveToEndOfLine()
       editor.insertText('a')
       advanceClock(editor.getBuffer().getStoppedChangingDelay())
-      decorations = editor.getHighlightDecorations(class: 'spell-check-misspelling')
-      expect(decorations.length).toBe 1
-      expect(decorations[0].marker.isValid()).toBe false
+
+      misspellingMarkers = getMisspellingMarkers()
+
+      expect(misspellingMarkers.length).toBe 1
+      expect(misspellingMarkers[0].isValid()).toBe false
 
   describe "when spell checking for a grammar is removed", ->
     it "removes all the misspellings", ->
       editor.setText('notaword')
       advanceClock(editor.getBuffer().getStoppedChangingDelay())
       atom.config.set('spell-check.grammars', ['source.js'])
 
-      decorations = null
+      misspellingMarkers = null
       waitsFor ->
-        editor.getHighlightDecorations(class: 'spell-check-misspelling').length > 0
+        misspellingMarkers = getMisspellingMarkers()
+        misspellingMarkers.length > 0
 
       runs ->
-        expect(editor.getHighlightDecorations(class: 'spell-check-misspelling').length).toBe 1
+        expect(getMisspellingMarkers().length).toBe 1
         atom.config.set('spell-check.grammars', [])
-        expect(editor.getHighlightDecorations(class: 'spell-check-misspelling').length).toBe 0
+        expect(getMisspellingMarkers().length).toBe 0
 
   describe "when the editor's grammar changes to one that does not have spell check enabled", ->
     it "removes all the misspellings", ->
@@ -100,12 +104,12 @@ describe "Spell check", ->
       atom.config.set('spell-check.grammars', ['source.js'])
 
       waitsFor ->
-        editor.getHighlightDecorations(class: 'spell-check-misspelling').length > 0
+        getMisspellingMarkers().length > 0
 
       runs ->
-        expect(editor.getHighlightDecorations(class: 'spell-check-misspelling').length).toBe 1
+        expect(getMisspellingMarkers().length).toBe 1
         editor.setGrammar(atom.grammars.selectGrammar('.txt'))
-        expect(editor.getHighlightDecorations(class: 'spell-check-misspelling').length).toBe 0
+        expect(getMisspellingMarkers().length).toBe 0
 
   describe "when 'spell-check:correct-misspelling' is triggered on the editor", ->
     describe "when the cursor touches a misspelling that has corrections", ->
@@ -115,9 +119,11 @@ describe "Spell check", ->
         atom.config.set('spell-check.grammars', ['source.js'])
 
         waitsFor ->
-          editor.getHighlightDecorations(class: 'spell-check-misspelling').length > 0
+          getMisspellingMarkers().length is 1
 
         runs ->
+          expect(getMisspellingMarkers()[0].isValid()).toBe true
+
           atom.commands.dispatch editorElement, 'spell-check:correct-misspelling'
 
           correctionsElement = editorElement.querySelector('.corrections')
@@ -129,8 +135,8 @@ describe "Spell check", ->
 
           expect(editor.getText()).toBe 'together'
           expect(editor.getCursorBufferPosition()).toEqual [0, 8]
-          advanceClock(editor.getBuffer().getStoppedChangingDelay())
-          expect(editorElement.querySelectorAll('.spell-check-misspelling').length).toBe 0
+
+          expect(getMisspellingMarkers()[0].isValid()).toBe false
           expect(editorElement.querySelector('.corrections')).toBeNull()
 
     describe "when the cursor touches a misspelling that has no corrections", ->
@@ -140,7 +146,7 @@ describe "Spell check", ->
         atom.config.set('spell-check.grammars', ['source.js'])
 
         waitsFor ->
-          editor.getHighlightDecorations(class: 'spell-check-misspelling').length > 0
+          getMisspellingMarkers().length > 0
 
         runs ->
           atom.commands.dispatch editorElement, 'spell-check:correct-misspelling'
@@ -154,8 +160,8 @@ describe "Spell check", ->
       atom.config.set('spell-check.grammars', ['source.js'])
 
       waitsFor ->
-        editor.getHighlightDecorations(class: 'spell-check-misspelling').length > 0
+        getMisspellingMarkers().length > 0
 
       runs ->
         editor.destroy()
-        expect(editor.getMarkers().length).toBe 0
+        expect(getMisspellingMarkers().length).toBe 0