@yoast/grunt-plugin-tasks

Grunt-Yoast-tasks

The plugin that contains all custom Yoast tasks

Getting Started

This plugin requires Grunt ^1.0.4

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-yoast-tasks --save-dev

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

	// Load Grunt configurations and tasks
	loadGruntConfig( grunt, {
		configPath: path.join( process.cwd(), "node_modules/@yoast/grunt-plugin-tasks/config/" ),
		overridePath: path.join( process.cwd(), project.paths.config ),
		data: project,
		jitGrunt: {
			staticMappings: {
				addtextdomain: "grunt-wp-i18n",
				makepot: "grunt-wp-i18n",
				glotpress_download: "grunt-glotpress",
				"update-version": "@yoast/grunt-plugin-tasks",
				"set-version": "@yoast/grunt-plugin-tasks",
			},
		},
	} );

You can override individual task configs by adding them to your plugin's local grunt config directory.

Tasks this adds

This adds the following tasks to your plugin's repo:

• addtextdomain
• checktextdomain
• clean
• compress
• eslint
• glotpress_download
• imagemin
• makepot
• postcss
• rtlcss
• sass
• set-version (see below for usage)
• shell
• uglify
• update-version (see below for usage)
• watch
• wp_deploy

The 'set-version' task

Overview

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

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

Options

options.base

Type: String Default value: ''

The JSON file base object for the target to be in.

options.target

Type: String Default value: ''

The child of the options.base object to replace the version string in.

src

Type: String Default value: ''

The source JSON file to set the version in.

Usage Examples

packageJSON: {
	options: {
	    base: "someOrganisation",
	    target: "pluginVersion",
	},
	src: "tmp/testPackage.json",
}

The 'update-version' task

Overview

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

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

Options

options.version

Type: String Default value: ''

The string value that will be the new version string.

options.regex

Type: String Default value: ''

A regex string that is used to find the line to be updated in the file.

options.preVersionMatch

Type: String Default value: ''

A prefix to the version string, for example a regex capture group.

options.postVersionMatch

Type: String Default value: ''

A postfix to the version string, for example a regex capture group.

Usage Example

readme: {
	options: {
	    version: "1.1",
	    regEx: /(Stable tag: )(\d+(\.\d+){0,3})([^\n^\.\d]?.*?)(\n)/,
	    preVersionMatch: "$1",
	    postVersionMatch: "$5"
	},
    src: "tmp/README.md"
}

Release History

1.4.1

• Fixes a bug where the initializer regex in the update version config would never match.
• The update-version tasks now accepts both strings and regexes in options.regEx.

1.4.0

• Add .min as possible extension in rtlcss.
• Move developmentBuild to grunt configuration.

1.3.1

• Fixes the RTL configuration.

1.3.0

• Adds task configurations.
• Switches to Yoast grunt-glotpress variant.
• Updates grunt-sass.
• Adds dependency: node-sass.

1.2.0

• Updates grunt-replace.
• Adds dependency: cssnano.

1.1.0

• Adds grunt dependencies: grunt, grunt-shell, grunt-replace, load-grunt-config.
• Adds grunt contrib dependencies: grunt-contrib-clean, grunt-contrib-compress, grunt-contrib-copy, grunt-contrib-cssmin, grunt-contrib-imagemin, grunt-contrib-watch.
• Adds linting dependencies: grunt-phpcs, grunt-eslint.
• Adds css dependencies: grunt-postcss, autoprefixer, grunt-sass, grunt-rtlcss.
• Adds translations dependencies: grunt-glotpress, grunt-wp-i18n, grunt-checktextdomain.
• Adds deploy dependencies: grunt-wp-deploy, time-grunt.

1.0.0

• Initial creation of the plugin.
• Adds unit tests.