CodeMirror v4 Integration

Jason San Jose edited this page Nov 19, 2013 · 23 revisions
Clone this wiki locally


Known Issues


Nov 16 - Jason

Uncaught TypeError: Cannot read property 'length' of undefined codemirror.js:2770
skipAtomicInSelection codemirror.js:2770
setSelection codemirror.js:2750
(anonymous function) codemirror.js:1511
onContextMenu codemirror.js:2336
(anonymous function)

Nov 15 - Jason

EditorCommandHandlers (8)

All 8 failures due to mismatched cursor/selection positions

HTMLUtils Code Hints (27), EditorManager (12), CSSUtils - Other (1), HTML Instrumentation (1)

This stack occurs in the first test when creating a new empty editor:

TypeError: Cannot set property 'selAfter' of undefined
    at setSelectionAddToHistory (file:///C:/Program%20Files/Brackets/dev/src/thirdparty/CodeMirror2/lib/codemirror.js:2720:36)
    at null.<anonymous> (file:///C:/Program%20Files/Brackets/dev/src/thirdparty/CodeMirror2/lib/codemirror.js:5070:7)
    at null.setValue (file:///C:/Program%20Files/Brackets/dev/src/thirdparty/CodeMirror2/lib/codemirror.js:1520:24)
    at null.setValue (file:///C:/Program%20Files/Brackets/dev/src/thirdparty/CodeMirror2/lib/codemirror.js:5317:40)
    at Editor._resetText (file:///C:/Program%20Files/Brackets/dev/src/editor/Editor.js:721:26)
    at new Editor (file:///C:/Program%20Files/Brackets/dev/src/editor/Editor.js:418:14)
    at null.<anonymous> (file:///C:/Program%20Files/Brackets/dev/test/spec/CodeHintUtils-test.js:46:24)

LanguageManager (1)

Error: Expected undefined not to be undefined.
    at new jasmine.ExpectationResult (file:///C:/Program%20Files/Brackets/dev/test/thirdparty/jasmine-core/jasmine.js:102:32)
    at null.toBe (file:///C:/Program%20Files/Brackets/dev/test/thirdparty/jasmine-core/jasmine.js:1194:29)
    at null.<anonymous> (file:///C:/Program%20Files/Brackets/dev/test/spec/LanguageManager-test.js:398:54)
    at jasmine.Block.execute (file:///C:/Program%20Files/Brackets/dev/test/thirdparty/jasmine-core/jasmine.js:1024:15)
    at jasmine.Queue.next_ (file:///C:/Program%20Files/Brackets/dev/test/thirdparty/jasmine-core/jasmine.js:1842:31)
    at file:///C:/Program%20Files/Brackets/dev/test/thirdparty/jasmine-core/jasmine.js:1832:18
  • The selAfter messages above are easily reproducible when creating a new untitled document
  • Confirmed that cmv4 fires 2 change events. In my JS file test, typing a single char, the change event shows the insertion (good) and a deletion of the inserted char (wha?)
  • JS, CSS and HTML code hints are in various states of broken
    • JS - change handler is triggered twice. The first time, the inserted char appears in the editor and a hints popup already appears. The second time, the inserted character was somehow removed.
    • CSS - inserting a style name works fine, but value hinting immediately after is broken. Instead of seeing the value hints popup, the next char becomes selected
    • HTML - tag hinting appears to work, but attribute name hinting will delete the next character, yet still show the hints popup. Attribute value hinting is even worse. Inserting a value ltr for dir attribute in <div dir=""></div> actually produces <div dir="">ltr</div>
  • [nj] I wonder if those issues are somehow related to the fact that CM sends out multiple change events for a single operation now (as opposed to chaining them all together in a single change). It doesn't seem like we should be sensitive to that (except for performance reasons), but maybe we have code that assumes a single typing op only produces one change event. (Though I'm not sure why you would get two change events for just typing a character anyway.)

Nov 14 - NJ

Note that even basic edits get broken with multiple selections if you have JS code hints enabled (or probably any code hinter—I haven’t tried in HTML or CSS). If you remove the JS code hints extension, basic multi-selection edits seem to work. I didn’t try any other Brackets-specific functionality like move line up/down, etc. or extensions.

In general, the existing CM APIs are supposed to act on just the “primary selection” (which is probably either the first or last selection, not sure), so it’s not clear why stuff in Brackets would be badly broken (the only APIs that have special behavior are getSelection()/replaceSelection(), which I don’t think we use much); in general, it seems like Brackets edits should just act on one of the selections. But with code hints on things get corrupted pretty quickly.

Also, aside from figuring out what is/isn’t broken in Brackets, it would be good to do a comparison of Sublime’s behavior with multiple/rectangular selections on various edits with what CM implements (or in the context of Brackets with the new CM) to see if there are any differences. I haven’t really used multiple selections at all in other tools, so I don’t really have an intuitive sense of what users’ expectations are, but I figure if we’re the same as Sublime it’s certainly at least good enough :) (“WWSD?”)