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-wp-replace

v0.1.1

Published

Replace revved or concated filename for Wordpress source file.

Downloads

15

Readme

To better make use of this plugin, please refer grunt-wordpress for how to make Grunt work for Wordpress development.

为了更好的了解这个插件的功能,请参考grunt-wordpress一文。

grunt-wp-replace

Replace revved or concated filename for Wordpress source file.

This plugin depends on another plugin grunt-filerev which generates a global accesscible object grunt.filerev.summary.

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-wp-replace --save-dev

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

grunt.loadNpmTasks('grunt-wp-replace');

How to use

File structure(Before)

Before running any grunt task, here's how your file structure looks like:

|
+- your_theme_name
|   +- header-src.php
|   +- footer-src.php
|   +- style-src.css
|   +- js
|      +- all your js files
|   +- css
|      +- all your css files

Note: pay attention to -src suffix for those .php file, it's required to name your file like this.

In your .php file, you should reference assets in relative path.

<link rel="stylesheet" type="text/css" href="css/mycss.css" />
<script type="text/javascript" src="js/myjs.js"></script>

Run grunt task

To use the wpreplace task, you should run filerev or/and concat first in order to generate new filenames. It's recommended to generate these asstes in new folders like js-dist or css-dist other than in original folder.

File structure(After)

|
+- your_theme_name
|   +- header-src.php
|   +- header.php
|   +- footer-src.php
|   +- footer.php
|   +- style-src.css
|   +- style.css (if your minified or revved, it might be `style.min.a2312abe.css`)
|   +- js
|      +- all your js files
|   +- css
|      +- all your css files
|   +- js-dist
|      +- all your js files that are minified and revved
|   +- css-dist
|      +- all your css files that are minified and revved

Running wpreplace task will replace static assets reference in all *-src.php.

<link rel="stylesheet" type="text/css" href="/wp-content/themes/your_theme_name/css-dist/mycss.min.ac2de23a.css" />
<script type="text/javascript" src="/wp-content/themes/your_theme_name/js-dist/myjs.min.bde2ac21.js"></script>

All ready to go, have fun!

The "wpreplace" task

Overview

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

grunt.initConfig({
  wpreplace: {
    options: {
      templatePath: '/wp-content/themes/your-theme/',
      jsPath: 'js-dist',
      cssPath: 'css-dist',
      concat: [{
        src: ['a.js', 'b.js'],
        dest: ['concated.js']
      }]
    },
    your_target: {
      src: ['header-src.php', 'footer-src.php']
    }
  },
});

Options

options.templatePath

Type: String Default value: ''

The template path of your wordpress theme

options.jsPath

Type: String Default value: ''

The path which javascript files located in your wordpress theme, relative to templatePath

options.cssPath

Type: String Default value: ''

The path which css files located in your wordpress theme, relative to templatePath

options.concat

Type: Array Default value: []

If you concat any files, define them in order to replace their replace, see the Overview part for format

your_target.src

Type: Array Default value: []

Array of Wordpress source file named with -src suffix, eg. footer-src.php or header-src.php. The plugin will then generate footer.php and header.php with assets filename replaced.

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

  • 2014-01-22   v0.1.0   Dirty, ugly but working code.
  • 2014-03-12 v0.1.0 Fix a bug when concat not specified