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-path

v1.0.15

Published

This package will allow users to require your package without writing dist/src

Downloads

1,013

Readme

import-path

Intro

This package helps creating a nicer API for your require paths.

If for example your dist folder is being published in your packge, usually users will try to require it by using the full path:

import {importantFunction} from 'my-package/dist/src/importantFunction';

This is where this package comes in to play, as it allows you to have:

import {importantFunction} from 'my-package/importantFunction';

Usage

Install the package

npm i --save-dev import-path

Add the following to your build command in the package.json:

 "scripts": {
    "build": "haste build && import-path --path <desired-path>",
    ...

Note that haste is the build tool which is being used in this example, but ofcourse it is not mandatory.

<desiredPath> is the path you wish to change the require from. For example:

import-path --path src/importantFunction

Will allow users to do:

import {importantFunction} from 'my-package/importantFunction';

If you wish your require path (entry point) name format to be pascal cased, like seen here :

import {importantFunction} from 'my-package/dist/src/ImportantFunction';

pass to the importPath function, a third aregumes : {componentNameFormat: true} (defaulted as false).

Typescript definitions can also be generated using the --dts option:

 import-path --path <desired-path> --dts",

or, you can choose to pass as a second boolean argument to the importPath function

 importPath('src/components', true);

This will create a .d.ts for every generated .js file. Note that the .d.ts files only support named exports and do not support export default... and exports = ....

On every build we scan for all the files under 'my-package/dist/src/importantFunction' which contain index.js file inside of them, and for each file we create the following file under the root dir:

// importantFunction.js

module.exports = require('./dist/src/importantFunction');

There is no need to push them to Github, so add this to the .gitignore file:

/*.js
/*.d.ts // if you use the dts option
!wallaby.js
!protractor.conf.js

If you have more *.js files under the root dir that you don't want to ignore, add them with prefix !.

The last thing you need to do is to publish all of the new generated files:

// package.json

"files": [
    "dist",
    "*.js",
    '*.d.ts', // if you use the dts option
    "!wallaby.js",
    "!protractor.conf.js"
  ],

You can use npm pack to see what are you going to publish to the npm registry.