npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

micromys

v1.0.0

Published

Helper for IDE-like search widgets implementations

Downloads

12

Readme

Micromys

A tiny tool that helps to find strings in pre-defined dictionary by user input. It uses algorithm similar to one that IDEs use when user looks for a file by some parts of the file's name. For example, it finds string aTinyTool when input is att.

Installation

yarn add micromys or npm install micromys

Usage

Basic

import { createSearchFunction } from 'micromys';

const search = createSearchFunction(['myFavoriteFile', 'i_love_underscores']);

const searchResults = search('ilo');
console.log(searchResults); 
// [{ 
//   sentence: 'i_love_underscores', 
//   highlights: [
//     { start: 0, end: 0 },
//     { start: 2, end: 3 },
//   ], 
// }]

Advanced

You can think of this module as of a constructor. Feel free to import any parts of micromys and to build something new from them. You can start from createSearchFunction.js - the place that wires all the sub parts. For example, you can provide your own custom isLetter function in order to add support for languages with non-latin alphabets.

Highlighting

In order to simplify highlighting implementation there is highlightSentence function.

import { highlightSentence } from 'micromys/src/highlightSentence';

const highlighted = highlightSentence({ 
  sentence: 'some words',
  highlights: [{ start: 0, end: 3 }],
  highlight: (text) => `<b>${text}</b>`,
}).join('');

console.log(highlighted); // '<b>some</b> words'

CommonJS support

If you need to require instead of import, use require('micromys/cjs');

Limitations

By default micromys supports only latin alphabet. If you need more, see Advanced section above.