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

rollup-plugin-svelte-source

v0.0.2

Published

Inject source code for given svelte components

Downloads

6

Readme

rollup-plugin-svelte-source

Installing

npm i -D rollup-plugin-svelte-source

Implementation

In your rollup config file. import the plugin and enable it under plugins.

// rollup.config.js
import svelteSource from 'rollup-plugin-svelte-source';

//...
plugins: [
  // make sure to initialize plugin 
  // before the svelte plugin
  svelteSource(options),
  //...
]

Options

By default these options are implemented.

{
  // the variable and export name for the stringified sourcecode
  label: 'ಠ_ಠ', 
  // what characters to be replaced. as we are working with html code the default is replacing 
  // the base htmlentities. Any occurence of a ending </script> tag will terminate the script. 
  // So at the minimum you'd have to escape that.
  // https://github.com/sveltejs/svelte/issues/5024
  replace: {
    '&': '&amp;',
    '<': '&lt;',
    '>': '&gt;',
    '"': '&quot;',
    '‘': '&apos;',
  },
  // what extensions to allow. Unless having some custom file extensions for svelte files, 
  // this option can be left as is and you'd do the filtering with the include/exclude options. 
  // expects an array and is checking that the filename ends with any one of these values
  extensions: ['.svelte'],
  // include and exclude uses @rollup/pluginutils filter which you can read more about here
  // https://github.com/rollup/plugins/tree/master/packages/pluginutils#createfilter 
  // and also for the matching features
  // https://github.com/micromatch/picomatch#globbing-features
  include: undefined,
  exclude: undefined
}

Usage

// Parent.svelte
<script>
  import Component, { ಠ_ಠ } from './Component.svelte';
</script>

<pre>
  {@html ಠ_ಠ}
</pre>

<Component />

Options example

I do not recommend leaving include/exclude undefined(default) then every svelte component would have a custom source code being exported. Either come up with your own file naming convention or only include certain directories/files.

svelteSource({
  // inside component you have access to 'source' and outside as an export
  // import Component, { source } from './subfolder/demos/testing/Component.svelte'; 
  label: 'source', 
  // match all svelte files that is at least under a 'demos' folder 
  include: ['**/demos/**'],
  // but exclude all files named Index.svelte
  exclude: ['**/Index.svelte']
})
// Parent.svelte
<script>
  import Component, { source } from './Component.svelte';
</script>

<pre>
  {@html source}
</pre>

<Component />