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

demo-source-loader

v1.0.0

Published

Webpack loader that side-loads sourcecode and associated markdown for a file

Downloads

13

Readme

npm package npm downloads licence

demo-source-loader is a webpack loader that loads the original source of a javascript module together with a related markdown file, and attaches them to the exports of the module.

Usage

Install the loader with npm install --save-dev demo-source-loader. Then configure webpack by adding a rule, for example

module.exports = {
    // other config
    rules: [{
        test: /\.demo.js$/,
        exclude: /node_modules/,
        use: [{
            loader: "demo-source-loader"
        }, {
            loader: "babel-loader",
        }]
    }]
}

…or you can use the webpack inline loader syntax:

import SimpleDemo from 'demo-source-loader!./demos/Simple.demo';

Accessing raw source

After setting up your loader, you can import the raw source from the module like this:

import { __source__ } from 'demo-source-loader!./demos/Simple.demo';

console.log(__source__);

…or as a field on the default export (if one exists):

import SimpleDemo from 'demo-source-loader!./demos/Simple.demo';

console.log(SimpleDemo.__source__);

Accessing demo markup

The loader will look for a file with the same name, but ending in .md instead of .js (or .mjs or .es6 or .jsx), and expose the contents in the same way:

import { __markdown__ } from 'demo-source-loader!./demos/Simple.demo';

console.log(__markdown__);

…or

import SimpleDemo from 'demo-source-loader!./demos/Simple.demo';

console.log(SimpleDemo.__markdown__);

If no markdown file is found, the value of __markdown__ will just be an empty string.

demo-source-loader adds the markdown file to the dependency tree, so changes to the markdown will trigger a re-build if you're using webpack in watch mode.