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

@awalgawe/esbuild-typescript-paths-plugin

v1.0.1

Published

A plugin for esbuild that resolves TypeScript path aliases during the build process.

Downloads

12

Readme

@awalgawe/esbuild-typescript-paths-plugin

A plugin for esbuild that resolves TypeScript path aliases during the build process.

Installation

You can install the plugin using npm or yarn:

npm install --save-dev @awalgawe/esbuild-typescript-paths-plugin

or

yarn add --dev @awalgawe/esbuild-typescript-paths-plugin

Usage

To use the TypeScript Paths Plugin, you need to import it and add it to your esbuild plugins list. Here's an example of how you can set it up:

import { build } from 'esbuild';
import { tsPathsPlugin } from '@awalgawe/esbuild-typescript-paths-plugin';

build({
  entryPoints: ['src/main.ts'],
  bundle: true,
  outfile: 'dist/bundle.js',
  plugins: [tsPathsPlugin()],
  tsconfig: './path/to/your/tsconfig.json', // Optional: Path to your TypeScript configuration file.
  absWorkingDir: __dirname, // Optional: Absolute working directory for resolving paths.
}).catch(() => process.exit(1));

or without bundling:

import { build } from 'esbuild';
import { tsPathsPlugin } from '@awalgawe/esbuild-typescript-paths-plugin';

build({
  entryPoints: ['src/**/*.ts'],
  outdir: 'dist',
  plugins: [tsPathsPlugin()],
  tsconfig: './path/to/your/tsconfig.json', // Optional: Path to your TypeScript configuration file.
  absWorkingDir: __dirname, // Optional: Absolute working directory for resolving paths.
}).catch(() => process.exit(1));

Make sure you have a valid tsconfig.json file with the required path mappings in your project root.

{
  "compilerOptions": {
    // ...
    "baseUrl": ".",
    "paths": {
      "#app/*": ["src/*"]
    }
  }
}

How It Works

The plugin works by intercepting the import statements in your TypeScript files and resolving the path aliases defined in your tsconfig.json file. It uses the TypeScript compiler API to parse and resolve the import paths. If an alias is found, it replaces the import path with the actual resolved path during the build process.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

This plugin is inspired by the need to handle TypeScript path aliases in projects built with esbuild.

Contributing

Contributions are welcome! If you find a bug or want to add a new feature, feel free to open an issue or submit a pull request.

Alternatives