chevron-left chevron-right

Piotr Nalepa Frontend, architecture and AI

[JS] Jak lepiej zorganizować swoją pracę z Grunt.js?

This version
blog.piotrnalepa.pl/2014/05/19/js-jak-lepiej-zorganizowac-swoja-prace-z-grunt-js
Published
Author
, Staff Software Engineer
Category
JavaScript
Feedback
Write to me · Post on X

This post is 12 years old. Browsers and tools may have changed since then, so check the code against current documentation before you use it.

Grunt.js jest wspaniałym narzędziem, dzięki któremu możemy usprawnić naszą codzienną pracę przy tworzeniu kodu stron WWW czy też aplikacji internetowych. Praca z Grunt.js w głównej mierze polega na odpowiednim konfigurowaniu dostępnych modułów. W miarę upływu czasu, plik konfiguracyjny - Gruntfile.js, może urosnąć znacząco przez co zarządzanie modułami będzie utrudnione. Czy da się to usprawnić? Jasne, że tak.

Section 1Dotychczasowa praca z Grunt.js

Być może pamiętasz wpis, który napisałem jakiś czas temu odnośnie tego w jaki sposób Grunt.js wpływa na polepszenie pracy webdevelopera, dlatego nie będę się powtarzał. Skupię się natomiast na tym jak można usprawnić pracę z jego plikiem konfiguracyjnym. W tamtym artykule możesz znaleźć przykład pliku konfiguracyjnego, który z biegiem czasu może się rozrosnąć i utrudnić pracę podczas kodowania.

Section 2Przygotowanie narzędzi do usprawnienia

Aby rozpocząć usprawnianie zarządzaniem kodu Gruntfile.js musimy zainstalować 2 dodatkowe rozszerzenia do Grunt.js - load-grunt-config oraz load-grunt-tasks. Zrobimy to za pomocą następujących komend:

Section 2.1Instalacja load-grunt-config

npm install load-grunt-config --save-dev

Section 2.2Instalacja load-grunt-tasks

npm install load-grunt-tasks --save-dev

Section 2.3Przenoszenie konfiguracji do osobnych plików

Następnie, konfigurację rozszerzeń w pliku Gruntfile.js musimy przepisać do osobnych plików w folderze grunt - który jest domyślnym folderem, gdzie rozszerzenie load-grunt-config szuka plików konfiguracyjnych (można to zmienić w razie potrzeby).

Dotychczas w pliku Gruntfile.js można było znaleźć taki zapis:

Example 1JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Gruntfile.js
grunt.initConfig({
  uglify  : {
    build : {
      src     : ['**/*.js', '!*.min.js'],
      cwd     : 'dev/js/',
      dest    : 'dev/js/min/',
      expand  : true,
      rename  : function (dest, src) {
        var folder    = src.substring(0, src.lastIndexOf('/'));
        var filename  = src.substring(src.lastIndexOf('/'), src.length);
 
        filename  = filename.substring(0, filename.lastIndexOf('.'));
 
        return dest + folder + filename + '.min.js';
      }
    }
  }
});

Konfigurację rozszerzenia uglify przenosimy do folderu grunt:

Example 2JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// grunt/uglify.js
module.exports = {
  build : {
    src     : ['**/*.js', '!*.min.js'],
    cwd     : 'dev/js/',
    dest    : 'dev/js/min/',
    expand  : true,
    rename  : function (dest, src) {
      var folder    = src.substring(0, src.lastIndexOf('/'));
      var filename  = src.substring(src.lastIndexOf('/'), src.length);
 
      filename  = filename.substring(0, filename.lastIndexOf('.'));
 
      return dest + folder + filename + '.min.js';
    }
  }
};

Następnie z pliku Gruntfile.js usuwamy całą dotychczasową konfigurację i kod odpowiadający za ładowanie zadań (tasków) rozszerzeń i zastępujemy to następującym kodem:

Example 3JavaScript
1
2
3
4
5
6
7
// Gruntfile.js
module.exports = function(grunt) {
  require('load-grunt-config')(grunt);
  require('load-grunt-tasks')(grunt);
 
  grunt.registerTask('default', ['uglify']);
};

Voila! Plik Gruntfile.js jest teraz czysty i można łatwiej definiować nowe zadania (taski) wg własnego upodobania. Cała konfiguracja wymaganych rozszerzeń znajduje się teraz w osobnych plikach - dla każdego rozszerzenia osobno, w folderze grunt.

Section 3Podsumowanie

Jak widać, można znacząco sobie ułatwić proces zarządzania konfiguracjami rozszerzeń poprzez przeniesienie ich z pliku Gruntfile.js do osobnych plików odpowiedzialnych za dane rozszerzenie. Należy jednak pamiętać o tym, aby nazwa pliku posiadała nazwę zadania danego rozszerzenia, tzn. plik z konfiguracją dla rozszerzenia grunt-contrib-uglify będzie nazywał się uglify.js, ponieważ uglify jest nazwą zadania (taska) tego rozszerzenia.

Share
Feedback

About the author

Staff Software Engineer

I've been writing this blog since 2009 and building for the web professionally for 14 years. Today I lead the frontend of the Cosmos platform at Bishop Fox, where I've been since day one of the project. Before that I worked at OLX, KUDO, Auto1 and eZ Systems. Here I write about what I've learned in practice: JavaScript, TypeScript, React, CSS and frontend architecture. I've also spoken at conferences across Poland and Europe. Got a question or an idea for a post? Let me know!