Nanoscale Parts Manufacturing

    qnm

    1.8.1 • Public • Published

    qnm-logo

    🔍 A simple cli utility for querying the node_modules directory

    Build Status NPM version License

    fuzzy-search

    Why?

    most bugs are caused by the assumptions we didn't realize we were making.

    When debugging a problem, I sometimes find myself checking what are the installed versions of the modules within node_modules directory. Current solutions like running npm list are not fast enough and prints too much clutter, checking the version in the package.json takes a bit more effort and doesn't give you more information regarding other occurrences of this module.

    qnm aims to get this information fast and tries to filter only the important parts, while supporting both yarn & npm.

    Features

    • 💬 Tab completions
    • Interactive fuzzy-search
    • 🔤 Match all packages with a specific string
    • ⁉️ Explain why a package was installed
    • 📚 Supports monorepos

    Installation

    npm i --global qnm

    Usage

    qnm [module]

    For example, if you want to see the installed versions of lodash:

    qnm lodash

    And you'll see something like that:

    lodash
    ├── 4.17.5
    ├─┬ cli-table2
    │ └── 3.10.1
    └─┬ karma
      └── 3.10.1

    Which means you have 3 occurrences of lodash in your node_modules:

    1. ./node_module/lodash
    2. ./node_module/cli-table2/node_modules/lodash
    3. ./node_module/karma/node_modules/lodash

    Fuzzy-search

    Use qnm command without arguments to trigger an fzf like fuzzy search.

    • Start typing to filter the matches from your node_modules
    • Use arrows to move cursor up and down
    • Enter key to select the item, CTRL-C / ESC to exit
    • TAB and Shift-TAB to mark multiple items

    Options

    -o , --open

    Open the module's package.json file with the default editor.

    -d, --debug

    See full error messages, mostly for debugging.

    --disable-colors

    Disables the most of colors and styling. E.g. version colors.

    Commands

    list

    alias: ls

    Returns a list of all modules in node_modules directory.

    qnm list
    Optional arguments Description
    --deps List the versions of direct dependencies and devDependencies.

    match

    Works like grep, and match's any module that includes the supplied string.

    For example, i want to see which eslint plugins i have installed:

    > qnm match eslint-plug
    
    eslint-plugin-babel
    └── 3.3.0
    
    eslint-plugin-lodash
    └── 2.6.1
    
    eslint-plugin-mocha
    └── 4.12.1
    
    eslint-plugin-react
    └── 6.10.3

    homepage

    Opens package "homepage" property in your browser.

    install-completions

    Run to install tab completions using tabtab (Setup only once)

    Contributing

    Help is always welcome! Please head to the CONTRIBUTING.md file to see how to get started.

    License

    The MIT License

    Install

    npm i qnm

    DownloadsWeekly Downloads

    49

    Version

    1.8.1

    License

    MIT

    Unpacked Size

    12.7 MB

    Total Files

    2414

    Last publish

    Collaborators

    • avatar