voodoo - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

CHANGELOG.md

@@ -1,2 +0,12 @@
-## v0.0.6 - 14/02/2012
+## v0.0.7 - 15/02/2012
+* updated the readme
+* changed the -c parameter so you don't need to pass a file anymore. Now all config is done inside of voodoo.js, fixed
+
+## v0.0.62 - 15/02/2012
+* updated the options for the `lint` task
+
+## v0.0.61 - 15/02/2012
+* updated the options for the `lint` task
+
+## v0.0.6 - 15/02/2012
 * added `clean` task, should work in harmony with lint/concat, to get prevent recursion
@@ -3,0 +13,0 @@

lib/voodoo.js

@@ -21,3 +21,3 @@ (function() {
 
-  root.version = '0.0.6';
+  root.version = '0.0.7';
 
@@ -49,3 +49,3 @@ root.Voodoo = Voodoo = (function() {
       } else {
-        this.config = __dirname + '/../config.js';
+        this.config = __dirname + '/../voodoo.js';
       }
@@ -78,3 +78,3 @@ tasks = fs.readdirSync(this.needle_dir).filter(function(task) {
   root.cli = function() {
-    p.version(root.version).option('-b, --base <path>', 'working directory for your site (where `assets` folder is in )').option('-v, --verbose', 'verbose output').option('-f, --force', 'a way to force your way past warnings. Want a suggestion? Don\'t use this option, fix your code').option('-c, --config', 'an optional config.js file, replacing the build in config.js').parse(process.argv);
+    p.version(root.version).option('-b, --base <path>', 'working directory for your site (where `assets` folder is in )').option('-v, --verbose', 'verbose output').option('-f, --force', 'a way to force your way past warnings. Want a suggestion? Don\'t use this option, fix your code').option('-c, --custom', 'an custom voodoo.js file, replacing the build in voodoo.js, with your own settings').parse(process.argv);
     return new Voodoo(process.cwd(), p);
@@ -81,0 +81,0 @@ };

package.json

 {
   "name": "voodoo",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "website checker/optimizer/cleaner",
@@ -11,8 +11,8 @@ "repository": {
     "continuous integration",
-  "jslint",
-  "javascript",
-  "minifier",
-  "compiler",
-  "ci"
-    ],
+    "jslint",
+    "javascript",
+    "minifier",
+    "compiler",
+    "ci"
+  ],
   "author": "Proximity BBDO <[e-mail]> (http://github.com/proximitybbdo)",
@@ -19,0 +19,0 @@ "bin": {

README.md

@@ -0,2 +1,35 @@
+Voodoo
+======
 
+Build system for our sites. When invoked, it performs so called 'needles', which contain a series of tasks such as link checking, javascript checking, css minification, ... 
+
+It is build on top of the wonderful [grunt](https://github.com/cowboy/grunt).
+
+Since Voodoo was primary build for our own projects, the default **`voodoo.js`** config file (this is actually just the grunt `config.js` file) will execute a series of tasks tailor made for our framework. This following needles are stung:
+
+task.registerTask("default", "clean lint:files concat min");
+
+* the **clean** needle, removing `assets/js/app.js` and `assets/js/libs.js` if they existed from a previous run
+* the **lint** needle, checking all `*.js` files inside `assets/js/` (**NOT** inside the subsequent `libs` folder) against [jshint](http://www.jshint.com/). Options are set in the `voodoo.js`
+* the **concat** needle, concatenating `assets/js/*.js` into `assets/js/app.js` (which is why we needed the **clean** needle), and all `assets/js/libs/*.js` files into `assets/js/libs.js`
+* the **min** needle, minifying the previous two `js` files
+
+Install
+-------
+Installation is through [npm](http://npmjs.org/), and straightforward:
+`npm install -g voodoo`
+
+Run `voodoo -h` afterwards to get more help.
+
+Usage
+-----
+Inside your website directory, just execute `voodoo` without params to perform the basic tasks, as predefined for our framework (see `config.js` inside the repo)
+
+The following parameters are available
+
+* **-b, --base <path>** - working directory for your site (where `assets` folder is in )
+* **-v, --verbose** - verbose output
+* **-f, --force** - a way to force your way past warnings. Want a suggestion? Don't use this option, fix your code
+* **-c, --config** - an custom voodoo.js file, replacing the build in voodoo.js
+
             .-.'  '.-.
@@ -18,21 +51,1 @@ __  \\//  __
 
-Voodoo
-======
-
-Build system for our sites. When invoked, it performs so called 'needles', which contain a series of tasks such as link checking, javascript checking, css minification, ...
-
-[![Build Status](https://secure.travis-ci.org/proximitybbdo/voodoo.png)](http://travis-ci.org/proximitybbdo/voodoo)
-
-Install
--------
-`npm install -g voodoo`
-
-Usage
------
-Inside your website directory, just execute `voodoo` without params to perform the basic tasks, as predefined for our framework (see `config.js` inside the repo)
-
-You can also use these parameters:
-      -b, --base <path>   working directory for your site (where `assets` folder is in )
-      -v, --verbose       verbose output
-      -f, --force         a way to force your way past warnings. Want a suggestion? Don't use this option, fix your code
-      -c, --config        an optional config.js file, replacing the build in config.js

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

51

increased by34.21%

Worsened metrics

Total package byte prevSize

14275

decreased by-96.18%

Number of package files

14

decreased by-71.43%

Lines of code

169

decreased by-78.08%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes