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

inject-text-webpack-plugin

v1.0.5

Published

Inject text from glob into template (useful for creating templated scss)

Downloads

3

Readme

npm install --save-dev inject-text-webpack-plugin
const webpack = require('webpack');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
const SuppressChunksPlugin = require('suppress-chunks-webpack-plugin').default;
const WebpackPreBuildPlugin = require('pre-build-webpack');
const InjectTextPlugin = require('inject-text-webpack-plugin').default;

const path = require('path');
const paths = {
    DIST: path.resolve(__dirname, 'dist'),
    SRC: path.resolve(__dirname, 'src'),
    BUILD: path.resolve(__dirname, 'build'),
};

const injector = new InjectTextPlugin({
    templateFile: 'src/styles/the_template.scss',
    outputFile: 'build/application.scss',
    sources: 'src/**/*.scss',
    filter: '**/styles/**/*.scss',
    itemTemplate: '@import "<%- item %>";',
    placeholder: '/* [inject:scss:placeholder] */',
});


module.exports = {
    entry: {
        index: path.join(paths.SRC, 'initialize.js'),
        scss: path.join(paths.BUILD, 'application.scss')
    },
    output: {
        path: path.join(paths.DIST),
        filename: 'js/[name].js',
        chunkFilename: 'js/[name].js'
    },
    plugins: [
        new ExtractTextPlugin('css/application.css'),
        new SuppressChunksPlugin({ name: 'scss', match: /\.js(\.map)?$/ }),
        new webpack.WatchIgnorePlugin([path.join(paths.BUILD, 'application.scss')]),
        new WebpackPreBuildPlugin(function () {
            injector.execute();
        })
    ],
    module: {
        rules: [
            { test: /\.js$/, exclude: /node_modules/, use: ['babel-loader']},
            { test: /\.html$/, use: ['file-loader']},
            {
                test: /scss$/,
                use: ExtractTextPlugin.extract({
                    use: [
                        { loader: 'css-loader', options: { importLoaders: 1 } },
                        { loader: 'postcss-loader', options: { config: { path: 'postcss.config.js' } } },
                        { loader: 'sass-loader' }
                    ]
                })
            }
        ]
    }
};

templateFile

Specify the path to the template you want to use, this template should contain placeholder. This is where the filenames of the resulting glob are inserted (after being passed to the itemTemplate).

outputFile

Path to where the output is saved.

sources

Glob for the input files, all files matching this pattern are inserted into the templateFile instead of the placeholder.

filter

Filter out unwanted files by setting this glob pattern (can be omitted).

itemTemplate

Each file found by sources is inserted into the templateFile using this (lodash) template. The plugin uses the name item in the template, so use something like @import "<%- item %>"; as the itemTemplate.

placeholder

This text should be present in the templateFile and gets replaced by the filenames of the resulting glob (after being passed to the itemTemplate).

Existing file structure:

WebApp
|-- src
|   |-- components
|   |   +-- navigation
|   |       |-- navigation.js
|   |       +-- navigation.scss
|   +-- styles
|       |-- mixins.scss
|       |-- overrides.scss
|       |-- the_template.scss
|       +-- vars.scss
+-- webpack.config.js

Contents of the_template:

@import "src/styles/vars.scss";

/* [inject:scss:placeholder] */

@import "src/styles/mixins.scss";
@import "src/styles/overrides.scss";

Plugin parameters:

const injector = new InjectTextPlugin({
    templateFile: 'src/styles/the_template.scss',
    outputFile: 'build/application.scss',
    sources: 'src/**/*.scss',
    filter: '**/styles/**/*.scss',
    itemTemplate: '@import "<%- item %>";',
    placeholder: '/* [inject:scss:placeholder] */',
});

Resulting file:

@import "src/styles/vars.scss";

@import "src/components/navigation/navigation.scss";

@import "src/styles/mixins.scss";
@import "src/styles/overrides.scss";