Grunt - 示例文件
在本章中,让我们使用以下插件创建一个简单的 Grunt 文件 -
- grunt-contrib-uglify
- grunt-contrib-concat
- grunt-contrib-jshint
- grunt-contrib-手表
安装上述所有插件并按照下面给出的步骤创建一个简单的Gruntfile.js -
步骤 1 - 您需要创建一个包装函数,它封装 Grunt 的配置。
module.exports = function(grunt) {};
步骤 2 - 初始化您的配置对象,如下所示 -
grunt.initConfig({});
步骤 3 - 接下来,将package.json文件中的项目设置读取到pkg属性中。它使我们能够引用package.json文件中的属性值。
pkg: grunt.file.readJSON('package.json')
步骤 4 - 接下来,您可以定义任务的配置。让我们创建第一个任务concat以连接src/文件夹中存在的所有文件,并将连接的.js文件存储在dist/文件夹下。
concat: { options: { // define a string to insert between files in the concatenated output separator: ';' }, dist: { // files needs to be concatenated src: ['src/**/*.js'], // location of the concatenated output JS file dest: 'dist/<%= pkg.name %>.js' } }
第 5 步- 现在,让我们创建另一个名为uglify的任务来缩小 JavaScript。
uglify: { options: { // banner will be inserted at the top of the output which displays the date and time banner: '/*! <%= pkg.name %> <%= grunt.template.today() %> */\n' }, dist: { files: { 'dist/<%= pkg.name %>.min.js': ['<%= concat.dist.dest %>'] } } }
上述任务在dist / 文件夹中创建一个文件,其中包含缩小的 .js 文件。< %= concat.dist.dest %>将指示uglify缩小 concat 任务生成的文件。
步骤 6 - 让我们通过创建jshint任务来配置 JSHint 插件。
jshint: { // define the files to lint files: ['Gruntfile.js', 'src/**/*.js'], // configure JSHint options: { // more options here if you want to override JSHint defaults globals: { jQuery: true, } } }
上面的jshint任务接受一个文件数组,然后接受一个选项对象。上述任务将查找Gruntfile.js和src/**/*.js文件中的任何编码违规。
步骤 7 - 接下来,我们有监视任务,它查找任何指定文件中的更改并运行您指定的任务。
watch: { files: ['<%= jshint.files %>'], tasks: ['jshint'] }
步骤 8 - 接下来,我们必须加载已通过_npm安装的 Grunt 插件。
grunt.loadNpmTasks('grunt-contrib-uglify'); grunt.loadNpmTasks('grunt-contrib-jshint'); grunt.loadNpmTasks('grunt-contrib-watch'); grunt.loadNpmTasks('grunt-contrib-concat');
步骤 9 - 最后,我们必须定义默认任务。
grunt.registerTask('default', ['jshint', 'concat', 'uglify']);
只需在命令行中键入grunt命令即可运行默认任务。
这是完整的Gruntfile.js -
module.exports = function(grunt) { grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), concat: { options: { separator: ';' }, dist: { src: ['src/**/*.js'], dest: 'dist/<%= pkg.name %>.js' } }, uglify: { options: { banner: '/*! <%= pkg.name %> <%= grunt.template.today() %> */\n' }, dist: { files: { 'dist/<%= pkg.name %>.min.js': ['<%= concat.dist.dest %>'] } } }, jshint: { // define the files to lint files: ['Gruntfile.js', 'src/**/*.js'], // configure JSHint options: { // more options here if you want to override JSHint defaults globals: { jQuery: true, } } }, watch: { files: ['<%= jshint.files %>'], tasks: ['jshint'] } }); grunt.loadNpmTasks('grunt-contrib-uglify'); grunt.loadNpmTasks('grunt-contrib-jshint'); grunt.loadNpmTasks('grunt-contrib-watch'); grunt.loadNpmTasks('grunt-contrib-concat'); grunt.registerTask('default', ['jshint', 'concat', 'uglify']); };