![New axobject-query Maintainer Faces Backlash Over Controversial Decision to Support Legacy Node.js Versions](https://cdn.sanity.io/images/cgdhsj6q/production/86e6ebdea652d20da070ebbda20134b839972db7-1024x1024.webp?w=800&fit=max&auto=format)
Security News
New axobject-query Maintainer Faces Backlash Over Controversial Decision to Support Legacy Node.js Versions
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
@arso-project/sonar-tantivy
Advanced tools
Readme
A tantivy based search engine for Node.js
const IndexCatalog = require('@arso-project/sonar-tantivy')
(async function () {
const catalog = new IndexCatalog ('./data')
const schema = getSchema()
const index = await catalog.openOrCreate('index-name', schema)
const docs = getDocs()
await index.add(docs)
const results = await index.query('world')
console.log('query results', results)
})()
function getDocs () {
return [
{ id: '0', title: 'Hello world!', body: 'tell me more' },
{ id: '1', title: 'Ola mundo!', body: 'que pasa pues' }
]
}
function getSchema () {
return [
{
name: 'title',
type: 'text',
options: {
indexing: { record: 'position', tokenizer: 'en_stem' },
stored: true
}
},
{
name: 'body',
type: 'text',
options: {
indexing: { record: 'position', tokenizer: 'en_stem' },
stored: true
}
},
{
name: 'id',
type: 'text',
options: { indexing: null, stored: true }
},
]
}
npm install @arso-project/sonar-tantivy
A postinstall
script automatically tries to download a precompiled binary for the rust/tantivy part. If unsuccessfull the script will try to compile it if a rust toolchain is present.
const IndexCatalog = require('@arso-project/sonar-tantivy')
const catalog = new IndexCatalog(storage)
storage
is a file system path where the index will be stored.
const index = await catalog.openOrCreate(indexName, schema)
indexName
is a string to identifiy the index. It should only contain characters valid in file system paths.
schema
is the index schema, expressed as a JSON-serializable object following the tantivy schema definition. Documentation is not centralized atm, see example above.
const index = await catalog.create(indexName, schema, opts)
Create an index. Will throw if an index by this indexName
exists already.
opts
are:
ram
: If true create an in-memory indexawait index.add(docs)
docs
is an array of documents with the same structure as the index schema.
const results = await index.query(query, [limit], [snippetField])
Query the index. At the moment only string queries are supported, see tantivy docs for details on the supported grammar. limit
is the max number of documents to return (default 10). snippetField
is the name of a field for which to return a result snippet with keywords highlighted (as HTML, with <b>
tags)
const results = await catalog.multiQuery(query, indexes)
Query all indexes in the catalog. indexes
is an array of index names.
To be expanded
The rust part is a wrapper around tantivy. It compiles to a binary. The binary is invoked with a storage path as only argument. It listens for newline-delimited JSON messages on STDIN, and replies in the same format.
The node part spawns the rust binary and communicates over the STDIO pipe. It adds a higher-level API around this simple RPC mechanism.
A npm postinstall
step will try to download a precompiled binary of the rust part from Github releases. The binaries are compiled and deployed via Travis. If it cannot find a matching binary, it will try to compile if a rust toolchain is available. If the environment variable RUST_ENV=development
is present, cargo run
(without --release
) will be invoked instead.
FAQs
A tantivy search engine
The npm package @arso-project/sonar-tantivy receives a total of 0 weekly downloads. As such, @arso-project/sonar-tantivy popularity was classified as not popular.
We found that @arso-project/sonar-tantivy demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.