带有拼写检查器的CodeMirror

时间:2012-09-09 23:47:29

标签: javascript textarea codemirror

我想使用CodeMirror的功能(例如,亚麻,包装,搜索等)用于纯文本,而不需要代码突出显示,而是使用谷歌Chrome拼写检查或其他一些自然语言(特别是英语)激活拼写检查(我不需要让它在其他浏览器上工作)。我怎样才能做到这一点?是否可以编写一个支持拼写检查的纯文本模式加载项?

6 个答案:

答案 0 :(得分:27)

我在编码typo.js时实际上将CodeMirrorNoTex.ch进行了整合;你可以在这里查看CodeMirror.rest.js;我需要一种方法来检查 reStructuredText 标记拼写,因为我使用了CodeMirror优秀的语法高亮功能,所以很容易做到。

您可以在提供的链接中查看代码,但我会总结一下,我做了什么:

  1. 初始化typo.js库;另见作者的博客/文档:

    var typo = new Typo ("en_US", AFF_DATA, DIC_DATA, {
        platform: 'any'
    });
    
  2. 为单词分隔符定义正则表达式:

    var rx_word = "!\"#$%&()*+,-./:;<=>?@[\\\\\\]^_`{|}~";
    
  3. 为CodeMirror定义覆盖模式:

    CodeMirror.defineMode ("myoverlay", function (config, parserConfig) {
        var overlay = {
            token: function (stream, state) {
    
                if (stream.match (rx_word) &&
                    typo && !typo.check (stream.current ()))
    
                    return "spell-error"; //CSS class: cm-spell-error
    
                while (stream.next () != null) {
                    if (stream.match (rx_word, false)) return null;
                }
    
                return null;
            }
        };
    
        var mode = CodeMirror.getMode (
            config, parserConfig.backdrop || "text/x-myoverlay"
        );
    
        return CodeMirror.overlayMode (mode, overlay);
    });
    
  4. 将覆盖与CodeMirror一起使用;请参阅用户手册以了解您的具体操作方式。我已经在我的代码中完成了它,所以你也可以在那里查看它,但我推荐用户手册。

  5. 定义CSS类:

    .CodeMirror .cm-spell-error {
         background: url(images/red-wavy-underline.gif) bottom repeat-x;
    }
    
  6. 这种方法适用于德语,英语和西班牙语。随着法语词典 typo.js 似乎有一些(重音)问题,以及像希伯来语,匈牙利语和意大利语这样的语言 - 其中词缀的数量很长或词典相当广泛 - 它没有真的,因为当前实现的 typo.js 使用了太多的内存而且速度太慢。

    使用德语(和西班牙语) typo.js 可以阻止JavaScript VM几百毫秒(但仅限于初始化期间!),因此您可能需要考虑HTML5 Web工作者的后台线程(有关示例,请参阅 CodeMirror.typo.worker.js 。进一步 typo.js 似乎不支持Unicode(由于JavaScript的限制):至少,我没有设法使用非拉丁语言,如俄语,希腊语,印地语等。< / p>

    除了(现在非常大)NoTex.ch之外,我没有将所描述的解决方案重构为一个漂亮的独立项目,但我可能很快就会这样做;在此之前,您需要根据上述说明或暗示代码修补自己的解决方案。我希望这会有所帮助。

答案 1 :(得分:3)

这是hsk81答案的工作版本。它使用CodeMirror的覆盖模式,并查找引号,html标签等内的任何单词。它有一个样本typo.check,应该用Typo.js之类的东西替换。它用红色波浪线强调未知单词。

使用IPython的%% html单元测试。

<style>
.CodeMirror .cm-spell-error {
     background: url("https://raw.githubusercontent.com/jwulf/typojs-project/master/public/images/red-wavy-underline.gif") bottom repeat-x;
}
</style>

<h2>Overlay Parser Demo</h2>
<form><textarea id="code" name="code">
</textarea></form>

<script>
var typo = { check: function(current) {
                var dictionary = {"apple": 1, "banana":1, "can't":1, "this":1, "that":1, "the":1};
                return current.toLowerCase() in dictionary;
            }
}

CodeMirror.defineMode("spell-check", function(config, parserConfig) {
    var rx_word = new RegExp("[^\!\"\#\$\%\&\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~\ ]");
    var spellOverlay = {
        token: function (stream, state) {
          var ch;
          if (stream.match(rx_word)) { 
            while ((ch = stream.peek()) != null) {
                  if (!ch.match(rx_word)) {
                    break;
                  }
                  stream.next();
            }
            if (!typo.check(stream.current()))
                return "spell-error";
            return null;
          }
          while (stream.next() != null && !stream.match(rx_word, false)) {}
          return null;
        }
    };

  return CodeMirror.overlayMode(CodeMirror.getMode(config, parserConfig.backdrop || "text/html"), spellOverlay);
});

var editor = CodeMirror.fromTextArea(document.getElementById("code"), {mode: "spell-check"});
</script>

答案 2 :(得分:1)

CodeMirror不基于HTML textarea,因此您can't use the built-in spell check

你可以用typo.js

之类的东西对CodeMirror进行自己的拼写检查

我认为还没有人这样做过。

答案 3 :(得分:1)

我刚才写了一个波浪形的下划线拼写检查器。它需要重写,说实话我是JavaScript的新手。但原则就在那里。

https://github.com/jameswestgate/SpellAsYouType

答案 4 :(得分:1)

我创建了一个带有错别字建议/更正的拼写检查程序:

https://gist.github.com/kofifus/4b2f79cadc871a29439d919692099406

演示:https://plnkr.co/edit/0y1wCHXx3k3mZaHFOpHT

以下是代码的相关部分:

首先,我承诺加载字典。我使用typo.js作为字典,加载可能需要一段时间,如果它们不是本地托管的,所以最好在登录/ CM初始化之后立即启动加载等:

function loadTypo() {
    // hosting the dicts on your local domain will give much faster results
    const affDict='https://rawgit.com/ropensci/hunspell/master/inst/dict/en_US.aff';
    const dicDict='https://rawgit.com/ropensci/hunspell/master/inst/dict/en_US.dic';

    return new Promise(function(resolve, reject) {
        var xhr_aff = new XMLHttpRequest();
        xhr_aff.open('GET', affDict, true);
        xhr_aff.onload = function() {
            if (xhr_aff.readyState === 4 && xhr_aff.status === 200) {
                //console.log('aff loaded');
                var xhr_dic = new XMLHttpRequest();
                xhr_dic.open('GET', dicDict, true);
                xhr_dic.onload = function() {
                    if (xhr_dic.readyState === 4 && xhr_dic.status === 200) {
                        //console.log('dic loaded');
                        resolve(new Typo('en_US', xhr_aff.responseText, xhr_dic.responseText, { platform: 'any' }));
                    } else {
                        console.log('failed loading aff');
                        reject();
                    }
                };
                //console.log('loading dic');
                xhr_dic.send(null);
            } else {
                console.log('failed loading aff');
                reject();
            }
        };
        //console.log('loading aff');
        xhr_aff.send(null);
    });
}

其次我添加了一个叠加来检测和标记拼写错误:

cm.spellcheckOverlay={
    token: function(stream) {
        var ch = stream.peek();
        var word = "";

        if (rx_word.includes(ch) || ch==='\uE000' || ch==='\uE001') {
            stream.next();
            return null;
        }

        while ((ch = stream.peek()) && !rx_word.includes(ch)) {
            word += ch;
            stream.next();
        }

        if (! /[a-z]/i.test(word)) return null; // no letters
        if (startSpellCheck.ignoreDict[word]) return null;
        if (!typo.check(word)) return "spell-error"; // CSS class: cm-spell-error
    }
}
cm.addOverlay(cm.spellcheckOverlay);

第三,我使用列表框来显示建议并修复拼写错误:

function getSuggestionBox(typo) {
    function sboxShow(cm, sbox, items, x, y) {
        let selwidget=sbox.children[0];

        let options='';
        if (items==='hourglass') {
            options='<option>&#8987;</option>'; // hourglass
        } else {
            items.forEach(s => options += '<option value="' + s + '">' + s + '</option>');
            options+='<option value="##ignoreall##">ignore&nbsp;all</option>';
        }
        selwidget.innerHTML=options;
        selwidget.disabled=(items==='hourglass');
        selwidget.size = selwidget.length;
        selwidget.value=-1;

        // position widget inside cm
        let cmrect=cm.getWrapperElement().getBoundingClientRect();
        sbox.style.left=x+'px';  
        sbox.style.top=(y-sbox.offsetHeight/2)+'px'; 
        let widgetRect = sbox.getBoundingClientRect();
        if (widgetRect.top<cmrect.top) sbox.style.top=(cmrect.top+2)+'px';
        if (widgetRect.right>cmrect.right) sbox.style.left=(cmrect.right-widgetRect.width-2)+'px';
        if (widgetRect.bottom>cmrect.bottom) sbox.style.top=(cmrect.bottom-widgetRect.height-2)+'px';
    }

    function sboxHide(sbox) {
        sbox.style.top=sbox.style.left='-1000px';  
    }

    // create suggestions widget
    let sbox=document.getElementById('suggestBox');
    if (!sbox) {
        sbox=document.createElement('div');
        sbox.style.zIndex=100000;
        sbox.id='suggestBox';
        sbox.style.position='fixed';
        sboxHide(sbox);

        let selwidget=document.createElement('select');
        selwidget.multiple='yes';
        sbox.appendChild(selwidget);

        sbox.suggest=((cm, e) => { // e is the event from cm contextmenu event
            if (!e.target.classList.contains('cm-spell-error')) return false; // not on typo

            let token=e.target.innerText;
            if (!token) return false; // sanity

            // save cm instance, token, token coordinates in sbox
            sbox.codeMirror=cm;
            sbox.token=token;
            let tokenRect = e.target.getBoundingClientRect();
            let start=cm.coordsChar({left: tokenRect.left+1, top: tokenRect.top+1});
            let end=cm.coordsChar({left: tokenRect.right-1, top: tokenRect.top+1});
            sbox.cmpos={ line: start.line, start: start.ch, end: end.ch};

            // show hourglass
            sboxShow(cm, sbox, 'hourglass', e.pageX, e.pageY);

            // let  the ui refresh with the hourglass & show suggestions
            setTimeout(() => { 
                sboxShow(cm, sbox, typo.suggest(token), e.pageX, e.pageY); // typo.suggest takes a while
            }, 100);

            e.preventDefault();
            return false;
        });

        sbox.onmouseleave=(e => { 
            sboxHide(sbox)
        });

        selwidget.onchange=(e => {
            sboxHide(sbox)
            let cm=sbox.codeMirror, correction=e.target.value;
            if (correction=='##ignoreall##') {
                startSpellCheck.ignoreDict[sbox.token]=true;
                cm.setOption('maxHighlightLength', (--cm.options.maxHighlightLength) +1); // ugly hack to rerun overlays
            } else {
                cm.replaceRange(correction, { line: sbox.cmpos.line, ch: sbox.cmpos.start}, { line: sbox.cmpos.line, ch: sbox.cmpos.end});
                cm.focus();
                cm.setCursor({line: sbox.cmpos.line, ch: sbox.cmpos.start+correction.length});
            }
        });

        document.body.appendChild(sbox);
    }

    return sbox;
}

希望这有帮助!

答案 5 :(得分:1)

在 CodeMirror 5.18.0 及更高版本中,您可以将 inputStyle: 'contenteditable' 设置为 spellcheck: true,以便能够使用网络浏览器的拼写检查功能。例如:

var myTextArea = document.getElementById('my-text-area');
var editor = CodeMirror.fromTextArea(myTextArea, {
    inputStyle: 'contenteditable',
    spellcheck: true,
});

使此解决方案成为可能的相关提交是: