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

magic-require

v0.1.2

Published

Usually module availability could be checked using native `require` method.

Downloads

7

Readme

The problem

Usually module availability could be checked using native require method.

const isExists = false;

try {
  require.resolve('angular')
  isExists = true;
} catch (e) {
    
}

But here is problem: I don't want to write try catch statements :)

OK. The real problem appears when developing component with auto requiring modules. require and require.resolve will work correctly until component is in local node_modules. After npm link (that is very useful while developing npm packages) or if components is installed as global package - require and require.resolve will work from global context (at *nix systems /usr/local/lib/node_modules).

For example: I am developing build / server like webpack. And there are loaders (babel-loader, html-loader, json-loader etc). And I want my builder to require loader automatically when it is needed. So my node_modules should be as below:

/my-work-directory/node_modules
                         |-builder/
                         |-babel-loader/
                         |-html-loader/
                         |-json-loader/
     

In this case if I run require('babe-loader') at builder component - it will work. But If I npm link my build (for better developing process) or make in global - my node_modules will be as below:

/usr/local/lib/node_modules
                        |-builder/
    

/my-work-directory/node_modules
                         |-(linked directory) builder/
                         |-babel-loader/
                         |-html-loader/
                         |-json-loader/

And in this case if I run require('babe-loader') at builder - will be exception Error: Cannot find module 'babel-loader'. This happens because require depends on __dirname that equals /usr/local/lib/node_modules/builder at builder component. Here is documentation how modules are loading from node_modules folder

Solution

npm install --save magic-require

First resolve modules according to caller module __dirname and if not resolved - try to resolve according to current process.cwd(). 100% supports package.json if loads module as directory.

Examples

import magic from 'magic-require';


magic.isExists('babel-loader'); // true
magic.isExists('expose-loader'); // false

magic.resolve('babel-loader'); // ../../../.. /my-work-directory/node_modules/babe-loader/index.js

const BabelLoader = magic('babel-laoder');

Available methods

  • isExists(module) - returns true if module exists and false - if not.
  • resolve(module) - returns relative path to requested module from current executing module's __dirname or null.

Community

You are always welcome for ideas and pull requests :)