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

import-paths

v0.1.1

Published

Make your local imports and requires relatively absolute!

Downloads

2

Readme

import-paths

NPM Version Build Status Documentation Status Built with GNU Make

Make your local imports and requires relatively absolute!

Description

WARNING This package modifies the global require() function. Do not use this if you do not completely control your execution environment (ie. don't use this when writing a library for 3rd parties etc.).

This package allows you to resolve your local project modules by using a pre-configured prefix when you require() them, instead of having to use relative paths to that module from wherever you are.

Instead of

const User = require('./api/models/user')

You can now write

const User = require('api:models/user')

Now, the path to the User model will be always the same, no matter where you require it (as long as the User model does not change its location, that is!).

Usage

Require this module at the soonest opportunity in your application's lifecycle, most likely in an app.js, server.js or index.js files and call it with an object which contains keys as the prefixes you would like to register and the keys' values being the absolute paths where those require calls should be directed to. The paths can also be arrays - in that case, they will be path.join()ed for you.

require('import-paths')({
  api: [__dirname, 'api'],
  'api:controller': [__dirname, 'api' 'controllers'],
  'api:model': [__dirname, 'api' 'models'],
})

Now, if you require('api:model:user'), the actual model's path with be resolved to something like /users/me/project-root/api/models/user.

You can register as many prefixes as you like. Generally I would suggest using some kind of common pattern, so that it's obvious to everyone what is actually being required.

Other require statements which do not contain a colon (:) will be unmodified and will work as usual. You can even keep using relative paths if you are so inclined, but then... what's the point of using this library? 😀

License

This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.