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-staticfy

v0.5.2

Published

Staticfy your website

Downloads

3

Readme

grunt-staticfy

Staticfy your website

Getting Started

This plugin requires Grunt ~0.4.4 and phantomjs

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-staticfy --save-dev

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

grunt.loadNpmTasks('grunt-staticfy');

The "staticfy" task

Overview

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

grunt.initConfig({
	staticfy: {
		options: {
			// Task-specific options go here.
		},
		your_target: {
			// Target-specific file lists and/or options go here.
		},
	},
});

Options

options.inject_script

Type: function Default value: function(){}

options.onfinish

Type: function Default value: function(str){return str;}

Usage Examples

Default Options

grunt.initConfig({
	staticfy: {
		staticfy_simple_page: {
		    files: {
		        'dest.html': ['original.html']
		    }
		}
	}
});
Here is the a html with script:
<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
<script type="text/javascript">
    document.writeln('success');
</script>
</body>
</html>

The script on page document.writeln('success'); would be executed and the compiled page is:

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
<script type="text/javascript">
    document.writeln('success');
</script>
success
</body>
</html>

Custom Options

option.inject_script

Once the page is loaded, the inject script would be executed.

grunt.initConfig({
	staticfy: {
		option_inject_script: {
		    options: {
		        inject_script: function () {
		            document.body.innerHTML = 'this line is made by inject script';
		        }
		    },
		    files: {
		        'dest.html': ['original.html']
		    }
		}
	}
});

This is the original html, no script on page.

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
original text
</body>
</html>

The inject script document.body.innerHTML = 'this line is made by inject script'; would be executed, so the compiled html is:

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
this line is made by inject script
</body>
</html>

option.onfinish

grunt.initConfig({
  staticfy: {
    option_on_finish: {
        options: {
            onfinish: function (str) {
                grunt.log.writeln(str.replace(/\<!-- remove start --\>[\w\W]*\<!-- remove end --\>/gi, ''));
                return str.replace(/\<!-- remove start --\>[\w\W]*\<!-- remove end --\>/gi, '');
            }
        },
        files: {
	        'dest.html': ['original.html']
        }
    }
  }
});

Original html

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
<!-- remove start -->
this will be remove
<!-- remove end -->
this will not be remove
</body>
</html>

Compiled html

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
this will not be remove
</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.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Release History

(Nothing yet)