Grunt - образец файла

В этой главе давайте создадим простой файл Grunt, используя следующие плагины:

  • grunt-contrib-uglify
  • grunt-contrib-concat
  • grunt-contrib-jshint
  • grunt-contrib-watch

Установите все вышеперечисленные плагины и следуйте инструкциям ниже, чтобы создать простой Gruntfile.js -

Step 1- Вам необходимо создать функцию- оболочку , которая инкапсулирует конфигурации для вашего Grunt.

module.exports = function(grunt) {};

Step 2 - Инициализируйте свой объект конфигурации, как показано ниже -

grunt.initConfig({});

Step 3- Затем прочтите настройки проекта из файла package.json в свойстве pkg . Это позволяет нам обращаться к значениям свойств в вашем файле package.json .

pkg: grunt.file.readJSON('package.json')

Step 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'
   }
}

Step 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 .

Step 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 .

Step 7- Далее у нас есть задача наблюдения, которая ищет изменения в любом из указанных файлов и запускает указанные вами задачи.

watch: {
   files: ['<%= jshint.files %>'],
   tasks: ['jshint']
}

Step 8- Затем мы должны загрузить плагины Grunt, которые были установлены через _npm .

grunt.loadNpmTasks('grunt-contrib-uglify');

grunt.loadNpmTasks('grunt-contrib-jshint');

grunt.loadNpmTasks('grunt-contrib-watch');

grunt.loadNpmTasks('grunt-contrib-concat');

Step 9- Наконец, мы должны определить задачу по умолчанию .

grunt.registerTask('default', ['jshint', 'concat', 'uglify']);

По умолчанию задача может быть запущена, просто набрав черновую команду в командной строке.

Вот ваш полный 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']);

};