-
Notifications
You must be signed in to change notification settings - Fork 0
/
Gruntfile.js
279 lines (258 loc) · 6.5 KB
/
Gruntfile.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
module.exports = function(grunt) {
'use strict';
require('load-grunt-tasks')(grunt);
// Project configuration.
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
// Setting directories
dirs: {
css: 'assets/css',
js: 'assets/js',
},
cssmin: {
target: {
files: [{
expand: true,
cwd: '<%= dirs.css %>',
src: [
'*.css',
'!*.min.css'
],
dest: '<%= dirs.css %>',
ext: '.min.css'
}]
}
},
uglify: {
options: {
compress: {
global_defs: {
"EO_SCRIPT_DEBUG": false
},
dead_code: true
},
banner: '/*! <%= pkg.title %> <%= pkg.version %> <%= grunt.template.today("yyyy-mm-dd HH:MM") %> */\n'
},
build: {
files: [{
expand: true, // Enable dynamic expansion.
src: [ // Actual pattern(s) to match.
'<%= dirs.js %>/*.js',
'!<%= dirs.js %>/*.min.js'
],
ext: '.min.js', // Destination filepaths will have this extension.
}]
}
},
// Check for JavaScript issues
jshint: {
options: {
reporter: require('jshint-stylish'),
globals: {
"EO_SCRIPT_DEBUG": false,
},
'-W099': true, // Mixed spaces and tabs
'-W083': true, // Fix functions within loop
'-W082': true, // Declarations should not be placed in blocks
'-W020': true, // Read only - error when assigning EO_SCRIPT_DEBUG a value.
},
all: [
'<%= dirs.js %>/*.js',
'!<%= dirs.js %>/*.min.js'
]
},
// Watch for changes in assets
watch: {
scripts: {
files: '<%= dirs.js %>/*.js',
tasks: ['jshint', 'uglify'],
options: {
debounceDelay: 250,
},
},
css: {
files: '<%= dirs.css %>/*.css',
tasks: ['css'],
},
},
// Generate .pot file
makepot: {
target: {
options: {
cwd: '',
domainPath: 'languages', // Where to save the POT file.
exclude: [
'releases',
'node_modules',
],
mainFile: '<%= pkg.name %>.php', // Main project file.
potComments: '# Copyright (c) {{year}} Your Name/Your Company', // The copyright at the beginning of the POT file.
potFilename: '<%= pkg.name %>.pot', // Name of the POT file.
type: 'wp-plugin', // Type of project (wp-plugin or wp-theme).
potHeaders: {
'poedit': true, // Includes common Poedit headers.
'x-poedit-keywordslist': true, // Include a list of all possible gettext functions.
'Report-Msgid-Bugs-To': 'https://yourdomain.com/',
'language-team': 'Your Name <youremail@domain.com>',
'language': 'en_US'
},
type: 'wp-plugin', // Type of project.
updateTimestamp: true, // Whether the POT-Creation-Date should be updated without other changes.
}
}
},
// Check strings for localization issues
checktextdomain: {
options:{
text_domain: '<%= pkg.name %>', // Project text domain.
keywords: [
'__: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',
'**/*.php', // Include all files
'!woo-dependencies/**', // Exclude woo-dependencies/
'!node_modules/**', // Exclude node_modules/
'!tmp/**', // Exclude tmp/
],
expand: true
},
},
potomo: {
dist: {
options: {
poDel: false
},
files: [{
expand: true,
cwd: 'languages',
src: ['*.po'],
dest: 'languages',
ext: '.mo',
nonull: false
}]
}
},
// Bump version numbers (replace with version in package.json)
replace: {
Version: {
src: [
'readme.txt',
'<%= pkg.name %>.php'
],
overwrite: true,
replacements: [
{
from: /Requires PHP:.*$/m,
to: "Requires PHP: <%= pkg.requires_php %>"
},
{
from: /Requires at least:.*$/m,
to: "Requires at least: <%= pkg.requires %>"
},
{
from: /Tested up to:.*$/m,
to: "Tested up to: <%= pkg.tested_up_to %>"
},
{
from: /Stable tag:.*$/m,
to: "Stable tag: <%= pkg.version %>"
},
{
from: /Version:.*$/m,
to: "Version: <%= pkg.version %>"
},
{
from: /public \$version = \'.*.'/m,
to: "public $version = '<%= pkg.version %>'"
},
{
from: /public \$version = \'.*.'/m,
to: "public $version = '<%= pkg.version %>'"
}
]
}
},
// Copies the plugin to create deployable plugin.
copy: {
deploy: {
src: [
'**',
'!.*',
'!*.md',
'!.*/**',
'!.htaccess',
'!Gruntfile.js',
'!releases/**',
'!node_modules/**',
'!.DS_Store',
'!npm-debug.log',
'!*.json',
'!*.sh',
'!*.zip',
'!*.jpg',
'!*.jpeg',
'!*.gif',
'!*.png'
],
dest: '<%= pkg.name %>',
expand: true,
dot: true
}
},
// Compresses the deployable plugin folder.
compress: {
zip: {
options: {
archive: './<%= pkg.name %>-v<%= pkg.version %>.zip',
mode: 'zip'
},
files: [
{
expand: true,
cwd: './<%= pkg.name %>/',
src: '**',
dest: '<%= pkg.name %>'
}
]
}
},
// Deletes the deployable plugin folder once zipped up.
clean: [ '<%= pkg.name %>' ]
});
// Set the default grunt command to run test cases.
grunt.registerTask( 'default', [ 'test' ] );
// Checks for errors with the JavaScript and check the text domain in strings match or not missing.
grunt.registerTask( 'test', [ 'jshint', 'checktextdomain' ]);
// Dev build
grunt.registerTask( 'dev', [ 'replace', 'cssmin', 'newer:uglify', 'makepot' ]);
// Build plugin.
grunt.registerTask( 'build', [ 'replace', 'cssmin', 'newer:uglify', 'checktextdomain', 'makepot' ]);
/**
* Run i18n related tasks.
*
* This includes extracting translatable strings, updating the master pot file.
* If this is part of a deploy process, it should come before zipping everything up.
*/
grunt.registerTask( 'update-pot', [ 'checktextdomain', 'makepot' ]);
/**
* Creates a deployable plugin zipped up ready to upload
* and install on a WordPress installation.
*/
grunt.registerTask( 'zip', [ 'copy', 'compress', 'clean' ]);
};