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

esbuild-svelte-paths

v0.1.4

Published

ESBuild Plugin that resolves shortcuted pathes for Svelte components

Downloads

11

Readme

esbuild-svelte-paths

ESBuild Plugin that resolves shortcuted pathes for Svelte components.

Why you need this plugin?

When you developing a web-app using Svelte you must import components using full path of each file including long file extension .svelte. When your application grows you create subdirectories with components to group them by application area.

import Button from './Button.svelte';
import Dashboard from './Dashboard/Dashboard.svelte';

With esbuild-svelte-paths plugin you can do imports much easier:

import Button from './Button'; // just component's path without '.svelte'
import Dashboard from './Dashboard'; // folder and file inside have same names

How it works?

Main rule for plugin – last part of the path must starts with capital letter. Then plugin resolves fullpath for Svelte component and checks if it is existed.

When file and file inside directory are both matched with shortcut – the path to the file in the directory be returned.

Plugin respects path aliases from tsconfig.json or jsconfig.json.

Getting started

Install from npm:

npm i -D esbuild-svelte-paths

Then add to your esbuild script BEFORE any Svelte compiler plugin:

const {sveltePaths} = require('esbuild-svelte-paths');
const sveltePlugin = require('esbuild-any-svelte-plugin');

esbuild.build({
    ...
    plugins:[
        sveltePaths(),
        sveltePlugin()
    ]
})

Configuration

You can pass a configuration object to plugin function as argument. At the moment it have only one option - extension, which default value is svelte. This option define files of what type should be searched by plugin.

You can set different file extension to use this plugin with another frameworks, like Malina.

const {sveltePaths} = require('esbuild-svelte-paths');
const malinaPlugin = require('esbuild-any-malina-plugin');

esbuild.build({
    ...
    plugins:[
        sveltePaths( {extension: 'xht'} ),
        malinaPlugin()
    ]
})

Caveat

If you use ctr-click to go to an import declaration or a path autocomplition in the IDE – you loose this feature for Svelte components imported with shorcuted path.