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 🙏

© 2021 – Pkg Stats / Ryan Hefner

glob-import-loader

v1.1.4

Published

Webpack loader that enables glob patterns in ES6 imports.

Downloads

1,658

Readme

Build Status npm version

glob-import-loader

Webpack loader that enables ES6 imports with glob patterns. Leverages Webpack's Enhanced Resolver to resolve aliases.

Inspired by webpack-import-glob-loader

Known Issues

  1. ?, +, and ! globbing characters have issues as they're currently incompatible with Enhanced Loader. Looking for workarounds!

Notes on Sass's @use and @forward

@use's configuration syntax (with) and @forward's configuration syntax (hide) is not supported and will be ignored. These should not be added in a wildcard fashion and should instead be set individually on each module.


import modules from "./foo/**/*.js";

Expands into

import * as module0 from "./foo/1.js";
import * as module1 from "./foo/bar/2.js";
import * as module2 from "./foo/bar/3.js";

var modules = [module0, module1, module2];

For importing from node module

import modules from "a-node-module/**/*js";

Expands into

import * as module0 from "a-node-module/foo/1.js";
import * as module1 from "a-node-module/foo/bar/2.js";
import * as module2 from "a-node-module/foo/bar/3.js";

var modules = [module0, module1, module2];

For side effects:

import "./foo/**/*.scss";

Expands into

import "./foo/1.scss";
import "./foo/bar/2.scss";

For sass:

@import "./foo/**/*.scss";

Expands into

@import "./foo/1.scss";
@import "./foo/bar/2.scss";
@use "./foo/**/*.scss" as *;

Expands into

@use "./foo/1.scss" as *;
@use "./foo/bar/2.scss" as *;
@forward "./foo/**/*.scss" as C;

Expands into

@forward "./foo/1.scss" as C0;
@forward "./foo/bar/2.scss" as C1;

Install

npm install glob-import-loader --save-dev

Usage

You can use it one of two ways, the recommended way is to use it as a preloader

// ./webpack.config.js

module.exports = {
  ...
  module: {
    rules: [
      {
          test: /\.js$/,
          use: 'glob-import-loader'
      },
      {
          test: /\.scss$/,
          use: 'glob-import-loader'
      },
    ]
  }
};

Alternatively you can use it as a chained loader

// foo/bar.js
import "./**/*.js";

// index.js
import "glob-import-loader!foo/bar.js";

Options

| Name | Type | Default | Description | | :-----------------------: | :----------: | :---------: | :----------------------------------------------------------------------------------------------------------------------------- | | resolve | {Object} | {} | Your Webpack resolution (resolve) rules. | | banner | {Function} | undefined | An optional function for how wildcard variables should display. Useful for things such as HMR Where names must be predictable. |

resolve

Type: Object Default: {} (or default webpack resolution rules)

This object should reference your resolution object in your webpack.config.js configuration.

Example:

webpack.config.js

const resolve = {
  alias: {
    Sprite: path.resolve(__dirname, "src/assets/sprite"),
    CSS: path.resolve(__dirname, "src/css"),
    JS: path.resolve(__dirname, "src/js"),
  },
  modules: [path.resolve(__dirname, "node_modules")],
  extensions: [".js", ".jsx", ".ts", ".tsx", ".json"],
  plugins: [new DirectoryNamedWebpackPlugin(true)],
};

module.exports = {
  target: 'web',
  resolve,
  entry: { ... }
  module: {
    rules: [
      {
        test: /\.(j|t)sx?$/,
        include: [path.resolve(__dirname, 'src')],
        use: [
          'babel-loader',
          {
            loader: 'glob-import-loader',
            options: {
              resolve,
            },
          },
        ],
      },
    ],
  },
  ... other settings ...
};

banner

Type: Function Default: undefined

This function gives you granular control over how "import" variables are output in the code should you need it. Can be useful when needing predictable variable names, such as with HMR. The banner function should return serialized JavaScript. The banner function receives two arguments:

  1. paths - An array of objects with the following structure: | Name | Description | | :-----------------------: | :----------------------------------------------------------------------------------------------------------------------------- | | path | The path to the imported file. | | module | Variable reference to the value exported by the file. | | importString | The import string use by Webpack to import the file |

  2. varname - The variable name used when importing.

banner Example:

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.(j|t)sx?$/,
        include: [path.resolve(__dirname, "src")],
        use: [
          "babel-loader",
          {
            loader: "glob-import-loader",
            options: {
              banner(paths, varname) {
                if (varname) {
                  return `var ${varname} = {${paths
                    .map(
                      ({ path: fn, module }) => `
                      "${path.basename(fn).split(".")[0]}":${module}
                    `
                    )
                    .join(",")}};`;
                }
              },
            },
          },
        ],
      },
    ],
  },
};

entry.js (source)

import cmpts from "JS/**/*.cmpt.jsx";

entry.js (output)

... webpack import statements ...

// output via `banner` function
var cmpts = {
  "loader": _webpack_path_to_module__,
  "autocomplete": _webpack_path_to_module__,
  "searchresults": _webpack_path_to_module__,
  "searchsuggestions": _webpack_path_to_module__
};