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

dot-index-webpack-plugin

v5.4.0

Published

[![npm version](https://badge.fury.io/js/dot-index-webpack-plugin.svg)](https://badge.fury.io/js/dot-index-webpack-plugin)

Downloads

391

Readme

npm version

dot-index-webpack-plugin

This plugin automatically builds dot index files that export the contents of directories. It generates these files each time a file is changed or added to a specified source folder. This relieves you of the need to remember to update your index files each time you add a new file to your project.

Dot Index Files

Dot index files are identical to index files except in name: the filename .index.js rather than index.js denotes that they were generated automatically. A dot index file exports all other modules in its directory, using the name of the file as the name of the export. For instance, in a directory with structure:

+ src
| - .index.js
| - myModule.js
| - otherModule.js

The .index.js file would look like:

export { default as myModule } from './myModule'
export { default as otherModule } from './otherModule'

This convention means that it's important that filenames match desired module names. In order to use a custom index file rather than a generated one, simply add a index.js in the given directory.

Usage

To use this plugin in your project, add an instance of the plugin to your plugins array, with a path option value specifying the root of the directory where you'd like your dot index files to be generated.

Example webpack.config.js:

const DotIndexPlugin = require('dot-index-webpack-plugin')

module.exports = {
  // ... other configuration ...
  plugins: [
    new DotIndexPlugin({
      // watch src/ folder for changes
      path: path.join(__dirname, '../src'),
    }),
  ],
}

Custom export names

In some cases, you may want to customize the formatting of the generated export names. In this case, you can pass in a custom formatExports function to the plugin constructor:

  plugins: [
    new DotIndexPlugin({
      path: path.join(__dirname, '../src'),
      formatExports: (filename, rootPath) => filename.toUpperCase()
    })
  ],

  // ... will result in ...

  export { default as MYCOMPONENT } from './MyComponent'