grunt-command-run - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

Gruntfile.js

@@ -52,3 +52,4 @@ /*
                         }
-                    }
+                    },
+                    quiet: true
                 },
@@ -55,0 +56,0 @@ files: [{

package.json

 {
   "name": "grunt-command-run",
-  "description": "Grunt plugin for easily run command line tools for your files",
-  "version": "0.1.0",
+  "description": "Grunt plugin for easily run command line (CLI) tools for your files",
+  "version": "0.1.1",
   "homepage": "https://github.com/Kreozot/grunt-command-run",
@@ -40,4 +40,8 @@ "author": {
   "keywords": [
-    "gruntplugin"
+    "gruntplugin",
+    "grunt",
+    "cli",
+    "command",
+    "command-line"
   ]
 }

README.md

 # grunt-command-run
 
-> Grunt plugin for easily run command line tools for your files
+Grunt plugin for easily run command line tools for your files.
 
+Have an external tool and want to process your source file with it? Use this plugin!
+
 ## Getting Started
@@ -25,13 +27,30 @@ This plugin requires Grunt `~0.4.5`
 
+
+### Usage Example
+
+XSLT templates compilation:
+
 ```js
 grunt.initConfig({
+    // The task
     command_run: {
-        your_target: {
+        // Your target
+        compile_xslt: {
             options: {
-                getCommand: function(file, dest) {
-                    var commandLine = 'tool ' + file + ' ' + dest;
-                    return commandLine;
-                }
+                // Callback function that returns command for processing one of your files
+                getCommand: function(filepath, dest) {
+                    // Do some stuff, e.g. take just filename from relative filepath
+                    var fileName = filepath.split("/").pop();
+                    // Return command line for processing the file
+                    return './tools/msxsl.exe ' + file + ' schema.xsl -o ' + dest + fileName;
+                },
+                // Output only errors
+                quiet: true
             },
-            files: ['./path/file'],
+            // Standart files declaration
+            files: [{
+                expand: false,
+                src: ['templates/*.*'],
+                dest: 'build/'
+            }],
         },
@@ -50,4 +69,4 @@ },
 ##### Parameters:
-* **file**: Path to the file that processing now
-* **dest**: Destination for the file
+* **filepath**: Path to the file that processing now
+* **dest**: Destination for the file (Depends on "expand" parameter in your files declaration, see below)
 
@@ -58,31 +77,10 @@ #### files
 
-
-### Usage Examples
-
-#### XSLT templates compilation
-
-```js
-grunt.initConfig({
-    command_run: {
-        your_target: {
-            options: {
-                getCommand: function(file, dest) {
-                    var fileName = file.split("/").pop();
-                    return './tools/msxsl.exe ' + file + ' schema.xsl -o ' + dest + fileName;
-                }
-            },
-            files: [{
-                expand: false,
-                src: ['templates/*.*'],
-                dest: 'build/'
-            }],
-        },
-    },
-});
-```
-
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
 
+If you see any textual errors, please feel free to correct.
+
 ## Release History
-_(Nothing yet)_
+
+* **0.1.1** Quiet mode
+* **0.1.0** First version

tasks/command_run.js

@@ -15,7 +15,10 @@ /*
 
-		grunt.log.writeln('Processing started...');
 		var exec = require('child_process').exec;
 		var done = this.async();
-		var getCommand = this.options().getCommand;
+		var options = this.options();
 
+		if (!options.quiet) {
+			grunt.log.writeln('Processing started...');			
+		}
+
 		var fileGroupsCount = this.files.length;
@@ -36,5 +39,5 @@ var processedGroupsCount = 0;
 			files.forEach(function(filepath) {
-				exec(getCommand(filepath, fileGroup.dest),
+				exec(options.getCommand(filepath, fileGroup.dest),
 					function(error, stdout, stderr) {
-						if (stdout && (stdout.length > 0)) {
+						if (stdout && (stdout.length > 0) && !options.quiet) {
 							grunt.log.writeln('stdout: ' + stdout);
@@ -41,0 +44,0 @@ }

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

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

Lines of code

160

increased by1.91%

Worsened metrics

Total package byte prevSize

10153

decreased by-56.83%

Number of package files

10

decreased by-16.67%

Number of lines in readme file

83

decreased by-3.49%

No dependency changes