Merge pull request #130 from fjarrett/improved-readme

Improve readme and grunt tasks

Author: danielbachhuber

.distignore

@@ -1,22 +1,13 @@
 # A set of files you probably don't want in your WordPress.org distribution
-.distignore
-.editorconfig
-.git
-.gitignore
-.travis.yml
-.DS_Store
-Thumbs.db
-bin
-behat.yml
-circle.yml
+.*
+*.xml
+*.yml
 Gruntfile.js
 package.json
-phpunit.xml
-multisite.xml
 phpunit.xml.dist
-phpcs.ruleset.xml
-README.md
-wp-cli.local.yml
-tests
-/vendor/lcache/lcache/tests
-node_modules
+readme.md
+Thumbs.db
+bin/
+node_modules/
+tests/
+vendor/lcache/lcache/tests/

.gitignore

@@ -1,5 +1,6 @@
 *.zip
 .DS_Store
+Thumbs.db
 node_modules/
 vendor/
 pantheon-wordpress-upstream-master

Gruntfile.js

@@ -1,37 +1,69 @@
+/* global module, require */
+
 module.exports = function( grunt ) {
 
 	'use strict';
-	// Project configuration
+
+	var pkg = grunt.file.readJSON( 'package.json' );
+
 	grunt.initConfig( {
 
-		pkg:    grunt.file.readJSON( 'package.json' ),
+		pkg: pkg,
 
-		wp_readme_to_markdown: {
-			options: {
-				screenshot_url: 'https://s.w.org/plugins/{plugin}/{screenshot}.png',
-			},
-			your_target: {
-				files: {
-					'README.md': 'readme.txt'
+		devUpdate: {
+			check: {},
+			update: {
+				options: {
+					updateType: 'force'
 				}
-			},
+			}
 		},
 
 		phpcs: {
-			plugin: {
-				src: './'
-			},
 			options: {
-				bin: "vendor/bin/phpcs --extensions=php --ignore=\"*/vendor/*,*/lib/*,*/node_modules/*\"",
-				standard: "phpcs.ruleset.xml"
+				bin: 'vendor/bin/phpcs --extensions=php --ignore="*/vendor/*,*/lib/*,*/node_modules/*"',
+				standard: 'phpcs.ruleset.xml'
+			},
+			main: {
+				src: '*.php'
 			}
 		},
 
+		wp_readme_to_markdown: {
+			options: {
+				post_convert: function( readme ) {
+					var matches = readme.match( /\*\*Tags:\*\*(.*)\r?\n/ ),
+					    tags    = matches[1].trim().split( ', ' ),
+					    section = matches[0];
+
+					for ( var i = 0; i < tags.length; i++ ) {
+						section = section.replace( tags[i], '[' + tags[i] + '](https://wordpress.org/plugins/tags/' + tags[i] + '/)' );
+					}
+
+					// Tag links
+					readme = readme.replace( matches[0], section );
+
+					// Badges
+					readme = readme.replace( '## Description ##', grunt.template.process( pkg.badges.join( ' ' ) ) + "  \r\n\r\n## Description ##" );
+
+					return readme;
+				},
+				screenshot_url: 'https://ps.w.org/{plugin}/assets/{screenshot}.png'
+			},
+			main: {
+				files: {
+					'readme.md': 'readme.txt'
+				}
+			}
+		}
+
 	} );
 
-	grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' );
-	grunt.loadNpmTasks( 'grunt-phpcs' );
-	grunt.registerTask( 'readme', ['wp_readme_to_markdown']);
+	require( 'matchdep' ).filterDev( 'grunt-*' ).forEach( grunt.loadNpmTasks );
+
+	grunt.registerTask( 'dev-check',  [ 'devUpdate:check' ] );
+	grunt.registerTask( 'dev-update', [ 'devUpdate:update' ] );
+	grunt.registerTask( 'readme',     [ 'wp_readme_to_markdown' ] );
 
 	grunt.util.linefeed = '\n';