Code Monkey home page Code Monkey logo

webpack-node-modules-list's Introduction

Node Modules List Webpack Plugin

npm version

Exports metadata of all used node modules of a webpack bundle to a file.

Usage

This plugin creates a list with the name, version, license, and link to the repo of each node module in the webpack bundle. The output file name can be configured, and defaults to npm-modules.md

const ExportNodeModules = require('webpack-node-modules-list');

module.exports = {
plugins: [
  new ExportNodeModules()
]}

Options

An options object may be passed to the constructor.

options.chunkName

This option allows to filter the output so that it only includes chunks with a matching chunk name.

options.outputFile

This option allows to change the name of the output file. The file path is relative to the webpack output directory.

options.format

This option allows to change the output format. markdown and json are supported.

Example

This plugin works perfectly with the SplitByPathPlugin plugin. The example below demonstrates all configurable features.

const ExportNodeModules = require('webpack-node-modules-list'),
  SplitByPathPlugin = require('webpack-split-by-path'),
  chunkName = 'vendor';

module.exports = {
plugins: [
  new SplitByPathPlugin([
    {
      name: chunkName,
      path: path.join(__dirname, 'node_modules')
    }
  ]),
  new ExportNodeModules({chunkName, outputFile: 'npm', format: 'markdown'})
]}

webpack-node-modules-list's People

Contributors

yfr avatar caerostris avatar guykisel avatar yerich avatar

Stargazers

Roman avatar

Watchers

Gastón Silva avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.