The format-fuse.js from metonym

format-fuse.js's People

Contributors

Stargazers

Watchers

Forkers

chmac

format-fuse.js's Issues

Seems to break on an array of strings

Slightly modifying the example from the readme like so:

const results = format([
  {
    item: {
      titles: ["Monster 1959", "Second Title"],
      author: { firstName: "David", lastName: "Maine" },
    },
    matches: [
      {
        indices: [[1, 2]],
        value: "Monster 1959",
        key: "title",
        arrayIndex: 0,
      },
    ],
  },
]);

I think the code doesn't follow the refIndex property from fuse on title.

When using Fuse's useExtendedSearch, format-fuse can return overlapping matches

Performing a Fuse extended search for 'sao paulo' on an item that contains the text 'SAO PAULO' yields matches for [ [ 0, 2 ], [ 1, 2 ], [ 4, 8 ] ], and format-fuse returns them as SAO, AO an PAULO. Rendering those as shown in the readme causes the UI to show "SAOAO PAULO". Ideally, the resulting value would eliminate overlapping matches.

Example:

const Fuse = require('fuse.js');
const formatFuseJs = require('format-fuse.js').default;
const util = require('util');

const r = new Fuse([{ name: 'SAO PAULO' }], {
    keys: ['name'],
    includeMatches: true,
    includeScore: true,
    useExtendedSearch: true,
})
    .search('sao paulo')
    .map(s => ({ ...s, formatted: formatFuseJs([s])[0] }));

console.log(util.inspect(r, { showHidden: false, depth: null, colors: true }));

Actual:

[
  {
    item: { name: 'SAO PAULO' },
    refIndex: 0,
    matches: [
      {
        indices: [ [ 0, 2 ], [ 1, 2 ], [ 4, 8 ] ],
        value: 'SAO PAULO',
        key: 'name'
      }
    ],
    score: 0.06403390388180329,
    formatted: {
      name: [
        { text: 'SAO', matches: true },
        { text: 'AO', matches: true },
        { text: ' ', matches: false },
        { text: 'PAULO', matches: true }
      ]
    }
  }
]

Expected:

[
  {
    item: { name: 'SAO PAULO' },
    refIndex: 0,
    matches: [
      {
        indices: [ [ 0, 2 ], [ 1, 2 ], [ 4, 8 ] ],
        value: 'SAO PAULO',
        key: 'name'
      }
    ],
    score: 0.06403390388180329,
    formatted: {
      name: [
        { text: 'SAO', matches: true },
        { text: ' ', matches: false },
        { text: 'PAULO', matches: true }
      ]
    }
  }
]