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

webpack-todo-plugin

v1.0.0

Published

The TODOPlugin is a webpack plugin designed to search for TODO comments in specified files and directories of your project, and generate a JSON file containing information about these TODO items. It provides flexibility to customize the search criteria ba

Downloads

5

Readme

TODOPlugin

The TODOPlugin is a webpack plugin designed to search for TODO comments in specified files and directories of your project, and generate a JSON file containing information about these TODO items. It provides flexibility to customize the search criteria based on custom patterns and directory paths.

Features

  • Search for TODO comments in specified files and directories.
  • Customize search criteria with custom TODO patterns.
  • Generate a JSON file containing information about TODO items found.

Installation

You can install the TODOPlugin via npm:

npm install webpack-todo-plugin --save-dev

Usage

To use the TODOPlugin in your webpack configuration, follow these steps:

  1. Import the plugin into your webpack configuration file:
const TODOPlugin = require('webpack-todo-plugin');
  1. Add the plugin to the plugins array in your webpack configuration, passing any necessary options:
module.exports = {
  // Other webpack configuration options...
  plugins: [
    new TODOPlugin({
      directory: 'src', // Directory to search for TODO comments
      customPatterns: ['FIXME', 'HACK'], // Custom patterns to match for TODO comments
    }),
  ],
};
  1. Run webpack to trigger the plugin and generate the JSON file containing TODO items:
npx webpack
  1. View the generated todo.json file in the specified output directory to see the detected TODO items.

CLI Command

You can also use the webpack-todo show command to display the TODO items directly from the command line. Make sure to run this command after running webpack to generate the todo.json file.

npx webpack-todo show

Options

The TODOPlugin supports the following options:

  • directory (String, required): The directory path to search for TODO comments. Default 'src'.
  • customPatterns (Array, required): Custom patterns to match for TODO comments. Default 'TODO', 'FIXME'.

Example

Here's an example webpack configuration using the TODOPlugin:

const path = require('path');
const TODOPlugin = require('webpack-todo-plugin');

module.exports = {
  mode: 'development',
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js',
  },
  plugins: [
    new TODOPlugin({
      directory: 'src',
      customPatterns: ['TODO', 'FIXME'],
    }),
  ],
};

License

This project is licensed under the MIT License.

Acknowledgements

The TODOPlugin is built using webpack.