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

grunt-toggle

v1.0.0

Published

Toggles blocks within an html file depending on supplied values.

Downloads

4

Readme

grunt-toggle

Toggles blocks within an html file depending on supplied values.

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-toggle --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-toggle');

The "toggle" task

Overview

In your project's Gruntfile, add a section named toggle to the data object passed into grunt.initConfig().

grunt.initConfig({
  toggle: {
    dev: {
      options: {
        show: ['dev']
      }
    },
    dist: {
      options: {
        show: ['dist', 'prod']
      }
    }
  },
});

Options

options.show

Type: Array Default value: []

An array of strings which correspond to the toggle comment blocks you wish to keep in your html file. All blocks not listed will be removed.

mode

Type: Boolean or Number Default: false

Whether to copy or set the existing file permissions. Set to true to copy the existing file permissions. Or set to the mode, i.e.: 0644, that copied files will be set to.

Usage Examples

Given the following html:

<html>
    <head>
        <title>toggle</title>

        <!-- toggle:head -->
        <script>console.log('head visible');</script>
        <!-- endtoggle -->
    </head>

    <body>
        <!-- toggle:body -->
        <p>body visible</p>
        <!-- endtoggle -->
    </body>
</html>

To only show the head toggle block, use the following options:

grunt.initConfig({
  toggle: {
    dev: {
      options: {
        show: ['head']
      },
      files: {
        'index.html': ['index.html'],
      }
    }
  },
});

The output would be:

<html>
    <head>
        <title>toggle</title>

        <script>console.log('head visible');</script>
    </head>

    <body>
    </body>
</html>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

1.0.0 - Initial release