grunt-jekyll
Advanced tools
Comparing version 0.4.2 to 0.4.3
{ | ||
"name": "grunt-jekyll", | ||
"description": "A custom grunt.js plugin that executes jekyll compile and/or watch for you", | ||
"version": "0.4.2", | ||
"homepage": "https://github.com/dannygarcia/grunt-jekyll", | ||
"author": "Danny Garcia <contact@danny-garcia.com> (http://danny-garcia.com)", | ||
"contributors": ["Rob Wierzbowski <hello@robwierzbowski.com> (http://robwierzbowski.com)"], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/dannygarcia/grunt-jekyll.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/dannygarcia/grunt-jekyll/issues" | ||
}, | ||
"license": "MIT", | ||
"bin": "bin/grunt-jekyll", | ||
"engines": { | ||
"node": ">= 0.10.5" | ||
}, | ||
"dependencies": { | ||
"tmp": "~0.0.23" | ||
}, | ||
"devDependencies": { | ||
"grunt": "~0.4.1", | ||
"grunt-contrib-jshint": "~0.10.0", | ||
"grunt-mocha-test": "~0.10.0" | ||
}, | ||
"peerDependencies": { | ||
"grunt": "~0.4.1" | ||
}, | ||
"scripts" : { | ||
"test" : "grunt test" | ||
}, | ||
"keywords": ["jekyll", "gruntplugin"], | ||
"files": ["bin", "tasks"] | ||
"name": "grunt-jekyll", | ||
"description": "A custom grunt.js plugin that executes jekyll compile and/or watch for you", | ||
"version": "0.4.3", | ||
"homepage": "https://github.com/dannygarcia/grunt-jekyll", | ||
"author": "Danny Garcia <contact@danny-garcia.com> (http://danny-garcia.com)", | ||
"contributors": [ | ||
"Rob Wierzbowski <hello@robwierzbowski.com>", | ||
"Danny Garcia <contact@danny-garcia.com>", | ||
"Tunghsiao Liu <t@sparanoid.com>", | ||
"XhmikosR <xhmikosr@users.sourceforge.net>", | ||
"Alex <alex@recordsonribs.com>", | ||
"Zlatan Vasović <legospace9876@gmail.com>", | ||
"Ian Carrico <Ian@FourKitchens.com>", | ||
"Danny Garcia <dannygarcia@users.noreply.github.com>", | ||
"Kyle Hotchkiss <kyle@kylehotchkiss.com>", | ||
"Matthias Thar <matthias.thar@gmail.com>", | ||
"Mike Fowler <mike@mikefowler.me>", | ||
"Parker Moore <parkrmoore@gmail.com>", | ||
"Chris Rebert <github@rebertia.com>", | ||
"Chase Adams <chase@realchaseadams.com>", | ||
"Bitdeli Chef <chef@bitdeli.com>", | ||
"Jens Krause <info@websector.de>" | ||
], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/dannygarcia/grunt-jekyll.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/dannygarcia/grunt-jekyll/issues" | ||
}, | ||
"license": "MIT", | ||
"bin": "bin/grunt-jekyll", | ||
"engines": { | ||
"node": ">= 0.10.5" | ||
}, | ||
"dependencies": { | ||
"tmp": "^0.0.28" | ||
}, | ||
"devDependencies": { | ||
"grunt": "^0.4.5", | ||
"grunt-bump": "^0.6.0", | ||
"grunt-contrib-jshint": "^0.11.3", | ||
"grunt-conventional-changelog": "^5.0.0", | ||
"grunt-mocha-test": "^0.12.7", | ||
"grunt-npm": "0.0.2", | ||
"load-grunt-tasks": "^3.3.0" | ||
}, | ||
"peerDependencies": { | ||
"grunt": ">=0.4.1" | ||
}, | ||
"scripts": { | ||
"test": "grunt test" | ||
}, | ||
"keywords": [ | ||
"jekyll", | ||
"gruntplugin" | ||
], | ||
"files": [ | ||
"bin", | ||
"tasks" | ||
] | ||
} |
113
README.md
# grunt-jekyll | ||
__Currently seeking someone to maintain this project.__ | ||
[![Build Status](https://travis-ci.org/dannygarcia/grunt-jekyll.svg?branch=master)](https://travis-ci.org/dannygarcia/grunt-jekyll) | ||
@@ -25,3 +27,3 @@ [![Dependency Status](https://david-dm.org/dannygarcia/grunt-jekyll.svg?theme=shields.io)](https://david-dm.org/dannygarcia/grunt-jekyll) | ||
## Jekyll task | ||
## Jekyll Task | ||
@@ -32,2 +34,22 @@ _Run this task with the `grunt jekyll` command._ | ||
### Jekyll Subcommands | ||
#### serve | ||
Type: `boolean` | ||
Default: `false` | ||
Build the site and start a Jekyll development server on `http://localhost:4000`. The server lasts forever: kill it with <kbd>Ctrl</kbd> + <kbd>C</kbd>. | ||
If `serve` is false, the site is built with the `build` command. | ||
For complex projects you may want to use [grunt-contrib-connect](https://github.com/gruntjs/grunt-contrib-connect) or [grunt-browser-sync](https://github.com/BrowserSync/grunt-browser-sync) instead. | ||
#### doctor | ||
Type: `boolean` | ||
Default: `false` | ||
Test your site for common errors and deprecated code. Ignores all other options except `src`, `config`, and `bundleExec`. | ||
### Options | ||
@@ -39,3 +61,3 @@ | ||
Type: `string` <br/> | ||
Type: `string` | ||
Default: `.` | ||
@@ -47,3 +69,3 @@ | ||
Type: `string` <br/> | ||
Type: `string` | ||
Default: `./_site` | ||
@@ -53,5 +75,5 @@ | ||
#### watch | ||
#### [no_]watch | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
@@ -62,23 +84,5 @@ | ||
#### serve | ||
Type: `boolean` <br/> | ||
Default: `false` | ||
Build the site and start a Jekyll development server on http://localhost:4000. The server lasts forever: kill it with <kbd>Ctrl</kbd> + <kbd>C</kbd>. | ||
If `serve` is false, the site is built with the `build` command. | ||
For complex projects you may want to use [grunt-contrib-connect](https://github.com/gruntjs/grunt-contrib-connect) instead. | ||
#### doctor | ||
Type: `boolean` <br/> | ||
Default: `false` | ||
Test your site for common errors and deprecated code. Ignores all other options except `src`, `config`, and `bundleExec`. | ||
#### config | ||
Type: `string` <br/> | ||
Type: `string` | ||
Default: `_config.yml` | ||
@@ -92,14 +96,14 @@ | ||
Create a temporary _config.yml with the contents of `raw`. This config file has greater precedence than the files in `config`. | ||
Create a temporary \_config.yml with the contents of `raw`. This config file has greater precedence than the files in `config`. | ||
#### safe | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
Disables custom plugins. | ||
Disables custom plugins, and ignore symbolic links. | ||
#### plugins | ||
Type: `string` <br/> | ||
Type: `string` | ||
Default: `./_plugins` | ||
@@ -111,3 +115,3 @@ | ||
Type: `string` <br/> | ||
Type: `string` | ||
Default: `./_layouts` | ||
@@ -119,3 +123,3 @@ | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
@@ -127,3 +131,3 @@ | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
@@ -135,3 +139,3 @@ | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
@@ -143,9 +147,33 @@ | ||
Type: `number` <br/> | ||
Type: `number` | ||
Limit the number of posts to parse and publish. | ||
#### force_polling | ||
Type: `boolean` | ||
Force watch to use polling. | ||
#### verbose | ||
Type: `boolean` | ||
Print verbose output. | ||
#### quiet | ||
Type: `boolean` | ||
Silence the normal output from Jekyll during a build. | ||
#### incremental | ||
Type: `boolean` | ||
Enable the experimental incremental build feature. Incremental build only re-builds posts and pages that have changed, resulting in significant performance improvements for large sites, but may also break site generation in certain cases. | ||
#### port | ||
Type: `string` or `number` <br/> | ||
Type: `string` or `number` | ||
@@ -156,3 +184,3 @@ Listen on the given port (requires `serve`). | ||
Type: `string` <br/> | ||
Type: `string` | ||
@@ -163,9 +191,15 @@ Listen at the given hostname (requires `serve`). | ||
Type: `string` <br/> | ||
Type: `string` | ||
Serve the website from the given base URL (requires `serve`). | ||
#### skip_initial_build | ||
Type: `boolean` | ||
Skips the initial site build which occurs before the server is started. | ||
#### bundleExec | ||
Type: `boolean` <br/> | ||
Type: `boolean` | ||
Default: `false` | ||
@@ -196,4 +230,6 @@ | ||
options: { | ||
serve: true, | ||
dest: '.jekyll', | ||
drafts: true | ||
drafts: true, | ||
future: true | ||
} | ||
@@ -234,2 +270,3 @@ } | ||
- v0.4.3: More options support for Jekyll 3.0.0 | ||
- v0.4.2: More internal optimizations. | ||
@@ -236,0 +273,0 @@ - v0.4.1: Internal optimizations. |
@@ -14,2 +14,3 @@ 'use strict'; | ||
var optionList = { | ||
// Global Options | ||
'src': '--source', | ||
@@ -20,4 +21,9 @@ 'dest': '--destination', | ||
'layouts': '--layouts', | ||
'profile': '--profile', | ||
'trace': '--trace', | ||
// Build Command Options | ||
'auto': '--watch', | ||
'watch': '--watch', | ||
'auto': '--watch', | ||
'no_watch': '--no-watch', | ||
'config': '--config', | ||
@@ -28,2 +34,8 @@ 'drafts': '--drafts', | ||
'limit_posts': '--limit_posts', | ||
'force_polling': '--force_polling', | ||
'verbose': '--verbose', | ||
'quiet': '--quiet', | ||
'incremental': '--incremental', | ||
// Serve Command Options | ||
'port': '--port', | ||
@@ -33,3 +45,3 @@ 'server_port': '--port', | ||
'baseurl': '--baseurl', | ||
'trace': '--trace', | ||
'skip_initial_build': '--skip-initial-build', | ||
@@ -87,15 +99,19 @@ // Deprecated flags | ||
var cmd = command; | ||
var args = []; | ||
// Build the command string | ||
if (options.bundleExec) { | ||
command = 'bundle exec ' + command; | ||
cmd = 'bundle'; | ||
args = ['exec', command]; | ||
} | ||
if (options.serve) { | ||
command += majorVersion > 0 ? ' serve' : ' server'; | ||
args.push(majorVersion > 0 ? 'serve' : 'server'); | ||
} | ||
else if (options.doctor) { | ||
command += ' doctor'; | ||
args.push('doctor'); | ||
} | ||
else { | ||
command += ' build'; | ||
args.push('build'); | ||
} | ||
@@ -112,5 +128,5 @@ | ||
if (options[option]) { | ||
command += ' ' + optionList[option]; | ||
args.push(optionList[option]); | ||
if (typeof options[option] !== 'boolean') { | ||
command += ' ' + options[option]; | ||
args.push(options[option]); | ||
} | ||
@@ -123,5 +139,12 @@ if (!options[option]) { | ||
} | ||
else { | ||
if (options.src) { | ||
args.push(optionList.src); | ||
args.push(options.src); | ||
} | ||
} | ||
// Execute command | ||
grunt.log.write('`' + command + '` was initiated.\n'); | ||
command = cmd + ' ' + args.join(' '); | ||
grunt.log.write('`' + command + '` was initiated.\n\n'); | ||
@@ -132,5 +155,3 @@ if (options.serve) { | ||
exec(command, function (err, stdout) { | ||
grunt.log.write('\n\nJekyll output:\n' + stdout); | ||
var child = grunt.util.spawn({cmd: cmd, args: args}, function (err) { | ||
if (err) { | ||
@@ -144,2 +165,4 @@ grunt.fail.warn(err); | ||
}); | ||
child.stdout.pipe(process.stdout); | ||
child.stderr.pipe(process.stderr); | ||
} | ||
@@ -146,0 +169,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
14112
148
290
7
2
+ Addedansi-styles@4.3.0(transitive)
+ Addedargparse@1.0.10(transitive)
+ Addedarray-each@1.0.1(transitive)
+ Addedarray-slice@1.1.0(transitive)
+ Addedasync@3.2.6(transitive)
+ Addedbalanced-match@1.0.2(transitive)
+ Addedbrace-expansion@1.1.11(transitive)
+ Addedbraces@3.0.3(transitive)
+ Addedchalk@4.1.2(transitive)
+ Addedcolor-convert@2.0.1(transitive)
+ Addedcolor-name@1.1.4(transitive)
+ Addedcolors@1.1.2(transitive)
+ Addedconcat-map@0.0.1(transitive)
+ Addeddateformat@4.6.3(transitive)
+ Addeddetect-file@1.0.0(transitive)
+ Addedesprima@4.0.1(transitive)
+ Addedexpand-tilde@2.0.2(transitive)
+ Addedextend@3.0.2(transitive)
+ Addedfill-range@7.1.1(transitive)
+ Addedfindup-sync@4.0.05.0.0(transitive)
+ Addedfined@1.2.0(transitive)
+ Addedflagged-respawn@1.0.1(transitive)
+ Addedfor-in@1.0.2(transitive)
+ Addedfor-own@1.0.0(transitive)
+ Addedfs.realpath@1.0.0(transitive)
+ Addedfunction-bind@1.1.2(transitive)
+ Addedgetobject@1.0.2(transitive)
+ Addedglob@7.1.7(transitive)
+ Addedglobal-modules@1.0.0(transitive)
+ Addedglobal-prefix@1.0.2(transitive)
+ Addedgrunt@1.6.1(transitive)
+ Addedgrunt-cli@1.4.3(transitive)
+ Addedgrunt-known-options@2.0.0(transitive)
+ Addedgrunt-legacy-log@3.0.0(transitive)
+ Addedgrunt-legacy-log-utils@2.1.0(transitive)
+ Addedgrunt-legacy-util@2.0.1(transitive)
+ Addedhas-flag@4.0.0(transitive)
+ Addedhasown@2.0.2(transitive)
+ Addedhomedir-polyfill@1.0.3(transitive)
+ Addediconv-lite@0.6.3(transitive)
+ Addedinflight@1.0.6(transitive)
+ Addedini@1.3.8(transitive)
+ Addedinterpret@1.1.0(transitive)
+ Addedis-absolute@1.0.0(transitive)
+ Addedis-core-module@2.15.1(transitive)
+ Addedis-extglob@2.1.1(transitive)
+ Addedis-glob@4.0.3(transitive)
+ Addedis-number@7.0.0(transitive)
+ Addedis-plain-object@2.0.4(transitive)
+ Addedis-relative@1.0.0(transitive)
+ Addedis-unc-path@1.0.0(transitive)
+ Addedis-windows@1.0.2(transitive)
+ Addedisexe@2.0.0(transitive)
+ Addedisobject@3.0.1(transitive)
+ Addedjs-yaml@3.14.1(transitive)
+ Addedkind-of@6.0.3(transitive)
+ Addedliftup@3.0.1(transitive)
+ Addedlodash@4.17.21(transitive)
+ Addedmake-iterator@1.0.1(transitive)
+ Addedmap-cache@0.2.2(transitive)
+ Addedmicromatch@4.0.8(transitive)
+ Addedminimatch@3.0.8(transitive)
+ Addednopt@3.0.64.0.3(transitive)
+ Addedobject.defaults@1.1.0(transitive)
+ Addedobject.map@1.0.1(transitive)
+ Addedobject.pick@1.3.0(transitive)
+ Addedonce@1.4.0(transitive)
+ Addedos-homedir@1.0.2(transitive)
+ Addedosenv@0.1.5(transitive)
+ Addedparse-filepath@1.0.2(transitive)
+ Addedparse-passwd@1.0.0(transitive)
+ Addedpath-is-absolute@1.0.1(transitive)
+ Addedpath-parse@1.0.7(transitive)
+ Addedpath-root@0.1.1(transitive)
+ Addedpath-root-regex@0.1.2(transitive)
+ Addedpicomatch@2.3.1(transitive)
+ Addedrechoir@0.7.1(transitive)
+ Addedresolve@1.22.8(transitive)
+ Addedresolve-dir@1.0.1(transitive)
+ Addedsafer-buffer@2.1.2(transitive)
+ Addedsprintf-js@1.0.31.1.3(transitive)
+ Addedsupports-color@7.2.0(transitive)
+ Addedsupports-preserve-symlinks-flag@1.0.0(transitive)
+ Addedtmp@0.0.28(transitive)
+ Addedto-regex-range@5.0.1(transitive)
+ Addedunc-path-regex@0.1.2(transitive)
+ Addedunderscore.string@3.3.6(transitive)
+ Addedutil-deprecate@1.0.2(transitive)
+ Addedv8flags@3.2.0(transitive)
+ Addedwhich@1.3.12.0.2(transitive)
+ Addedwrappy@1.0.2(transitive)
- Removedargparse@0.1.16(transitive)
- Removedasync@0.1.22(transitive)
- Removedcoffee-script@1.3.3(transitive)
- Removedcolors@0.6.2(transitive)
- Removeddateformat@1.0.2-1.2.3(transitive)
- Removedesprima@1.0.4(transitive)
- Removedfindup-sync@0.1.3(transitive)
- Removedgetobject@0.1.0(transitive)
- Removedglob@3.1.213.2.11(transitive)
- Removedgraceful-fs@1.2.3(transitive)
- Removedgrunt@0.4.5(transitive)
- Removedgrunt-legacy-log@0.1.3(transitive)
- Removedgrunt-legacy-log-utils@0.1.1(transitive)
- Removedgrunt-legacy-util@0.2.0(transitive)
- Removediconv-lite@0.2.11(transitive)
- Removedinherits@1.0.2(transitive)
- Removedjs-yaml@2.0.5(transitive)
- Removedlodash@0.9.22.4.2(transitive)
- Removedlru-cache@2.7.3(transitive)
- Removedminimatch@0.2.140.3.0(transitive)
- Removednopt@1.0.10(transitive)
- Removedrimraf@2.2.8(transitive)
- Removedsigmund@1.0.1(transitive)
- Removedtmp@0.0.33(transitive)
- Removedunderscore@1.7.0(transitive)
- Removedunderscore.string@2.2.12.3.32.4.0(transitive)
- Removedwhich@1.0.9(transitive)
Updatedtmp@^0.0.28