Gruntfile.js 6.22 KB
Newer Older
1
/* jshint node: true */
2

3
module.exports = function(grunt) {
4
5
  "use strict";

6
  RegExp.quote = require('regexp-quote')
7
  var btoa = require('btoa')
8
9
10
11
12
  // Project configuration.
  grunt.initConfig({

    // Metadata.
    pkg: grunt.file.readJSON('package.json'),
13
    banner: '/*!\n' +
14
              ' * Bootstrap v<%= pkg.version %> (http://getbootstrap.com)\n' +
15
16
              ' * Copyright <%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
              ' * Licensed under <%= _.pluck(pkg.licenses, "url").join(", ") %>\n' +
17
              ' */\n\n',
18
    jqueryCheck: 'if (typeof jQuery === "undefined") { throw new Error("Bootstrap requires jQuery") }\n\n',
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

    // Task configuration.
    clean: {
      dist: ['dist']
    },

    jshint: {
      options: {
        jshintrc: 'js/.jshintrc'
      },
      gruntfile: {
        src: 'Gruntfile.js'
      },
      src: {
        src: ['js/*.js']
      },
      test: {
        src: ['js/tests/unit/*.js']
      }
    },
39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    concat: {
      options: {
        banner: '<%= banner %><%= jqueryCheck %>',
        stripBanners: false
      },
      bootstrap: {
        src: [
          'js/transition.js',
          'js/alert.js',
          'js/button.js',
          'js/carousel.js',
          'js/collapse.js',
          'js/dropdown.js',
          'js/modal.js',
          'js/tooltip.js',
          'js/popover.js',
          'js/scrollspy.js',
          'js/tab.js',
          'js/affix.js'
        ],
        dest: 'dist/js/<%= pkg.name %>.js'
      }
    },
63

64
65
    uglify: {
      options: {
66
67
        banner: '<%= banner %>',
        report: 'min'
68
69
70
71
72
73
74
75
76
      },
      bootstrap: {
        src: ['<%= concat.bootstrap.dest %>'],
        dest: 'dist/js/<%= pkg.name %>.min.js'
      }
    },

    recess: {
      options: {
77
78
        compile: true,
        banner: '<%= banner %>'
79
80
81
82
83
84
85
86
      },
      bootstrap: {
        src: ['less/bootstrap.less'],
        dest: 'dist/css/<%= pkg.name %>.css'
      },
      min: {
        options: {
          compress: true
87
        },
88
89
        src: ['less/bootstrap.less'],
        dest: 'dist/css/<%= pkg.name %>.min.css'
90
91
92
93
94
95
96
97
98
99
100
      },
      theme: {
        src: ['less/theme.less'],
        dest: 'dist/css/<%= pkg.name %>-theme.css'
      },
      theme_min: {
        options: {
          compress: true
        },
        src: ['less/theme.less'],
        dest: 'dist/css/<%= pkg.name %>-theme.min.css'
101
102
103
      }
    },

Mark Otto's avatar
Mark Otto committed
104
105
106
107
108
109
110
111
    copy: {
      fonts: {
        expand: true,
        src: ["fonts/*"],
        dest: 'dist/'
      }
    },

112
113
114
115
116
117
    qunit: {
      options: {
        inject: 'js/tests/unit/phantom.js'
      },
      files: ['js/tests/*.html']
    },
118

119
120
121
122
123
    connect: {
      server: {
        options: {
          port: 3000,
          base: '.'
124
        }
125
126
127
      }
    },

128
129
130
131
132
133
    jekyll: {
      docs: {}
    },

    validation: {
      options: {
134
135
        reset: true,
        relaxerror: [
Zlatan Vasović's avatar
Zlatan Vasović committed
136
137
          "Bad value X-UA-Compatible for attribute http-equiv on element meta.",
          "Element img is missing required attribute src."
138
        ]
139
140
141
142
143
144
      },
      files: {
        src: ["_gh_pages/**/*.html"]
      }
    },

145
146
147
148
149
150
151
152
153
154
155
156
157
    watch: {
      src: {
        files: '<%= jshint.src.src %>',
        tasks: ['jshint:src', 'qunit']
      },
      test: {
        files: '<%= jshint.test.src %>',
        tasks: ['jshint:test', 'qunit']
      },
      recess: {
        files: 'less/*.less',
        tasks: ['recess']
      }
158
159
160
161
162
163
164
165
166
167
168
    },

    sed: {
      versionNumber: {
        pattern: (function () {
          var old = grunt.option('oldver')
          return old ? RegExp.quote(old) : old
        })(),
        replacement: grunt.option('newver'),
        recursive: true
      }
169
170
    }
  });
171
172


173
  // These plugins provide necessary tasks.
Zlatan Vasović's avatar
Zlatan Vasović committed
174
  grunt.loadNpmTasks('browserstack-runner');
175
176
177
  grunt.loadNpmTasks('grunt-contrib-clean');
  grunt.loadNpmTasks('grunt-contrib-concat');
  grunt.loadNpmTasks('grunt-contrib-connect');
Mark Otto's avatar
Mark Otto committed
178
  grunt.loadNpmTasks('grunt-contrib-copy');
179
180
181
182
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-contrib-qunit');
  grunt.loadNpmTasks('grunt-contrib-uglify');
  grunt.loadNpmTasks('grunt-contrib-watch');
183
184
  grunt.loadNpmTasks('grunt-html-validation');
  grunt.loadNpmTasks('grunt-jekyll');
185
  grunt.loadNpmTasks('grunt-recess');
186
  grunt.loadNpmTasks('grunt-sed');
187

188
  // Docs HTML validation task
189
  grunt.registerTask('validate-html', ['jekyll', 'validation']);
190

191
  // Test task.
fat's avatar
fat committed
192
  var testSubtasks = ['dist-css', 'jshint', 'qunit', 'validate-html'];
193
  // Only run BrowserStack tests under Travis
194
  if (process.env.TRAVIS) {
195
196
    // Only run BrowserStack tests if this is a mainline commit in twbs/bootstrap, or you have your own BrowserStack key
    if ((process.env.TRAVIS_REPO_SLUG === 'twbs/bootstrap' && process.env.TRAVIS_PULL_REQUEST === 'false') || process.env.TWBS_HAVE_OWN_BROWSERSTACK_KEY) {
197
198
      testSubtasks.push('browserstack_runner');
    }
199
200
  }
  grunt.registerTask('test', testSubtasks);
201

202
203
  // JS distribution task.
  grunt.registerTask('dist-js', ['concat', 'uglify']);
204

205
206
  // CSS distribution task.
  grunt.registerTask('dist-css', ['recess']);
207

Mark Otto's avatar
Mark Otto committed
208
209
210
  // Fonts distribution task.
  grunt.registerTask('dist-fonts', ['copy']);

211
  // Full distribution task.
Mark Otto's avatar
Mark Otto committed
212
  grunt.registerTask('dist', ['clean', 'dist-css', 'dist-fonts', 'dist-js']);
213

214
  // Default task.
215
  grunt.registerTask('default', ['test', 'dist', 'build-customizer']);
216

217
218
219
220
221
  // Version numbering task.
  // grunt change-version-number --oldver=A.B.C --newver=X.Y.Z
  // This can be overzealous, so its changes should always be manually reviewed!
  grunt.registerTask('change-version-number', ['sed']);

222
223
224
225
226
227
228
229
  // task for building customizer
  grunt.registerTask('build-customizer', 'Add scripts/less files to customizer.', function () {
    var fs = require('fs')

    function getFiles(type) {
      var files = {}
      fs.readdirSync(type)
        .filter(function (path) {
fat's avatar
fat committed
230
          return type == 'fonts' ? true : new RegExp('\\.' + type + '$').test(path)
231
232
        })
        .forEach(function (path) {
233
234
          var fullPath = type + '/' + path
          return files[path] = (type == 'fonts' ? btoa(fs.readFileSync(fullPath)) : fs.readFileSync(fullPath, 'utf8'))
235
236
237
238
        })
      return 'var __' + type + ' = ' + JSON.stringify(files) + '\n'
    }

fat's avatar
fat committed
239
    var files = getFiles('js') + getFiles('less') + getFiles('fonts')
240
    fs.writeFileSync('docs-assets/js/raw-files.js', files)
241
  });
242
};