search-context v0.1.0

search-context

Show where a query matches a document.

example

var context = require('search-context')
var fs = require('fs')
var README = fs.readFileSync(__dirname + '/README.md', 'utf-8')

function hi (string) {
  return '***'+string.toUpperCase()+'***'
}

console.log(
  context(README, ['query', 'document', 'search'], 80, hi)
)

hi is an optional function that marks the matched string. By default it applies bold ansi escape to display in the terminal.

output

search-context finds the tightest occurance of the terms in the query. If the terms are far apart, the context around each term is displayed with ... joining them.

License

MIT