lunr-languages

A a collection of languages stemmers and stopwords for Lunr Javascript library

Lunr Languages

Lunr Languages is a Lunraddon that helps you search in documents written in the following languages:

Lunr Languages is compatible with Lunr version 0.6, 0.7, 1.0and 2.X.

How to use

Lunr-languages works well with script loaders (Webpack, requirejs) and can be used in the browser and on the server.

In a web browser

The following example is for the German language (de).

Add the following JS files to the page:

<script src="lunr.js"></script> <!-- lunr.js library -->
<script src="lunr.stemmer.support.js"></script>
<script src="lunr.de.js"></script> <!-- or any other language you want -->

then, use the language in when initializing lunr:

var idx = lunr(function () {
  // use the language (de)
  this.use(lunr.de);
  // then, the normal lunr index initialization
  this.field('title', { boost: 10 });
  this.field('body');
  // now you can call this.add(...) to add documents written in German
});

That's it. Just add the documents and you're done. When searching, the language stemmer and stopwords list will be the one you used.

In a web browser, with RequireJS

Add require.jsto the page:

<script src="lib/require.js"></script>

then, use the language in when initializing lunr:

require(['lib/lunr.js', '../lunr.stemmer.support.js', '../lunr.de.js'], function(lunr, stemmerSupport, de) {
  // since the stemmerSupport and de add keys on the lunr object, we'll pass it as reference to them
  // in the end, we will only need lunr.
  stemmerSupport(lunr); // adds lunr.stemmerSupport
  de(lunr); // adds lunr.de key

  // at this point, lunr can be used
  var idx = lunr(function () {
  // use the language (de)
  this.use(lunr.de);
  // then, the normal lunr index initialization
  this.field('title', { boost: 10 })
  this.field('body')
  // now you can call this.add(...) to add documents written in German
  });
});
With node.js
var lunr = require('./lib/lunr.js');
require('./lunr.stemmer.support.js')(lunr);
require('./lunr.de.js')(lunr); // or any other language you want

var idx = lunr(function () {
  // use the language (de)
  this.use(lunr.de);
  // then, the normal lunr index initialization
  this.field('title', { boost: 10 })
  this.field('body')
  // now you can call this.add(...) to add documents written in German
});
Indexing multi-language content

If your documents are written in more than one language, you can enable multi-language indexing. This ensures every word is properly trimmed and stemmed, every stopword is removed, and no words are lost (indexing in just one language would remove words from every other one.)

var lunr = require('./lib/lunr.js');
require('./lunr.stemmer.support.js')(lunr);
require('./lunr.ru.js')(lunr);
require('./lunr.multi.js')(lunr);

var idx = lunr(function () {
  // the reason "en" does not appear above is that "en" is built in into lunr js
  this.use(lunr.multiLanguage('en', 'ru'));
  // then, the normal lunr index initialization
  // ...
});

You can combine any number of supported languages this way. The corresponding lunr language scripts must be loaded (English is built in).

If you serialize the index and load it in another script, you'll have to initialize the multi-language support in that script, too, like this:

lunr.multiLanguage('en', 'ru');
var idx = lunr.Index.load(serializedIndex);
How to add a new language

Check the Contributingsection

How does Lunr Languages work?

Searching inside documents is not as straight forward as using indexOf(), since there are many things to consider in order to get quality search results:

  • Tokenization
    • Given a string like *"Hope you like using Lunr Languages!"*, the tokenizer would split it into individual words, becoming an array like ['Hope', 'you', 'like', 'using', 'Lunr', 'Languages!']
    • Though it seems a trivial task for Latin characters (just splitting by the space), it gets more complicated for languages like Japanese. Lunr Languages has this included for the Japanese language.
  • Trimming
    • After tokenization, trimming ensures that the words contain justwhat is needed in them. In our example above, the trimmer would convert Languages!into Languages
    • So, the trimmer basically removes special characters that do not add value for the search purpose.
  • Stemming
    • What happens if our text contains the word consignmentbut we want to search for consigned? It should find it, since its meaning is the same, only the form is different.
    • A stemmer extracts the root of words that can have many forms and stores it in the index. Then, any search is also stemmed and searched in the index.
    • Lunr Languages does stemming for all the included languages, so you can capture all the forms of words in your documents.
  • Stop words
    • There's no point in adding or searching words like the, it, so, etc. These words are called Stop words
    • Stop words are removed so your index will only contain meaningful words.
    • Lunr Languages includes stop words for all the included languages.
Technical details & Credits

I've created this project by compiling and wrapping stemmers toghether with stop words from various sources so they can be directly used with all the current versions of Lunr.

I am providing code in the repository to you under an open source license. Because this is my personal repository, the license you receive to my code is from me and not my employer (Facebook)

Repository

https://github.com/MihaiValentin/lunr-languages


上一篇:记跨越疫情时期的前端面试
下一篇:@dimerapp/utils

相关推荐

  • webpack 使用不同语言进行配置(Configuration Languages)

    webpack 接受以多种编程和数据语言编写的配置文件。支持的文件扩展名列表,可以在 nodeinterpret 包中找到。使用 nodeinterpret,webpack 可以处理许多不同类型的配置...

    2 个月前
  • vscode-languageserver-types

    Types used by the Language server for node VSCode Language Server Types NPM Version(https://img...

    1 年前
  • vscode-languageserver-protocol

    VSCode Language Server Protocol implementation VSCode Language Server Protocol Module NPM Vers...

    1 年前
  • vscode-languageserver

    Language server implementation for node VSCode Language Server NPM Version(https://img.shields....

    1 年前
  • vscode-json-languageservice

    Language service for JSON vscodejsonlanguageservice JSON language service extracted from VSCode to...

    2 个月前
  • videojs-languages

    undefined Table of Contents generated with DocToc(https://github.com/thlorenz/doctoc) videojsl...

    3 个月前
  • monaco-languages

    Bundle of many languages for the Monaco Editor. Monaco Languages Build Status(https://dev.azure.co...

    3 个月前
  • lunr.js

    lunr.js是什么 什么是lunr.js,Simple fulltext search in your browser. lunr.js官网:官网(http://lunrjs.com) l...

    2 年前
  • lunr-results-render

    Render lunr search results in HTML NPM versionnpmimagenpmurl Build Statustravisimagetravisurl Depen...

    7 个月前
  • lunr

    Simple fulltext search in your browser. Lunr.js Join the chat at https://gitter.im/olivernn/lunr....

    2 年前

官方社区

扫码加入 JavaScript 社区