Skip to content

Commit

Permalink
Organize and simplify Grunt build process
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul de Wouters committed Oct 1, 2015
1 parent 701372c commit 2b08974
Show file tree
Hide file tree
Showing 16 changed files with 282 additions and 378 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ build
History.md
vendor
.idea
releases
358 changes: 2 additions & 356 deletions Gruntfile.js
View file
Original file line number Diff line number Diff line change
@@ -1,357 +1,3 @@
/* jshint node:true */
module.exports = function (grunt) {

// Load all Grunt tasks
require('load-grunt-tasks')(grunt);

// Project configuration
grunt.initConfig({
pkg : grunt.file.readJSON('package.json'),

makepot : {
target: {
options: {
mainFile: 'backupwordpress.php',
potFilename: 'backupwordpress.pot',
domainPath: '/languages', // Where to save the POT file.
exclude: ['node_modules/.*','vendor/.*', 'backdrop/.*','bin/.*','tests/.*','readme/.*','languages/.*'],
mainFile : 'backupwordpress.php', // Main project file.
type : 'wp-plugin', // Type of project (wp-plugin or wp-theme).
processPot: function( pot, options ) {
pot.headers['report-msgid-bugs-to'] = 'backupwordpress@hmn.md';
pot.headers['last-translator'] = 'Human Made Limited';
pot.headers['language-team'] = 'Human Made Limited';
return pot;
}
}
}
},

checktextdomain: {
standard: {
options: {
text_domain: 'backupwordpress', //Specify allowed domain(s),
correct_domain: true,
keywords: [ //List keyword specifications
'__:1,2d',
'_e:1,2d',
'_x:1,2c,3d',
'esc_html__:1,2d',
'esc_html_e:1,2d',
'esc_html_x:1,2c,3d',
'esc_attr__:1,2d',
'esc_attr_e:1,2d',
'esc_attr_x:1,2c,3d',
'_ex:1,2c,3d',
'_n:1,2,4d',
'_nx:1,2,4c,5d',
'_n_noop:1,2,3d',
'_nx_noop:1,2,3c,4d'
]
},
files: [{
src: ['**/*.php', '!**/vendor/**', '!**/node_modules/**', '!**/tests/**'], //all php
expand: true,
}],
}
},

wp_readme_to_markdown: {
target: {
files: {
'readme.md': 'readme.txt'
}
}
},
jshint : {
options: grunt.file.readJSON('.jshintrc'),
grunt : {
src: [
'Gruntfile.js'
]
},
plugin : {
src: [
'assets/hmbkp.js'
]
}
},
uglify : {
options: {
preserveComments: 'some'
},
plugin : {
files: {
'assets/hmbkp.min.js': ['assets/hmbkp.js']
}
}
},
shell : {
changelog: {
command: 'git changelog'
},
commit: {
command: 'git add . --all && git commit -m "Version <%= pkg.version %>"'
},
tag : {
command: 'git tag -a <%= pkg.version %> -m "Version <%= pkg.version %>"'
}
},

copy: {
build: {
files: [
{
expand: true,
cwd: '.',
src: [
'**/*',
'!**/.{svn,git,bowerrc,jshintrc,travis.yml,gitignore}/**',
'!**/.DS_Store/**',
'!**composer{.json,.lock}**',
'!**{bower,package}.json**',
'!**Gruntfile.js**',
'!**README.md**',
'!**phpunit**',
'!**/node_modules/**',
'!**/wp-assets/**',
'!**/tests/**',
'!**/build/**',
'!**/bin/**',
'!**/build/docs/**',
'!**/readme/**',
'!**{readme,CONTRIBUTING}.md**',
'!**/vendor/symfony/finder/Symfony/Component/Finder/Tests/**',
],
dest: 'build'
}
]
}
},

cssmin : {
minify: {
expand: true,
cwd : 'assets/',
src : ['hmbkp.css'],
dest : 'assets/',
ext : '.min.css'
}
},
replace : {
pluginClassVersion: {
src: [
'classes/class-plugin.php'
],
overwrite: true,
replacements: [ {
from: /^(\s)+const PLUGIN_VERSION = '.*';$/m,
to: '$1const PLUGIN_VERSION = \'<%= pkg.version %>\';'
} ]
},
stableTag: {
src: [
'readme/readme-header.txt'
],
overwrite: true,
replacements: [ {
from: /^Stable tag: .*$/m,
to: 'Stable tag: <%= pkg.version %>'
} ]
},

pluginVersion: {
src: [
'backupwordpress.php'
],
overwrite: true,
replacements: [ {
from: /^Version: .*$/m,
to: 'Version: <%= pkg.version %>'
} ]
},
readmeVersion: {
src : [
'readme.md'
],
overwrite : true,
replacements: [
{
from: /^\* \*\*Stable version:\*\* .*$/m,
to : '* **Stable version:** <%= pkg.version %>'
}
]
},
faq : {
src : [
'admin/faq.php'
],
dest : 'readme/faq.txt',
replacements: [
{
from: /.*<p>' \. __\( '(.*)', '\w+' \).*/mg,
to : '$1'
},
{
from: '<?php',
to : ''
},
{
from: /\\'/g,
to: '\''
},
{
from: /.*<strong>.*__\( '(.*)', '\w+' \).*<\/strong>.*/g,
to: '**$1**'
},
{
from: /'(?:<ul>)?<li>' \. .*__\( '(.*)', '.*' \) .* '<\/li>(?:<\/ul>)?' \./g,
to: '* $1'
},
{
from: /<\/?code>/g,
to: '`'
},
{
from: /<a href="(.*)" title="(.*)" target="_blank">(.*)<\/a>/g,
to: '[$3]($1 "$2")'
}
]
}
},
concat : {
readme: {
src : [
'readme/readme-header.txt',
'readme/faq.txt',
'readme/readme-footer.txt'
],
dest: 'readme.txt'
}
},
compress : {
build: {
options: {
archive: 'dist/<%= pkg.name %>-<%= pkg.version %>.zip',
mode : 'zip'
},
files : [
{
expand: true,
src : ['**/*'],
dest : '<%= pkg.name %>',
cwd : 'dist/temp'
}
]
}
},
clean : {
build: {
src: [ 'build' ]
}
},
bump: {
options: {
files: [ 'package.json' ],
updateConfigs: [ 'pkg' ],
commit: false
}
},
other: {
changelog: 'changelog.md'
},

// Deploys a new version to the svn WordPress.org repo.
wp_deploy: {
deploy: {
options: {
plugin_slug: 'backupwordpress',
svn_user: 'pauldewouters',
build_dir: 'build',
assets_dir: 'wp-assets'
}
}
}
});

// Default task(s).
grunt.registerTask( 'default', [ 'newer:concat:css', 'newer:cssmin', 'newer:uglify' ] );

// Bump the version to the specified value; e.g., "grunt bumpto:patch"
grunt.registerTask( 'bumpto', function( releaseType ) {
if ( 'minor' !== releaseType && 'major' !== releaseType && 'patch' !== releaseType ) {
grunt.fail.fatal( 'Please specify the bump type (e.g., "grunt bumpto:patch")' );
} else {
grunt.task.run( 'bump-only:' + releaseType );

// Update the version numbers and build FAQ portion of readme.txt
grunt.task.run( 'replace' );
}
} );

// Prompt for the changelog
grunt.registerTask( 'log', function( releaseType ) {
var semver = require( 'semver' ),
changelog,
newVersion = semver.inc( grunt.config.get( 'pkg' ).version, releaseType),
regex = new RegExp( '^## ' + newVersion, 'gm' ); // Match the version number (e.g., "# 1.2.3")

if ( 'minor' !== releaseType && 'major' !== releaseType && 'patch' !== releaseType ) {
grunt.log.writeln().fail( 'Please choose a valid version type (minor, major, or patch)' );
} else {
// Get the new version
changelog = grunt.file.read( grunt.config.get( 'other' ).changelog );

if ( changelog.match( regex ) ) {
grunt.log.ok( 'v' + newVersion + ' changelog entry found' );
} else {
grunt.fail.fatal( 'Please enter a changelog entry for v' + newVersion );
}
}
} );

// Package a new release
grunt.registerTask( 'package', [
'copy:build',
'compress:build',
'clean:build'
] );

// Top level function to build a new release
grunt.registerTask( 'release', function( releaseType ) {
if ( 'minor' !== releaseType && 'major' !== releaseType && 'patch' !== releaseType ) {
grunt.fail.fatal( 'Please specify the release type (e.g., "grunt release:patch")' );
} else {
// Check to make sure the log exists
grunt.task.run( 'log:' + releaseType );

// Build the readme file
grunt.task.run( 'concat:readme' );

// Bump the version numbers
grunt.task.run( 'bumpto:' + releaseType );

// Create the .pot file
grunt.task.run( 'makepot' );

// Build the SASS and scripts
grunt.task.run( 'default' );

// Update repo readme from plugin readme
grunt.task.run( 'wp_readme_to_markdown' );

// Zip it up
grunt.task.run( 'package' );

// Commit and tag version update
grunt.task.run( 'shell:commit' );
grunt.task.run( 'shell:tag' );
}
} );

grunt.registerTask( 'deploy', [
'copy:build',
'wp_deploy',
'clean:build'
] );
module.exports = function( grunt ) {
require( 'load-grunt-config' )( grunt );
};
21 changes: 21 additions & 0 deletions grunt/aliases.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
build-dev:
- makepot
- cssmin
- uglify
- autoprefixer
- shell
- compress

build:
- makepot
- cssmin
- uglify
- autoprefixer
- bumpup
- replace # Update version numbers, build faq.txt
- concat # build readme.txt
- shell
- compress

localize:
- makepot
5 changes: 5 additions & 0 deletions grunt/autoprefixer.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
no_dest: {
src: 'assets/hmbkp.css'
}
};
Loading

0 comments on commit 2b08974

Please sign in to comment.