forked from Wunderbyte-GmbH/moodle-theme_campus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Gruntfile.js
319 lines (304 loc) · 12 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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/**
* Gruntfile for compiling theme_campus .less files.
*
* This file configures tasks to be run by Grunt
* http://gruntjs.com/ for the current theme.
*
*
* Requirements:
* -------------
* nodejs, npm, grunt-cli.
*
* Installation:
* -------------
* node and npm: instructions at http://nodejs.org/
*
* grunt-cli: `[sudo] npm install -g grunt-cli`
*
* node dependencies: run `npm install` in the root directory.
*
*
* Usage:
* ------
* Call tasks from the theme root directory. Default behaviour
* (calling only `grunt`) is to run the watch task detailed below.
*
*
* Porcelain tasks:
* ----------------
* The nice user interface intended for everyday use. Provide a
* high level of automation and convenience for specific use-cases.
*
* grunt watch Watch the less directory (and all subdirectories)
* for changes to *.less files then on detection
* run 'grunt compile'
*
* Options:
*
* --dirroot=<path> Optional. Explicitly define the
* path to your Moodle root directory
* when your theme is not in the
* standard location.
* grunt compile Run the .less files through the compiler, create the
* RTL version of the output, then run decache so that
* the results can be seen on the next page load.
*
* Options:
*
* --dirroot=<path> Optional. Explicitly define the
* path to your Moodle root directory
* when your theme is not in the
* standard location.
*
* --build=<type> Optional. 'p'(default) or 'd'. If 'p'
* then 'production' CSS files. If 'd'
* then 'development' CSS files unminified
* and with source map to less files.
*
* --urlprefix=<path> Optional. Explicitly define
* the path between the domain
* and the installation in the
* URL, i.e. /moodle27 being:
* --urlprefix=/moodle27
*
* grunt amd Create the Asynchronous Module Definition JavaScript files. See: MDL-49046.
* Done here as core Gruntfile.js currently *nix only.
*
* grunt svg Change the colour of the SVGs in pix_core by
* text replacing #999999 with a new hex color.
* Note this requires the SVGs to be #999999 to
* start with or the replace will do nothing
* so should usually be preceded by copying
* a fresh set of the original SVGs.
*
* Options:
*
* --svgcolor=<hexcolor> Hex color to use for SVGs
*
* Plumbing tasks & targets:
* -------------------------
* Lower level tasks encapsulating a specific piece of functionality
* but usually only useful when called in combination with another.
*
* grunt less Compile all less files.
*
* grunt less:moodle Compile Moodle less files only.
*
* grunt less:editor Compile editor less files only.
*
* grunt decache Clears the Moodle theme cache.
*
* Options:
*
* --dirroot=<path> Optional. Explicitly define
* the path to your Moodle root
* directory when your theme is
* not in the standard location.
*
* grunt replace Run all text replace tasks.
*
*
* @package theme
* @subpackage campus
* @copyright © 2014-onwards G J Barnard in respect to modifications of the Clean theme.
* @copyright © 2014-onwards Work undertaken for David Bogner of Edulabs.org.
* @author G J Barnard - gjbarnard at gmail dot com and {@link http://moodle.org/user/profile.php?id=442195}
* @author Based on code originally written by Joby Harding, Bas Brands, David Scotson and many other contributors.
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
module.exports = function(grunt) {
// Import modules.
var path = require('path');
// Theme Bootstrap constants.
var LESSDIR = 'less',
MOODLEURLPREFIX = grunt.option('urlprefix') || '',
THEMEDIR = path.basename(path.resolve('.'));
// Production / development.
var build = grunt.option('build') || 'd'; // Development for 'watch' task.
if ((build != 'p') && (build != 'd')) {
build = 'p';
console.log('-build switch only accepts \'p\' for production or \'d\' for development,');
console.log('e.g. -build=p or -build=d. Defaulting to development.');
}
// PHP strings for exec task.
var moodleroot = path.dirname(path.dirname(__dirname)),
configfile = '',
decachephp = '',
dirrootopt = grunt.option('dirroot') || process.env.MOODLE_DIR || '';
// Allow user to explicitly define Moodle root dir.
if ('' !== dirrootopt) {
moodleroot = path.resolve(dirrootopt);
}
var PWD = process.cwd();
configfile = path.join(moodleroot, 'config.php');
decachephp += 'define(\'CLI_SCRIPT\', true);';
decachephp += 'require(\'' + configfile + '\');';
decachephp += 'theme_reset_all_caches();';
var svgcolor = grunt.option('svgcolor') || '#999999';
grunt.initConfig({
less: {
// Compile editor styles.
editor_d: {
options: {
compress: false,
paths: "./less",
report: 'min',
sourceMap: true,
sourceMapRootpath: MOODLEURLPREFIX + '/theme/' + THEMEDIR,
sourceMapFilename: 'style/editor.treasure.map'
},
src: 'less/editorallcampus.less',
dest: 'style/editor.css'
},
editor_p: {
options: {
compress: true,
paths: "./less",
report: 'min',
sourceMap: false
},
src: 'less/editorallcampus.less',
dest: 'style/editor.css'
}
},
exec: {
decache: {
cmd: 'php -r "' + decachephp + '"',
callback: function(error, stdout, stderror) {
// exec will output error messages
// just add one to confirm success.
if (!error) {
grunt.log.writeln("Moodle theme cache reset.");
}
}
}
},
watch: {
// Watch for any changes to less files and compile.
files: ["less/**/*.less", "../bootstrapbase/less/**/*.less"],
tasks: ["compile"],
options: {
spawn: false
}
},
copy: {
svg_core: {
expand: true,
cwd: 'pix_core_originals/',
src: '**',
dest: 'pix_core/',
},
svg_plugins: {
expand: true,
cwd: 'pix_plugins_originals/',
src: '**',
dest: 'pix_plugins/',
},
svg_fp: {
expand: true,
cwd: 'pix_fp_originals/',
src: '**',
dest: 'pix/fp/',
}
},
replace: {
svg_colours_core: {
src: 'pix_core/**/*.svg',
overwrite: true,
replacements: [{
from: '#999',
to: svgcolor
}]
},
svg_colours_plugins: {
src: 'pix_plugins/**/*.svg',
overwrite: true,
replacements: [{
from: '#999',
to: svgcolor
}]
},
svg_colours_fp: {
src: 'pix/fp/**/*.svg',
overwrite: true,
replacements: [{
from: '#999',
to: svgcolor
}]
}
},
svgmin: { // Task
options: { // Configuration that will be passed directly to SVGO
plugins: [{
removeViewBox: false
}, {
removeUselessStrokeAndFill: false
}, {
convertPathData: {
straightCurves: false // advanced SVGO plugin option
}
}]
},
dist: { // Target
files: [{ // Dictionary of files
expand: true, // Enable dynamic expansion.
cwd: 'pix_core', // Source matches are relative to this path.
src: ['**/*.svg'], // Actual pattern(s) to match.
dest: 'pix_core/', // Destination path prefix.
ext: '.svg' // Destination file paths will have this extension.
}, { // Dictionary of files
expand: true, // Enable dynamic expansion.
cwd: 'pix_plugins', // Source matches are relative to this path.
src: ['**/*.svg'], // Actual pattern(s) to match.
dest: 'pix_plugins/', // Destination path prefix.
ext: '.svg' // Destination file paths will have this extension.
}, { // Dictionary of files
expand: true, // Enable dynamic expansion.
cwd: 'pix/fp', // Source matches are relative to this path.
src: ['**/*.svg'], // Actual pattern(s) to match.
dest: 'pix/fp/', // Destination path prefix.
ext: '.svg' // Destination file paths will have this extension.
}]
}
},
jshint: {
options: {jshintrc: moodleroot + '/.jshintrc'},
files: ['**/amd/src/*.js']
},
uglify: {
dynamic_mappings: {
files: grunt.file.expandMapping(
['**/src/*.js', '!**/node_modules/**'],
'',
{
cwd: PWD,
rename: function(destBase, destPath) {
destPath = destPath.replace('src', 'build');
destPath = destPath.replace('.js', '.min.js');
destPath = path.resolve(PWD, destPath);
return destPath;
}
}
)
}
}
});
// Load contrib tasks.
grunt.loadNpmTasks("grunt-contrib-less");
grunt.loadNpmTasks("grunt-contrib-watch");
grunt.loadNpmTasks("grunt-exec");
grunt.loadNpmTasks("grunt-text-replace");
grunt.loadNpmTasks('grunt-contrib-copy');
grunt.loadNpmTasks('grunt-svgmin');
// Load core tasks.
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-jshint');
// Register tasks.
grunt.registerTask("default", ["watch"]);
grunt.registerTask("decache", ["exec:decache"]);
grunt.registerTask("compile", ["less:editor_"+build, "decache"]);
grunt.registerTask("copy:svg", ["copy:svg_core", "copy:svg_plugins", "copy:svg_fp"]);
grunt.registerTask("replace:svg_colours", ["replace:svg_colours_core", "replace:svg_colours_plugins", "replace:svg_colours_fp"]);
grunt.registerTask("svg", ["copy:svg", "replace:svg_colours", "svgmin"]);
grunt.registerTask("amd", ["jshint", "uglify"]);
};