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

safe-webpack-define-plugin

v1.0.9

Published

A webpack (typescript ready) plugin to define global variables on outputted bundles

Downloads

243

Readme

Webpack Safe Define Plugin

A typescript ready webpack plugin to easily include global variables on your outputted bundles


It is much alike the DotEnv plugin but also comes with the bonus of

  • safely introducing your plain javascript objects (instances of Classes will get stringified in the process) to your webpack projects (such as configuration) on the front-end.
  • having the flexibiliy on how your output is built, no process.env shackles
  • leveraging typescript's type checking

Usage:

webpack.config.ts
export default {
    // ....
    plugins: [
        /**
         * Any primitive values are allowed through
         **/
        new SafeDefinePlugin({
            variables: 'of',
            the: ['world', { unite: 1 }],
            bourgeoisie: null,
        }),
    ],
};
Your entrypoint.ts file
declare const variables: unknown;
declare const the: unknown;

console.log(variables, the);
Your output main.js file
console.log('of', ['world', { unite: 1 }]);

Further notes

  • Feel free to use this with other Define Plugin instances in the same webpack configuration, they work just as well (as long as outputed definitions do not compete)
  • Do you want your exposed variables to be under a specific path such as process.env? Just check out SafeDefinePluginOptions['exposureStrategy'], we accept custom names generators too!
  • Not all possible types have been introduced, if you have any issues, feel free to open a ticket

Future improvements

  • Leverage ts-morph to generate typescript defintion files for your declared variables
  • Introduce a JSON.stringify spy to allows for more freedom
  • More data types allowed for input

LICENSE

MIT