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

@itrocks/prepare-module

v0.0.17

Published

Prepare your front-end module with @itrocks dependencies for npm publishing

Downloads

367

Readme

npm version npm downloads GitHub issues discord

prepare-module

Prepare your front-end module with dependencies for npm publishing.

Pre-requisites

  • Your project is a library you intend to publish on npm,
  • your project contains front-end ESM scripts in a src subfolder,
  • your transpiler generates transpiled .js and .d.ts files into src,
  • you want to import ... from '@itrocks/something' without TypeScript errors.

Installation

Install @itrocks/prepare-module as a development dependency:

npm i @itrocks/prepare-module --save-dev

Usage

In your project, install the required dependency and import the necessary front-end script with a relative path:

import { SortedArrayBy } from '../node_modules/@itrocks/sorted-array/sorted-array.js'

Then, add the following to your packages.json file:

{
	"scripts": {
		"prepare": "prepare-module"
	}
}

How It Works

When your publish your package using npm publish, prepare-module will handle the following tasks:

  • Copies your js script and .d.ts files from src to your project root directory,
  • Updates the import paths in your script to relative imports within node_modules, as shown below.

If your project is published under the same namespace as the dependency:

import { SortedArrayBy } from '../sorted-array/sorted-array.js'

If published under a different namespace:

import { SortedArrayBy } from '../../@itrocks/sorted-array/sorted-array.js'

If published without a namespace:

import { SortedArrayBy } from '../@itrocks/sorted-array/sorted-array.js'

Deployment

When coding with TypeScript, avoid deploying files in src/*.js: the scripts in your project root directory are the final ones to be used.

See a complete use case in the @itrocks/build library.