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

seek-style-guide-webpack

v3.0.1

Published

Webpack config decorator to seek-style-guide applications

Downloads

50

Readme

Build Status npm semantic-release Commitizen friendly Styled with Prettier

seek-style-guide-webpack

Webpack decorators for integrating with the SEEK Style Guide.

Installation

$ npm install --save-dev seek-style-guide-webpack

Setup

First, decorate your server Webpack config:

const { decorateServerConfig } = require('seek-style-guide-webpack');

module.exports = decorateServerConfig({
  // Webpack config...
});

Then, decorate your client Webpack config:

const { decorateClientConfig } = require('seek-style-guide-webpack');

module.exports = decorateClientConfig({
  // Webpack config...
});

Options

CSS Output Loader { cssOutputLoader: <webpack loader> | 'style-loader' }

By default the client decorator will use style-loader to handle the styles emitted from the seek-style-guide. Alternatively, you can pass in your own loader configuration, eg.

const { decorateClientConfig } = require('seek-style-guide-webpack');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');

const config = {
  // Webpack config...
  plugins: [
    new MiniCssExtractPlugin(
      filename: 'style.css'
    })
  ]
};

module.exports = decorateClientConfig(config, {
  cssOutputLoader: MiniCssExtractPlugin.loader
});

Please note that, if your Webpack loaders aren't scoped to your local project files via the "include" option, the decorator will throw an error.

Extra includes (optional) { extraIncludePaths: Array<paths> }

If you have other external node_modules that need to be compiled in the same way as the seek-style-guide then you can pass an extra parameter to the decorators.

module.exports = decorateClientConfig(config, {
  // List of node_modules that need to be compiled by webpack
  extraIncludePaths: ['my-other-module']
});

CSS Selector Prefix (optional) { cssSelectorPrefix: string }

This selector prefix is automatically prepended to all selectors to ensure styles don't leak out into the global scope. For example, this is used for generating the standalone header & footer in the style guide.

module.exports = decorateClientConfig(config, {
  cssSelectorPrefix: '.__SSG__'
});

Contributing

Refer to CONTRIBUTING.md.

License

MIT.