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

local-module

v1.0.2

Published

Load local modules as global.

Downloads

15

Readme

local-lib

Node.js require your local module files/modules easily from anywhere in your project without having to navigate directories.

Problem

	var db = require('../../../../lib/some-module');

Solution

    // do this just one time in the root file (i.e. index.js)
	require('local-module')('lib', 'utils');
	
	// then in any other file just do it.
	var lib = require('localModule');
	// them all your local modules inside in this diretories ('lib' or 'utils')
	// is avaliable in the following way
	var someModule = lib.some_module

Installation

npm install local-module --save

Usage

  1. in the root file of your projecy require 'local-module' given a directory or a list of directories as parameters, and all your modules inside this diretories will be loaded.
  2. then access your library easily using i.e require('local-module').myModule

Library folders should contain an index.js to export your library, or a package.json file with a main directive to point to your main file.

Example

project structure

project root
├── lib
│   ├── driver
│   │   └── index.js
│   └── db.js
└── app.js
another-project
├── lib
│   ├── utils
│   │   └── index.js
└── index.js

app.js

	const lib   = require('local-module')('lib', '../another-project/lib'),
	      db    = require('./lib/db'),
	      utils = lib.utils;

or

    require('local-module')('lib', '../another-project/lib');
    
	const db    = require('./lib/db'),
	      utils = require('local-module').utils;

./lib/db.js

	const lib       = require('local-module'),
	      driver    = lib.driver,
	      utils     = lib.utils;

or

	const driver    = require('local-lib').db,
	      utils     = require('local-lib').utils;