JavaScript 自己管理とは、Grunt タスク自動管理ツールを指します。Grunt は、さまざまなタスクを自動的に管理および実行するのに役立ちます。Grunt は、事前に設定された順序で一連のタスクを自動的に実行する自動タスク ランナーです。ワークフローを合理化し、繰り返しの作業の負担を軽減します。
この記事の動作環境: Windows7 システム、JavaScript バージョン 1.8.5、Dell G3 コンピューター。
JavaScript 自己管理、Grunt とは: 自動タスク管理ツール
安装命令脚本文件Gruntfile.jsGruntfile.js实例:grunt-contrib-cssmin模块常用模块设置grunt-contrib-jshintgrunt-contrib-concatgrunt-contrib-uglifygrunt-contrib-copygrunt-contrib-watch其他模块参考链接
JavaScript の開発プロセスでは、ファイルのマージ、コードの圧縮、チェックなどの反復的なタスクに遭遇することがよくあります。構文エラー、Sass コードから CSS コードへの変換など。通常、さまざまなタスクを完了するにはさまざまなツールを使用する必要がありますが、これは反復的で非常に時間がかかります。 Grunt はこの問題を解決するために発明されたツールで、さまざまなタスクを自動的に管理および実行するのに役立ちます。
簡単に言えば、Grunt は、事前に設定された順序で一連のタスクを自動的に実行する自動タスク ランナーです。これによりワークフローが合理化され、反復的なタスクの負担が軽減されます。
インストール
Grunt は Node.js に基づいています。インストールする前に、まず Node.js をインストールしてから、次のコマンドを実行する必要があります。
sudo npm install grunt-cli -g
grunt-cli は grunt コマンド ライン インターフェイスがインストールされていることを示し、パラメータ g はグローバル インストールを示します。
Grunt はモジュール構造を使用しているため、コマンド ライン インターフェイスのインストールに加えて、必要に応じて対応するモジュールもインストールする必要があります。プロジェクトごとに同じモジュールの異なるバージョンが必要になる場合があるため、これらのモジュールはローカルにインストールする必要があります。
まず、プロジェクトのルート ディレクトリにテキスト ファイル package.json を作成し、現在のプロジェクトに必要なモジュールを指定します。ここに例を示します。
{"name": "my-project-name","version": "0.1.0","author": "Your Name","devDependencies": {"grunt": "0.x.x","grunt-contrib-jshint": "*","grunt-contrib-concat": "~0.1.1","grunt-contrib-uglify": "~0.1.0","grunt-contrib-watch": "~0.1.4"}}
上記の package.json ファイルでは、プロジェクトの名前とバージョンを示すだけでなく、プロジェクトが依存する grunt モジュールとバージョンも devDependency 属性で指定されています。grunt コア モジュールは最新バージョン 0.x.x 、jshint プラグインは最新バージョン、concat プラグインはバージョン 0.1.1 以上、uglify プラグインはバージョン 0.1.0 以上、watch プラグインバージョン 0.1.4 以上です。
次に、プロジェクトのルート ディレクトリで次のコマンドを実行すると、これらのプラグインが自動的に node_modules サブディレクトリにインストールされます。
npm install
上記の方法は、package.json が既に存在する場合の方法です。 package.json ファイルを自動的に生成する場合は、npm init コマンドを使用し、画面上のプロンプトに従って必要なモジュールの名前とバージョンを入力します。
npm init
既存の package.json ファイルに Grunt モジュールが含まれていない場合は、Grunt モジュールを直接インストールするときに --save-dev パラメータを追加すると、モジュールが package.json に自動的に追加されます。ファイル。
npm install--save-dev
たとえば、上記の package.json ファイルで指定されたモジュールに対応して、次の npm コマンドを実行する必要があります。
npm install grunt --save-devnpm install grunt-contrib-jshint --save-devnpm install grunt-contrib-concat --save-devnpm install grunt-contrib-uglify --save-devnpm install grunt-contrib-watch --save-dev命令脚本文件Gruntfile.js
モジュールがインストールされたら、次のステップは、プロジェクトのルート ディレクトリに新しいスクリプト ファイル Gruntfile.js を作成することです。 package.json が npm の設定ファイルであるのと同様に、これは grunt の設定ファイルです。 Gruntfile.js は、一般的な Node.js モジュールを記述する方法です。
module.exports = function(grunt) {// 配置Grunt各种模块的参数grunt.initConfig({jshint: { /* jshint的参数 */ },concat: { /* concat的参数 */ },uglify: { /* uglify的参数 */ },watch:{ /* watch的参数 */ }});// 从node_modules目录加载模块文件grunt.loadNpmTasks('grunt-contrib-jshint');grunt.loadNpmTasks('grunt-contrib-concat');grunt.loadNpmTasks('grunt-contrib-uglify');grunt.loadNpmTasks('grunt-contrib-watch');// 每行registerTask定义一个任务grunt.registerTask('default', ['jshint', 'concat', 'uglify']);grunt.registerTask('check', ['jshint']);};
上記のコードでは、grunt コードの 3 つのメソッドが使用されています。
grunt.initConfig: さまざまなモジュールのパラメーターを定義し、各メンバー項目は同じ名前のモジュールに対応します。 grunt.loadNpmTasks: タスクを完了するために必要なモジュールをロードします。 grunt.registerTask: 特定のタスクを定義します。最初のパラメータはタスク名で、2 番目のパラメータはタスクが順番に使用する必要があるモジュールを示す配列です。デフォルトのタスク名は、grunt コマンドがパラメータなしで直接入力された場合に、この時点で呼び出されるモジュール (この例では jshint、concat、および uglify) を示します。この例のチェック タスクは、jshint プラグインを使用して、コード構文。
上記のコードは、jshint (構文エラーのチェック)、concat (ファイルのマージ)、uglify (コードの圧縮)、および watch (自動実行) の合計 4 つのモジュールを読み込みます。次に、使い方は2通りあります。
[推奨学習: javascript 上級チュートリアル ]
(1)
grunt jshint
などの特定のモジュールを実行するコマンド ライン。上記のコードは次のことを示します。 jshint モジュールを実行します。
(2) 特定のタスクを実行するためのコマンド ライン。たとえば、
grunt check
上記のコードは、チェック タスクの実行を示しています。操作が成功すると、「エラーなしで完了しました。」と表示されます。
タスク名が指定されていない場合は、「grunt」と入力するだけでデフォルトのタスクが実行されます。
Gruntfile.js の例: grunt-contrib-cssmin モジュール
以下では、cssmin モジュールを使用して、Gruntfile.js ファイルの作成方法を示します。 cssmin モジュールは、CSS ファイルを最小化するために使用されます。
まず、プロジェクトのルート ディレクトリにモジュールをインストールします。
npm install grunt-contrib-cssmin --save-dev
次に、新しいファイル Gruntfile.js を作成します。
module.exports = function(grunt) {grunt.initConfig({cssmin: {minify: {expand: true,cwd: 'css/',src: ['*.css', '!*.min.css'],dest: 'css/',ext: '.min.css'},combine: {files: {'css/out.min.css': ['css/part1.min.css', 'css/part2.min.css']}}}});grunt.loadNpmTasks('grunt-contrib-cssmin');grunt.registerTask('default', ['cssmin:minify','cssmin:combine']);};
上記のコード内の 3 つのメソッドについては、以下で詳しく説明します。1 つずつ見てみましょう。
(1)grunt.loadNpmTasks
grunt.loadNpmTasks メソッドはモジュール ファイルを読み込みます。
grunt.loadNpmTasks('grunt-contrib-cssmin');
複数のモジュールを使用する必要があります。ここでは、各モジュールを 1 つずつロードするためにいくつかの grunt.loadNpmTasks ステートメントを記述する必要があります。
如果加载模块很多,这部分会非常冗长。而且,还存在一个问题,就是凡是在这里加载的模块,也同时出现在package.json文件中。如果使用npm命令卸载模块以后,模块会自动从package.json文件中消失,但是必须手动从Gruntfile.js文件中清除,这样很不方便,一旦忘记,还会出现运行错误。这里有一个解决办法,就是安装load-grunt-tasks模块,然后在Gruntfile.js文件中,用下面的语句替代所有的grunt.loadNpmTasks语句。
require('load-grunt-tasks')(grunt);
这条语句的作用是自动分析package.json文件,自动加载所找到的grunt模块。
(2)grunt.initConfig
grunt.initConfig方法用于模块配置,它接受一个对象作为参数。该对象的成员与使用的同名模块一一对应。由于我们要配置的是cssmin模块,所以里面有一个cssmin成员(属性)。
cssmin(属性)指向一个对象,该对象又包含多个成员。除了一些系统设定的成员(比如options),其他自定义的成员称为目标(target)。一个模块可以有多个目标(target),上面代码里面,cssmin模块共有两个目标,一个是“minify”,用于压缩css文件;另一个是“combine”,用于将多个css文件合并一个文件。
每个目标的具体设置,需要参考该模板的文档。就cssmin来讲,minify目标的参数具体含义如下:
expand:如果设为true,就表示下面文件名的占位符(即*号)都要扩展成具体的文件名。cwd:需要处理的文件(input)所在的目录。src:表示需要处理的文件。如果采用数组形式,数组的每一项就是一个文件名,可以使用通配符。dest:表示处理后的文件名或所在目录。ext:表示处理后的文件后缀名。
除了上面这些参数,还有一些参数也是grunt所有模块通用的。
filter:一个返回布尔值的函数,用于过滤文件名。只有返回值为true的文件,才会被grunt处理。dot:是否匹配以点号(.)开头的系统文件。makeBase:如果设置为true,就只匹配文件路径的最后一部分。比如,a?b可以匹配/xyz/123/acb,而不匹配/xyz/acb/123。
关于通配符,含义如下:
*:匹配任意数量的字符,不包括/。?:匹配单个字符,不包括/。**:匹配任意数量的字符,包括/。{}:允许使用逗号分隔的列表,表示“or”(或)关系。!:用于模式的开头,表示只返回不匹配的情况。
比如,foo/.js匹配foo目录下面的文件名以.js结尾的文件,foo/**/.js匹配foo目录和它的所有子目录下面的文件名以.js结尾的文件,!*.css表示匹配所有后缀名不为“.css”的文件。
使用通配符设置src属性的更多例子:
{src: 'foo/th*.js'}grunt-contrib-uglify{src: 'foo/{a,b}*.js'}{src: ['foo/a*.js', 'foo/b*.js']}
至于combine目标,就只有一个files参数,表示输出文件是css子目录下的out.min.css,输入文件则是css子目录下的part1.min.css和part2.min.css。
files参数的格式可以是一个对象,也可以是一个数组。
files: {'dest/b.js': ['src/bb.js', 'src/bbb.js'],'dest/b1.js': ['src/bb1.js', 'src/bbb1.js'],},// orfiles: [{src: ['src/aa.js', 'src/aaa.js'], dest: 'dest/a.js'},{src: ['src/aa1.js', 'src/aaa1.js'], dest: 'dest/a1.js'},],
如果minify目标和combine目标的属性设置有重合的部分,可以另行定义一个与minify和combine平行的options属性。
grunt.initConfig({cssmin: {options: { /* ... */ },minify: { /* ... */ },combine: { /* ... */ }}});
(3)grunt.registerTask
grunt.registerTask方法定义如何调用具体的任务。“default”任务表示如果不提供参数,直接输入grunt命令,则先运行“cssmin:minify”,后运行“cssmin:combine”,即先压缩再合并。如果只执行压缩,或者只执行合并,则需要在grunt命令后面指明“模块名:目标名”。
grunt # 默认情况下,先压缩后合并grunt cssmin:minify # 只压缩不合并grunt css:combine # 只合并不压缩
如果不指明目标,只是指明模块,就表示将所有目标依次运行一遍。
grunt cssmin常用模块设置
grunt的模块已经超过了2000个,且还在快速增加。下面是一些常用的模块(按字母排序)。
grunt-contrib-clean:删除文件。grunt-contrib-compass:使用compass编译sass文件。grunt-contrib-concat:合并文件。grunt-contrib-copy:复制文件。grunt-contrib-cssmin:压缩以及合并CSS文件。grunt-contrib-imagemin:图像压缩模块。grunt-contrib-jshint:检查JavaScript语法。grunt-contrib-uglify:压缩以及合并JavaScript文件。grunt-contrib-watch:监视文件变动,做出相应动作。
模块的前缀如果是grunt-contrib,就表示该模块由grunt开发团队维护;如果前缀是grunt(比如grunt-pakmanager),就表示由第三方开发者维护。
以下选几个模块,看看它们配置参数的写法,也就是说如何在grunt.initConfig方法中配置各个模块。
grunt-contrib-jshint
jshint用来检查语法错误,比如分号的使用是否正确、有没有忘记写括号等等。它在grunt.initConfig方法里面的配置代码如下。
jshint: {options: {eqeqeq: true,trailing: true},files: ['Gruntfile.js', 'lib/**/*.js']},
上面代码先指定jshint的检查项目,eqeqeq表示要用严格相等运算符取代相等运算符,trailing表示行尾不得有多余的空格。然后,指定files属性,表示检查目标是Gruntfile.js文件,以及lib目录的所有子目录下面的JavaScript文件。
grunt-contrib-concat
concat用来合并同类文件,它不仅可以合并JavaScript文件,还可以合并CSS文件。
concat: {js: {src: ['lib/module1.js', 'lib/module2.js', 'lib/plugin.js'],dest: 'dist/script.js'}css: {src: ['style/normalize.css', 'style/base.css', 'style/theme.css'],dest: 'dist/screen.css'}},
js目标用于合并JavaScript文件,css目标用语合并CSS文件。两者的src属性指定需要合并的文件(input),dest属性指定输出的目标文件(output)。
grunt-contrib-uglify
uglify模块用来压缩代码,减小文件体积。
uglify: {options: {banner: bannerContent,sourceMapRoot: '../',sourceMap: 'distrib/'+name+'.min.js.map',sourceMapUrl: name+'.min.js.map'},target : {expand: true,cwd: 'js/origin',src : '*.js',dest : 'js/'}},
上面代码中的options属性指定压缩后文件的文件头,以及sourceMap设置;target目标指定输入和输出文件。
grunt-contrib-copy
copy模块用于复制文件与目录。
copy: {main: {src: 'src/*',dest: 'dest/',},},
上面代码将src子目录(只包含它下面的第一层文件和子目录),拷贝到dest子目录下面(即dest/src目录)。如果要更准确控制拷贝行为,比如只拷贝文件、不拷贝目录、不保持目录结构,可以写成下面这样:
copy: {main: {expand: true,cwd: 'src/',src: '**',dest: 'dest/',flatten: true,filter: 'isFile',},},grunt-contrib-watch
watch模块用来在后台运行,监听指定事件,然后自动运行指定的任务。
watch: { scripts: {files: '**/*.js',tasks: 'jshint',options: {livereload: true,}, }, css: {files: '**/*.sass',tasks: ['sass'],options: {livereload: true,}, },},
设置好上面的代码,打开另一个进程,运行grunt watch。此后,任何的js代码变动,文件保存后就会自动运行jshint任务;任何sass文件变动,文件保存后就会自动运行sass任务。
需要注意的是,这两个任务的options参数之中,都设置了livereload,表示任务运行结束后,自动在浏览器中重载(reload)。这需要在浏览器中安装livereload插件。安装后,livereload的默认端口为localhost:35729,但是也可以用livereload: 1337的形式重设端口(localhost:1337)。
其他模块
下面是另外一些有用的模块。
(1)grunt-contrib-clean
该模块用于删除文件或目录。
clean: {build: {src: ["path/to/dir/one", "path/to/dir/two"]}}
(2)grunt-autoprefixer
该模块用于为CSS语句加上浏览器前缀。
autoprefixer: {build: {expand: true,cwd: 'build',src: [ '**/*.css' ],dest: 'build'}},
(3)grunt-contrib-connect
该模块用于在本机运行一个Web Server。
connect: {server: {options: {port: 4000,base: 'build',hostname: '*'}}}
connect模块会随着grunt运行结束而结束,为了使它一直处于运行状态,可以把它放在watch模块之前运行。因为watch模块需要手动中止,所以connect模块也就会一直运行。
(4)grunt-htmlhint
该模块用于检查HTML语法。
htmlhint: {build: {options: {'tag-pair': true,'tagname-lowercase': true,'attr-lowercase': true,'attr-value-double-quotes': true,'spec-char-escape': true,'id-unique': true,'head-script-disabled': true,},src: ['index.html']}}
上面代码用于检查index.html文件:HTML标记是否配对、标记名和属性名是否小写、属性值是否包括在双引号之中、特殊字符是否转义、HTML元素的id属性是否为唯一值、head部分是否没有script标记。
(5)grunt-contrib-sass模块
该模块用于将SASS文件转为CSS文件。
sass: {build: {options: {style: 'compressed'},files: {'build/css/master.css': 'assets/sass/master.scss'}}}
上面代码指定输出文件为build/css/master.css,输入文件为assets/sass/master.scss。
(6)grunt-markdown
该模块用于将markdown文档转为HTML文档。
markdown: {all: {files: [{expand: true,src: '*.md',dest: 'docs/html/',ext: '.html'}],options: {template: 'templates/index.html',}}},
上面代码指定将md后缀名的文件,转为docs/html/目录下的html文件。template属性指定转换时采用的模板,模板样式如下。
Document参考链接Frederic Hemberger, A build tool for front-end projectsMária Jurčovičová, Building a JavaScript Library with Grunt.jsBen Briggs,Speed Up Your Web Development Workflow with GruntOptimizing Images With GruntSwapnil Mishra, Simplifying Chores with GruntAJ ONeal, Moving to GruntJSGrunt Documentation, Configuring tasksLandon Schropp, Writing an Awesome Build Script with GruntMike Cunsolo, Get Up And Running With GruntMatt Bailey, A Beginner’s Guide to Using Grunt With MagentoPaul Bakaus, Supercharging your Gruntfile
以上がJavaScript 自己管理とはの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。