liqe
v3.8.0
Легкий и производительный парсер, сериализатор и поисковая система, подобная Lucene.
Первоначально Liqe был создан для включения фильтрации журналов Roarr через cli. С тех пор я оттачиваю этот проект как хобби/интеллектуальное упражнение. Я видел, как его используют различные CLI и веб-приложения, требующие расширенного поиска. Насколько мне известно, на данный момент это наиболее полный синтаксический анализатор и сериализатор синтаксиса, подобный Lucene, в JavaScript, а также совместимая поисковая система в памяти.
Варианты использования Liqe включают в себя:
Обратите внимание, что Liqe AST рассматривается как общедоступный API, т. е. можно реализовать собственный механизм поиска, использующий язык запросов Liqe (LQL).
import {
filter ,
highlight ,
parse ,
test ,
} from 'liqe' ;
const persons = [
{
height : 180 ,
name : 'John Morton' ,
} ,
{
height : 175 ,
name : 'David Barker' ,
} ,
{
height : 170 ,
name : 'Thomas Castro' ,
} ,
] ;Отфильтруйте коллекцию:
filter ( parse ( 'height:>170' ) , persons ) ;
// [
// {
// height: 180,
// name: 'John Morton',
// },
// {
// height: 175,
// name: 'David Barker',
// },
// ]Протестируйте один объект:
test ( parse ( 'name:John' ) , persons [ 0 ] ) ;
// true
test ( parse ( 'name:David' ) , persons [ 0 ] ) ;
// falseВыделите совпадающие поля и подстроки:
highlight ( parse ( 'name:john' ) , persons [ 0 ] ) ;
// [
// {
// path: 'name',
// query: /(John)/,
// }
// ]
highlight ( parse ( 'height:180' ) , persons [ 0 ] ) ;
// [
// {
// path: 'height',
// }
// ] Liqe использует язык запросов Liqe (LQL), который во многом основан на Lucene, но расширяет его различными способами, что обеспечивает более мощный поиск.
# search for "foo" term anywhere in the document (case insensitive)
foo
# search for "foo" term anywhere in the document (case sensitive)
'foo'
"foo"
# search for "foo" term in `name` field
name :foo
# search for "foo" term in `full name` field
'full name' : foo
"full name" : foo
# search for "foo" term in `first` field, member of `name`, i.e.
# matches {name: {first: 'foo'}}
name . first :foo
# search using regex
name :/foo /
name :/ foo / o
# search using wildcard
name :foo * bar
name :foo? bar
# boolean search
member :true
member :false
# null search
member :null
# search for age =, >, >=, <, <=
height : = 100
height :>100
height :>=100
height :<100
height :<=100
# search for height in range (inclusive, exclusive)
height : [ 100 TO 200 ]
height : { 100 TO 200 }
# boolean operators
name :foo AND height : = 100
name :foo OR name : bar
# unary operators
NOT foo
- foo
NOT foo : bar
- foo :bar
name :foo AND NOT ( bio :bar OR bio : baz )
# implicit AND boolean operator
name :foo height : = 100
# grouping
name :foo AND ( bio :bar OR bio : baz )Найдите слово «foo» в любом поле (без учета регистра).
foo Найдите слово «foo» в поле name .
name :foo Найдите значения поля name , соответствующие регулярному выражению /foo/i .
name :/foo / i Найдите значения поля name , соответствующие шаблону подстановочных знаков f*o .
name :f * o Найдите значения поля name f?o соответствующие шаблону подстановочных знаков.
name :f? o Найдите фразу «foo bar» в поле name (с учетом регистра).
name :"foo bar" Найдите значение, равное 100, в поле height .
height : = 100 Найдите значение больше 100 в поле height .
height :>100 Найдите значение больше или равное 100 в поле height .
height :>=100 Найдите значение больше или равное 100 и меньше или равное 200 в поле height .
height : [ 100 TO 200 ] Найдите значение больше 100 и меньше 200 в поле height .
height : { 100 TO 200 } Найдите в поле name любое слово, начинающееся с «foo».
name :foo * Найдите в поле name любое слово, которое начинается с «foo» и заканчивается на «bar».
name :foo * bar Найдите в поле name любое слово, начинающееся с «foo», за которым следует один произвольный символ.
name :foo? Найдите в поле name любое слово, которое начинается с «foo», за которым следует один произвольный символ и сразу заканчивается на «bar».
name :foo? bar Найдите фразу «foo bar» в поле name И фразу «quick fox» в поле bio .
name :"foo bar" AND bio : "quick fox" Найдите фразу «foo bar» в поле name И фразу «quick fox» в поле bio или слово «fox» в поле name .
( name :"foo bar" AND bio : "quick fox" ) OR name : fox Сериализатор позволяет конвертировать токены Liqe обратно в исходный поисковый запрос.
import {
parse ,
serialize ,
} from 'liqe' ;
const tokens = parse ( 'foo:bar' ) ;
// {
// expression: {
// location: {
// start: 4,
// },
// quoted: false,
// type: 'LiteralExpression',
// value: 'bar',
// },
// field: {
// location: {
// start: 0,
// },
// name: 'foo',
// path: ['foo'],
// quoted: false,
// type: 'Field',
// },
// location: {
// start: 0,
// },
// operator: {
// location: {
// start: 3,
// },
// operator: ':',
// type: 'ComparisonOperator',
// },
// type: 'Tag',
// }
serialize ( tokens ) ;
// 'foo:bar' import {
type BooleanOperatorToken ,
type ComparisonOperatorToken ,
type EmptyExpression ,
type FieldToken ,
type ImplicitBooleanOperatorToken ,
type ImplicitFieldToken ,
type LiteralExpressionToken ,
type LogicalExpressionToken ,
type RangeExpressionToken ,
type RegexExpressionToken ,
type TagToken ,
type UnaryOperatorToken ,
} from 'liqe' ;Существует 11 токенов AST, которые описывают анализируемый запрос Liqe.
Если вы создаете сериализатор, вам необходимо реализовать их все для полного охвата всех возможных входных данных запроса. Обратитесь к встроенному сериализатору для примера.
import {
isSafeUnquotedExpression ,
} from 'liqe' ;
/**
* Determines if an expression requires quotes.
* Use this if you need to programmatically manipulate the AST
* before using a serializer to convert the query back to text.
*/
isSafeUnquotedExpression ( expression : string ) : boolean ; Следующие способности Lucene не поддерживаются:
В случае синтаксической ошибки Liqe выдает SyntaxError .
import {
parse ,
SyntaxError ,
} from 'liqe' ;
try {
parse ( 'foo bar' ) ;
} catch ( error ) {
if ( error instanceof SyntaxError ) {
console . error ( {
// Syntax error at line 1 column 5
message : error . message ,
// 4
offset : error . offset ,
// 1
offset : error . line ,
// 5
offset : error . column ,
} ) ;
} else {
throw error ;
}
} Рассмотрите возможность использования пакета highlight-words чтобы выделить совпадения с Liqe.
Если вы собираетесь изменить парсер, используйте npm run watch для запуска компилятора в режиме просмотра.
Прежде чем вносить какие-либо изменения, запишите текущий тест на вашем компьютере с помощью npm run benchmark . После внесения каких-либо изменений запустите тест еще раз. Прежде чем вносить изменения, убедитесь, что это не повлияет негативно на производительность.
